From f20cd22dc397885ba18edef151401a6a055e1b27 Mon Sep 17 00:00:00 2001 From: Jeremias Menichelli Date: Wed, 3 Jun 2026 10:46:02 +0200 Subject: [PATCH] docs: improve SDK automation build step on docs (#46163) # Second try of making a new better process for SDK automation Instead of building a new pipeline. We will take the lessons learned form round 1, plus the good design and improvement on DX quality for drop-in file as a single step required from SDK team and produce almost identical set of files as used right now to render using the current pipeline. ## Summary by CodeRabbit * **New Features** * New reference-content pipeline producing per-library reference artifacts and integrating into prebuilds, search ingestion, and rendering (type-aware examples). * **Documentation** * Added comprehensive JavaScript SDK v2 reference content and partials (Auth MFA, passkeys, admin, TypeScript support, filters, modifiers, Installing, Initializing, Buckets, etc.). * **Tests & CI** * Added regression snapshot test and updated workflows to refresh reference snapshots and ensure spec downloads. * **Chores** * Updated ignore rules, build scripts, Makefile targets, and package lifecycle hooks. --------- Co-authored-by: Katerina Skroumpelou Co-authored-by: Katerina Skroumpelou --- .github/workflows/docs-js-libs-update.yml | 6 +- .github/workflows/docs-tests.yml | 8 + apps/docs/.gitignore | 9 + apps/docs/app/api/crawlers/route.ts | 38 +- apps/docs/content/navigation.references.ts | 4 +- apps/docs/docs/ref/javascript/auth-mfa.mdx | 12 + .../docs/ref/javascript/passkey-admin.mdx | 6 + .../docs/features/docs/Reference.constants.ts | 19 + .../docs/Reference.generated.script.ts | 30 +- .../docs/Reference.generated.singleton.ts | 105 +- .../docs/Reference.navigation.client.tsx | 1 - .../docs/features/docs/Reference.sections.tsx | 2 +- .../features/docs/Reference.typeSpec.test.ts | 21 - apps/docs/features/docs/Reference.typeSpec.ts | 276 +- apps/docs/features/docs/Reference.utils.ts | 13 +- .../Reference.typeSpec.test.ts.snap | 114409 ------- apps/docs/package.json | 6 +- .../build-reference-content.test.ts.snap | 27316 ++ .../scripts/build-reference-content.test.ts | 22 + apps/docs/scripts/build-reference-content.ts | 696 + apps/docs/scripts/find-undocumented.ts | 259 - apps/docs/scripts/search/sources/index.ts | 25 +- .../scripts/search/sources/reference-doc.ts | 72 + apps/docs/scripts/validate-references.ts | 103 - apps/docs/scripts/validate-typespec-refs.ts | 87 - apps/docs/spec/Makefile | 66 +- .../spec/enrichments/tsdoc_v2/combined.json | 260672 --------------- .../enrichments/tsdoc_v2/combined_raw.json | 45929 --- .../spec/enrichments/tsdoc_v2/functions.json | 3825 - .../tsdoc_v2/functions_dereferenced.json | 3825 - .../spec/enrichments/tsdoc_v2/gotrue.json | 52557 --- .../tsdoc_v2/gotrue_dereferenced.json | 52557 --- .../spec/enrichments/tsdoc_v2/postgrest.json | 39675 --- .../tsdoc_v2/postgrest_dereferenced.json | 39675 --- .../spec/enrichments/tsdoc_v2/realtime.json | 17533 - .../tsdoc_v2/realtime_dereferenced.json | 17533 - .../spec/enrichments/tsdoc_v2/storage.json | 35693 -- .../tsdoc_v2/storage_dereferenced.json | 35693 -- .../spec/enrichments/tsdoc_v2/supabase.json | 111365 ------ .../tsdoc_v2/supabase_dereferenced.json | 111365 ------ apps/docs/spec/reference/README.md | 429 + .../spec/reference/javascript/v2/config.json | 11 + .../v2/partials/analytics-buckets.json | 5 + .../javascript/v2/partials/auth-admin.json | 13 + .../javascript/v2/partials/auth-mfa.json | 5 + .../javascript/v2/partials/auth-passkey.json | 6 + .../javascript/v2/partials/auth.json | 19 + .../javascript/v2/partials/file-buckets.json | 5 + .../javascript/v2/partials/initializing.mdx | 4 + .../javascript/v2/partials/installing.mdx | 119 + .../javascript/v2/partials/introduction.mdx | 8 + .../javascript/v2/partials/oauth-admin.json | 5 + .../javascript/v2/partials/oauth-server.json | 5 + .../javascript/v2/partials/passkey-admin.json | 5 + .../v2/partials/typescript-support.mdx | 235 + .../javascript/v2/partials/using-filters.json | 44 + .../v2/partials/using-modifiers.json | 5 + .../v2/partials/vector-buckets.json | 5 + 58 files changed, 29246 insertions(+), 943190 deletions(-) create mode 100644 apps/docs/docs/ref/javascript/auth-mfa.mdx create mode 100644 apps/docs/docs/ref/javascript/passkey-admin.mdx create mode 100644 apps/docs/features/docs/Reference.constants.ts delete mode 100644 apps/docs/features/docs/Reference.typeSpec.test.ts delete mode 100644 apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap create mode 100644 apps/docs/scripts/__snapshots__/build-reference-content.test.ts.snap create mode 100644 apps/docs/scripts/build-reference-content.test.ts create mode 100644 apps/docs/scripts/build-reference-content.ts delete mode 100644 apps/docs/scripts/find-undocumented.ts delete mode 100644 apps/docs/scripts/validate-references.ts delete mode 100644 apps/docs/scripts/validate-typespec-refs.ts delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/combined.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/combined_raw.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/functions.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/gotrue.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/postgrest.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/realtime.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/storage.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/supabase.json delete mode 100644 apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json create mode 100644 apps/docs/spec/reference/README.md create mode 100644 apps/docs/spec/reference/javascript/v2/config.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/analytics-buckets.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/auth-admin.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/auth-mfa.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/auth-passkey.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/auth.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/file-buckets.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/initializing.mdx create mode 100644 apps/docs/spec/reference/javascript/v2/partials/installing.mdx create mode 100644 apps/docs/spec/reference/javascript/v2/partials/introduction.mdx create mode 100644 apps/docs/spec/reference/javascript/v2/partials/oauth-admin.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/oauth-server.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/passkey-admin.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/typescript-support.mdx create mode 100644 apps/docs/spec/reference/javascript/v2/partials/using-filters.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/using-modifiers.json create mode 100644 apps/docs/spec/reference/javascript/v2/partials/vector-buckets.json diff --git a/.github/workflows/docs-js-libs-update.yml b/.github/workflows/docs-js-libs-update.yml index d39b7c73d3c..dc025041509 100644 --- a/.github/workflows/docs-js-libs-update.yml +++ b/.github/workflows/docs-js-libs-update.yml @@ -52,11 +52,9 @@ jobs: echo "Version: ${VERSION}" make - - name: Generate new typespec snapshot + - name: Refresh reference-content snapshot working-directory: apps/docs - run: | - echo "Generating new typespec snapshot for review..." - npx vitest run --update --dir features/docs + run: npx vitest run --update scripts/build-reference-content.test.ts - name: Generate token id: app-token diff --git a/.github/workflows/docs-tests.yml b/.github/workflows/docs-tests.yml index 2a8de4e5204..4dbf1f24b44 100644 --- a/.github/workflows/docs-tests.yml +++ b/.github/workflows/docs-tests.yml @@ -47,6 +47,14 @@ jobs: - name: Install deps run: pnpm install --frozen-lockfile + - name: Download JS reference TypeDoc dumps + # The source dumps under apps/docs/spec/reference///*.json are + # gitignored — `make download.tsdoc.v2` re-fetches them from + # supabase.github.io so the reference-content snapshot test has + # something to walk. + working-directory: apps/docs/spec + run: make download.tsdoc.v2 + - name: Run tests run: | touch .env diff --git a/apps/docs/.gitignore b/apps/docs/.gitignore index ad0db20e8fc..af74dd45e2a 100644 --- a/apps/docs/.gitignore +++ b/apps/docs/.gitignore @@ -36,5 +36,14 @@ public/docs.tar.gz # Copied examples folder /examples/ +# Generated reference content (built by scripts/build-reference-content.ts) +/content/reference/ + +# Downloaded TypeDoc dumps under spec/reference///. Regenerated by +# `cd apps/docs/spec && make download.tsdoc.v2`. Hand-authored files in the +# same folders (config.json, partials/) stay tracked. +/spec/reference/*/*/*.json +!/spec/reference/*/*/config.json + # Sentry Config File .env.sentry-build-plugin diff --git a/apps/docs/app/api/crawlers/route.ts b/apps/docs/app/api/crawlers/route.ts index 05654511dc1..568ee6588b0 100644 --- a/apps/docs/app/api/crawlers/route.ts +++ b/apps/docs/app/api/crawlers/route.ts @@ -1,11 +1,3 @@ -import { toHtml } from 'hast-util-to-html' -import { fromMarkdown } from 'mdast-util-from-markdown' -import { mdxFromMarkdown } from 'mdast-util-mdx' -import { toHast } from 'mdast-util-to-hast' -import { mdxjs } from 'micromark-extension-mdxjs' -import { notFound } from 'next/navigation' -import { visit } from 'unist-util-visit' - import { REFERENCES } from '~/content/navigation.references' import { getFlattenedSections, @@ -16,6 +8,13 @@ import { getRefMarkdown } from '~/features/docs/Reference.mdx' import type { MethodTypes, VariableTypes } from '~/features/docs/Reference.typeSpec' import type { AbbrevApiReferenceSection } from '~/features/docs/Reference.utils' import { BASE_PATH } from '~/lib/constants' +import { toHtml } from 'hast-util-to-html' +import { fromMarkdown } from 'mdast-util-from-markdown' +import { mdxFromMarkdown } from 'mdast-util-mdx' +import { toHast } from 'mdast-util-to-hast' +import { mdxjs } from 'micromark-extension-mdxjs' +import { notFound } from 'next/navigation' +import { visit } from 'unist-util-visit' export async function GET(request: Request) { const url = new URL(request.url) @@ -138,7 +137,7 @@ async function functionDetails( let types: MethodTypes | VariableTypes | undefined if (libraryMeta.typeSpec && '$ref' in fn) { - types = await getTypeSpec(fn['$ref'] as string) + types = await getTypeSpec(lib, version ?? libraryMeta.versions[0], fn['$ref'] as string) } const fullDescription = [ @@ -151,7 +150,7 @@ async function functionDetails( .join('') const parameters = parametersToHtml(fn, types) - const examples = examplesToHtml(fn) + const examples = examplesToHtml(fn, types) return fullDescription + parameters + examples } @@ -219,13 +218,24 @@ function parametersToHtml(fn: any, types: MethodTypes | VariableTypes | undefine return result } -function examplesToHtml(fn: any) { - if (!fn.examples || fn.examples.length === 0) return '' +function examplesToHtml(fn: any, types?: MethodTypes | VariableTypes) { + // Prefer hand-authored YAML/JSON examples on the section entry; fall back to + // TSDoc-extracted `@example` blocks on the method's normalised comment. The + // page renderer in `Reference.sections.tsx` does the same merge, so the + // crawler stays consistent with what a browser sees. + const examples = + Array.isArray(fn.examples) && fn.examples.length > 0 + ? fn.examples + : (types?.comment?.examples ?? []) + if (examples.length === 0) return '' let result = '

Examples

' - result += fn.examples - .map((example) => `

${example.name ?? ''}

` + mdxToHtml(example.code ?? '')) + result += examples + .map( + (example: { name?: string; code?: string }) => + `

${example.name ?? ''}

` + mdxToHtml(example.code ?? '') + ) .join('') return result diff --git a/apps/docs/content/navigation.references.ts b/apps/docs/content/navigation.references.ts index fb619cb0539..dc4f4c137a0 100644 --- a/apps/docs/content/navigation.references.ts +++ b/apps/docs/content/navigation.references.ts @@ -19,8 +19,10 @@ export const REFERENCES = { icon: 'reference-javascript', meta: { v2: { + // JS v2 is driven by the new reference pipeline + // (`scripts/build-reference-content.ts` + `spec/reference/javascript/v2/`). + // It intentionally has no `specFile` — the legacy YAML loader skips it. libId: 'reference_javascript_v2', - specFile: 'supabase_js_v2', }, v1: { libId: 'reference_javascript_v1', diff --git a/apps/docs/docs/ref/javascript/auth-mfa.mdx b/apps/docs/docs/ref/javascript/auth-mfa.mdx new file mode 100644 index 00000000000..231384f689b --- /dev/null +++ b/apps/docs/docs/ref/javascript/auth-mfa.mdx @@ -0,0 +1,12 @@ +--- +id: 'auth-mfa' +title: Auth MFA +--- + +This section contains methods commonly used for Multi-Factor Authentication (MFA) and are invoked behind the `supabase.auth.mfa` namespace. + +Currently, there is support for time-based one-time password (TOTP) and phone verification code as the 2nd factor. Recovery codes are not supported but users can enroll multiple factors, with an upper limit of 10. + +Having a 2nd factor for recovery frees the user of the burden of having to store their recovery codes somewhere. It also reduces the attack surface since multiple recovery codes are usually generated compared to just having 1 backup factor. + +Learn more about implementing MFA in your application [in the MFA guide](https://supabase.com/docs/guides/auth/auth-mfa#overview). diff --git a/apps/docs/docs/ref/javascript/passkey-admin.mdx b/apps/docs/docs/ref/javascript/passkey-admin.mdx new file mode 100644 index 00000000000..d20589e2d83 --- /dev/null +++ b/apps/docs/docs/ref/javascript/passkey-admin.mdx @@ -0,0 +1,6 @@ +--- +id: passkey-admin +title: Passkey admin +--- + +Contains passkey administration methods. Requires a secret key. diff --git a/apps/docs/features/docs/Reference.constants.ts b/apps/docs/features/docs/Reference.constants.ts new file mode 100644 index 00000000000..f9133fa6cab --- /dev/null +++ b/apps/docs/features/docs/Reference.constants.ts @@ -0,0 +1,19 @@ +/** + * Standalone constants for the reference pipeline. + * + * This file intentionally has no runtime dependencies — and in particular, + * it must NOT import anything that transitively pulls in `next/navigation`, + * `next/headers`, or any other client-only module. It is loaded by both UI + * code (e.g. `Reference.generated.singleton.ts` used in app routes) and + * server-only scripts run with `tsx --conditions=react-server` + * (e.g. `scripts/llms.ts`), where the server React build lacks + * `createContext` and Next.js client modules crash on import. + */ + +/** + * SDK/version pairs (`${sdkId}-${version}`) that opt into the new reference + * content pipeline produced by `scripts/build-reference-content.ts`. Anything + * not listed here keeps reading from the legacy `features/docs/generated/` + * outputs. + */ +export const SUPPORTS_NEW_REFERENCE_PROCESS = new Set(['javascript-v2']) diff --git a/apps/docs/features/docs/Reference.generated.script.ts b/apps/docs/features/docs/Reference.generated.script.ts index aaa4ed533de..d8824206342 100644 --- a/apps/docs/features/docs/Reference.generated.script.ts +++ b/apps/docs/features/docs/Reference.generated.script.ts @@ -1,12 +1,8 @@ -import { isPlainObject, keyBy } from 'lodash-es' import { mkdir, readFile, writeFile } from 'node:fs/promises' import { dirname, join } from 'node:path' import { fileURLToPath } from 'node:url' -import slugify from 'slugify' -import { parse } from 'yaml' - import { clientSdkIds, REFERENCES } from '~/content/navigation.references' -import { parseTypeSpec } from '~/features/docs/Reference.typeSpec' +import { SUPPORTS_NEW_REFERENCE_PROCESS } from '~/features/docs/Reference.constants' import type { AbbrevApiReferenceSection } from '~/features/docs/Reference.utils' import { deepFilterRec } from '~/features/helpers.fn' import type { Json } from '~/features/helpers.types' @@ -22,6 +18,10 @@ import selfHostingStorageCommonSections from '~/spec/common-self-hosting-storage import storageSpec from '~/spec/storage_v0_openapi.json' with { type: 'json' } import analyticsSpec from '~/spec/transforms/analytics_v0_openapi_deparsed.json' with { type: 'json' } import openApiSpec from '~/spec/transforms/api_v1_openapi_deparsed.json' with { type: 'json' } +import { isPlainObject, keyBy } from 'lodash-es' +import slugify from 'slugify' +import { parse } from 'yaml' + import { IApiEndPoint } from './Reference.api.utils' const DOCS_DIRECTORY = join(dirname(fileURLToPath(import.meta.url)), '../..') @@ -155,21 +155,6 @@ export function flattenCommonClientLibSections(tree: Array) } -async function writeTypes() { - const types = await parseTypeSpec() - - await writeFile( - join(GENERATED_DIRECTORY, 'typeSpec.json'), - JSON.stringify(types, (key, value) => { - if (key === 'methods' || key === 'variables') { - return Object.fromEntries(value.entries()) - } else { - return value - } - }) - ) -} - async function writeSdkReferenceSections() { return Promise.all( clientSdkIds @@ -180,6 +165,10 @@ async function writeSdkReferenceSections() { version, })) }) + // Libs that opted into the new pipeline emit their own outputs via + // `scripts/build-reference-content.ts`. Skip them here so the legacy + // script doesn't need a YAML spec file for them at all. + .filter(({ sdkId, version }) => !SUPPORTS_NEW_REFERENCE_PROCESS.has(`${sdkId}-${version}`)) .flatMap(async ({ sdkId, version }) => { const spec = await getSpec(REFERENCES[sdkId].meta[version].specFile) @@ -347,7 +336,6 @@ async function run() { await mkdir(GENERATED_DIRECTORY, { recursive: true }) await Promise.all([ - writeTypes(), writeSdkReferenceSections(), writeCliReferenceSections(), writeApiReferenceSections(), diff --git a/apps/docs/features/docs/Reference.generated.singleton.ts b/apps/docs/features/docs/Reference.generated.singleton.ts index cddff2dd457..84bea53a700 100644 --- a/apps/docs/features/docs/Reference.generated.singleton.ts +++ b/apps/docs/features/docs/Reference.generated.singleton.ts @@ -1,46 +1,73 @@ import { readFile } from 'node:fs/promises' import { join } from 'node:path' +import { SUPPORTS_NEW_REFERENCE_PROCESS } from '~/features/docs/Reference.constants' +import type { MethodTypes, VariableTypes } from '~/features/docs/Reference.typeSpec' +import type { AbbrevApiReferenceSection } from '~/features/docs/Reference.utils' import { parse } from 'yaml' -import type { ModuleTypes } from '~/features/docs/Reference.typeSpec' -import type { AbbrevApiReferenceSection } from '~/features/docs/Reference.utils' import { type Json } from '../helpers.types' import { type IApiEndPoint } from './Reference.api.utils' -let typeSpec: Array - -async function _typeSpecSingleton() { - if (!typeSpec) { - const rawJson = await readFile( - join(process.cwd(), 'features/docs', './generated/typeSpec.json'), - 'utf-8' - ) - typeSpec = JSON.parse(rawJson, (key, value) => { - if (key === 'methods' || key === 'variables') { - return new Map(Object.entries(value)) - } else { - return value - } - }) +/** + * Resolves the on-disk path for a generated SDK reference file. For libraries + * listed in `SUPPORTS_NEW_REFERENCE_PROCESS` we read from the new + * `content/reference///.json` layout produced by + * `scripts/build-reference-content.ts`; otherwise fall back to the legacy + * `features/docs/generated/...json` files (still used by + * SDKs whose content hasn't migrated to the new pipeline). + */ +function generatedReferencePath(sdkId: string, version: string, name: string): string { + if (SUPPORTS_NEW_REFERENCE_PROCESS.has(`${sdkId}-${version}`)) { + return join(process.cwd(), 'content/reference', sdkId, version, `${name}.json`) } - - return typeSpec + return join(process.cwd(), 'features/docs/generated', `${sdkId}.${version}.${name}.json`) } function normalizeRefPath(path: string) { return path.replace(/\.index(?=\.|$)/g, '').replace(/\.+/g, '.') } -export async function getTypeSpec(ref: string) { - const modules = await _typeSpecSingleton() +/** + * Per-lib typeSpec cache. Each entry is the parsed + * `content/reference///typeSpec.json` — a `{ methods, variables }` + * object keyed by normalised `$ref`. `typeSpec: true` in + * `content/navigation.references.ts` is set at the library level, so it + * applies to every version of that library — but only versions in + * `SUPPORTS_NEW_REFERENCE_PROCESS` actually have a typeSpec file. For + * versions without one (legacy versions like javascript-v1), we return an + * empty spec so the renderer simply omits signature/comment data instead of + * crashing the build. + */ +type TypeSpecFile = { + methods: Record + variables: Record +} +const EMPTY_TYPESPEC: TypeSpecFile = { methods: {}, variables: {} } +const typeSpecCache = new Map() +async function loadTypeSpec(sdkId: string, version: string): Promise { + const key = `${sdkId}.${version}` + const cached = typeSpecCache.get(key) + if (cached) return cached + + try { + const rawJson = await readFile(generatedReferencePath(sdkId, version, 'typeSpec'), 'utf-8') + const parsed = JSON.parse(rawJson) as TypeSpecFile + typeSpecCache.set(key, parsed) + return parsed + } catch (err) { + if ((err as NodeJS.ErrnoException).code === 'ENOENT') { + typeSpecCache.set(key, EMPTY_TYPESPEC) + return EMPTY_TYPESPEC + } + throw err + } +} + +export async function getTypeSpec(sdkId: string, version: string, ref: string) { + const spec = await loadTypeSpec(sdkId, version) const normalizedRef = normalizeRefPath(ref) - const delimiter = normalizedRef.indexOf('.') - const refMod = normalizedRef.substring(0, delimiter) - - const mod = modules.find((mod) => mod.name === refMod) - // Check methods first, then variables - return mod?.methods.get(normalizedRef) ?? mod?.variables.get(normalizedRef) + return spec.methods[normalizedRef] ?? spec.variables[normalizedRef] } let cliSpec: Json @@ -87,11 +114,7 @@ const functionsList = new Map>() export async function getFunctionsList(sdkId: string, version: string) { const key = `${sdkId}.${version}` if (!functionsList.has(key)) { - const data = await readFile( - join(process.cwd(), 'features/docs', `./generated/${sdkId}.${version}.functions.json`), - 'utf-8' - ) - + const data = await readFile(generatedReferencePath(sdkId, version, 'functions'), 'utf-8') functionsList.set(key, JSON.parse(data)) } @@ -103,11 +126,7 @@ const referenceSections = new Map>() export async function getReferenceSections(sdkId: string, version: string) { const key = `${sdkId}.${version}` if (!referenceSections.has(key)) { - const data = await readFile( - join(process.cwd(), 'features/docs', `./generated/${sdkId}.${version}.sections.json`), - 'utf-8' - ) - + const data = await readFile(generatedReferencePath(sdkId, version, 'sections'), 'utf-8') referenceSections.set(key, JSON.parse(data)) } @@ -120,11 +139,7 @@ const flatSections = new Map>() export async function getFlattenedSections(sdkId: string, version: string) { const key = `${sdkId}.${version}` if (!flatSections.has(key)) { - const data = await readFile( - join(process.cwd(), 'features/docs', `./generated/${sdkId}.${version}.flat.json`), - 'utf-8' - ) - + const data = await readFile(generatedReferencePath(sdkId, version, 'flat'), 'utf-8') flatSections.set(key, JSON.parse(data)) } @@ -137,12 +152,8 @@ const sectionsBySlug = new Map>() export async function getSectionsBySlug(sdkId: string, version: string) { const key = `${sdkId}.${version}` if (!sectionsBySlug.has(key)) { - const data = await readFile( - join(process.cwd(), 'features/docs', `./generated/${sdkId}.${version}.bySlug.json`), - 'utf-8' - ) + const data = await readFile(generatedReferencePath(sdkId, version, 'bySlug'), 'utf-8') const asObject = JSON.parse(data) - sectionsBySlug.set(key, new Map(Object.entries(asObject))) } diff --git a/apps/docs/features/docs/Reference.navigation.client.tsx b/apps/docs/features/docs/Reference.navigation.client.tsx index 75e2ea65fb2..e6308f3fcd6 100644 --- a/apps/docs/features/docs/Reference.navigation.client.tsx +++ b/apps/docs/features/docs/Reference.navigation.client.tsx @@ -353,7 +353,6 @@ function CompoundRefLink({ className={cn('border-l border-control pl-3 ml-1 data-open:mt-2 grid gap-2.5')} >
    - {(section.items || []).map((item, idx) => { return (
  • diff --git a/apps/docs/features/docs/Reference.sections.tsx b/apps/docs/features/docs/Reference.sections.tsx index e6896cb94e5..0a98ec56b68 100644 --- a/apps/docs/features/docs/Reference.sections.tsx +++ b/apps/docs/features/docs/Reference.sections.tsx @@ -472,7 +472,7 @@ async function FunctionSection({ let types: MethodTypes | VariableTypes | undefined if (useTypeSpec && '$ref' in fn) { - types = await getTypeSpec(fn['$ref'] as string) + types = await getTypeSpec(sdkId, version, fn['$ref'] as string) } const fullDescription = [ diff --git a/apps/docs/features/docs/Reference.typeSpec.test.ts b/apps/docs/features/docs/Reference.typeSpec.test.ts deleted file mode 100644 index 1e5075030c4..00000000000 --- a/apps/docs/features/docs/Reference.typeSpec.test.ts +++ /dev/null @@ -1,21 +0,0 @@ -import { describe, expect, it } from 'vitest' - -import { parseTypeSpec } from './Reference.typeSpec' - -describe('TS type spec parsing', () => { - it('matches snapshot', async () => { - const parsed = await parseTypeSpec() - const json = JSON.stringify( - parsed, - (key, value) => { - if (key === 'methods') { - return Object.fromEntries(value.entries()) - } else { - return value - } - }, - 2 - ) - expect(json).toMatchSnapshot() - }) -}) diff --git a/apps/docs/features/docs/Reference.typeSpec.ts b/apps/docs/features/docs/Reference.typeSpec.ts index 6455a17582f..9bd84b6f56e 100644 --- a/apps/docs/features/docs/Reference.typeSpec.ts +++ b/apps/docs/features/docs/Reference.typeSpec.ts @@ -1,20 +1,21 @@ /** - * Types and additional comments for the JavaScript library are found in the - * auto-generated TS typespec. + * Type definitions and TypeDoc normalisation helpers shared between the build + * script (`scripts/build-reference-content.ts`) and the renderer + * (`Reference.sections.tsx`, `Reference.ui.tsx`). * - * The format of this typespec is difficult to walk, so we re-shape it for easy - * access to a function's type definition, given its name and module. + * The build script walks each per-package TypeDoc dump and calls + * `parseSignature` / `parseType` / `normalizeComment` to produce the + * `MethodTypes` / `VariableTypes` entries the renderer consumes. This module + * is I/O-free so it can be imported from any environment (Node scripts, RSC, + * tests). */ -import _typeSpec from '~/spec/enrichments/tsdoc_v2/combined.json' with { type: 'json' } - // [Charis] 2024-07-10 // Types are more trouble than they're worth here: manually defining the types // (correctly) is tedious, and inferring them will throw up a lot of type // errors. As long as everything is typed on the way out, and we code // defensively, it should be fine. Keep any unsafe type shenanigans isolated // to this file. -const typeSpec = _typeSpec as any export const TYPESPEC_NODE_ANONYMOUS = Symbol('anonymous') @@ -54,7 +55,7 @@ export interface VariableTypes { isConst?: boolean } -interface Comment { +export interface Comment { shortText?: string text?: string tags?: Array<{ tag: string; text: string }> @@ -177,14 +178,14 @@ export interface CustomTypePropertyType { // 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_MODULE = 2 -const KIND_VARIABLE = 32 -const KIND_CLASS = 128 -const KIND_INTERFACE = 256 -const KIND_CONSTRUCTOR = 512 -const KIND_PROPERTY = 1024 -const KIND_METHOD = 2048 -const KIND_TYPE_LITERAL = 65536 +export const KIND_MODULE = 2 +export const KIND_VARIABLE = 32 +export const KIND_CLASS = 128 +export const KIND_INTERFACE = 256 +export const KIND_CONSTRUCTOR = 512 +export const KIND_PROPERTY = 1024 +export const KIND_METHOD = 2048 +export const KIND_TYPE_LITERAL = 65536 /** * @@ -231,7 +232,9 @@ interface CommentBlockTag { content: CommentKind[] } -function normalizeComment(original: TypedocComment | Comment | undefined): Comment | undefined { +export function normalizeComment( + original: TypedocComment | Comment | undefined +): Comment | undefined { if (!original) return if ('shortText' in original || 'text' in original) { @@ -345,41 +348,11 @@ function normalizeComment(original: TypedocComment | Comment | undefined): Comme return comment } -export function parseTypeSpec() { - const modules = (typeSpec.children ?? []).map(parseMod) - return modules as Array -} - -function normalizeRefPath(path: string) { +export function normalizeRefPath(path: string) { return path.replace(/\.index(?=\.|$)/g, '').replace(/\.+/g, '.') } -function buildRefPath(segments: Array) { - return normalizeRefPath(segments.filter(Boolean).join('.')) -} - -// Reading the type spec happens in several layers. The first layer is the -// module: this corresponds roughly to the JS libraries for each product: -// database, auth, storage, etc. - -function parseMod(mod: (typeof typeSpec)['children'][number]) { - const res: ModuleTypes = { - name: mod.name, - methods: new Map(), - variables: new Map(), - } - - // Build a map of nodes by their IDs for easy cross-referencing. - const targetMap = new Map() - buildMap(mod, targetMap) - const processingRefs = new Set() - - parseModInternal(mod, targetMap, [], res, processingRefs) - - return res -} - -function buildMap(node: any, map: Map) { +export function buildMap(node: any, map: Map) { if ('id' in node) { map.set(node.id, node) } @@ -388,127 +361,12 @@ function buildMap(node: any, map: Map) { } } -// This layer is the top level of a module. Paths are tracked in this layer, -// because they are needed to construct the $ref that will be used to reference -// a specific type definition. - -function parseModInternal( - node: any, - map: Map, - currentPath: Array, - res: ModuleTypes, - processingRefs: Set -) { - let updatedPath: Array - - switch ((node.kindString ?? node.variant)?.toLowerCase()) { - case 'module': - updatedPath = [...currentPath, node.name] - node.children?.forEach((child: any) => - parseModInternal(child, map, updatedPath, res, processingRefs) - ) - return - // 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, processingRefs) - ) - return - case 'class': - updatedPath = [...currentPath, node.name] - node.children?.forEach((child: any) => - parseModInternal(child, map, updatedPath, res, processingRefs) - ) - return - 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, processingRefs) - ) - return - case 'declaration': - if (node.kind === KIND_CLASS || node.kind === KIND_MODULE) { - updatedPath = [...currentPath, node.name] - node.children?.forEach((child: any) => - parseModInternal(child, map, updatedPath, res, processingRefs) - ) - } else if (node.kind === KIND_INTERFACE) { - updatedPath = [...currentPath, node.name] - node.children?.forEach((child: any) => - parseModInternal(child, map, updatedPath, res, processingRefs) - ) - } else if (node.kind === KIND_CONSTRUCTOR) { - parseConstructor(node, map, currentPath, res) - } else if (node.kind === KIND_METHOD) { - return parseMethod(node, map, currentPath, res) - } else if (node.kind === KIND_VARIABLE) { - return parseVariable(node, map, currentPath, res) - } else if (node.kind === KIND_PROPERTY) { - parsePropertyReference(node, map, currentPath, res, processingRefs) - } - return - case 'property': - parsePropertyReference(node, map, currentPath, res, processingRefs) - return - case 'reference': - default: - return - } -} - -function parsePropertyReference( - node: any, - map: Map, - currentPath: Array, - res: ModuleTypes, - processingRefs: Set -) { - const refType = node.type - if (refType?.type !== 'reference') { - return - } - - const referent = map.get(refType.target ?? refType.id) - if (!referent) { - return - } - - if (processingRefs.has(referent.id)) { - return - } - - const isForwardedNamespace = - referent?.variant === 'declaration' && - (referent.kind === KIND_INTERFACE || - referent.kind === KIND_CLASS || - referent.kind === KIND_MODULE) - - if (!isForwardedNamespace) { - return - } - - const parentPath = - currentPath.length > 0 && currentPath[currentPath.length - 1]?.startsWith('@supabase/') - ? currentPath - : currentPath.slice(0, -1) - - processingRefs.add(referent.id) - parseModInternal(referent, map, parentPath, res, processingRefs) - processingRefs.delete(referent.id) -} - /** * Get the name for a node, which may be delegated or missing (placeholders * are prefaced by two `__` in the type spec). If missing, use the anonymous * symbol. */ -function nameOrAnonymous(nodes: any) { +export function nameOrAnonymous(nodes: any) { if (!Array.isArray(nodes)) { nodes = [nodes] } @@ -522,91 +380,7 @@ function nameOrAnonymous(nodes: any) { return TYPESPEC_NODE_ANONYMOUS } -function parseConstructor( - node: any, - map: Map, - currentPath: Array, - res: ModuleTypes -) { - const $ref = buildRefPath([...currentPath, 'constructor']) - - const signature = node.signatures[0] - if (!signature) return - - const { params, ret, comment } = parseSignature(signature, map) - - const types: MethodTypes = { - name: $ref, - params, - ret, - comment, - } - - res.methods.set($ref, types) -} - -function parseMethod( - node: any, - map: Map, - currentPath: Array, - res: ModuleTypes -) { - const $ref = buildRefPath([...currentPath, node.name]) - - const signature = node.signatures[0] - if (!signature) return - - let { params, ret, comment } = parseSignature(signature, map) - - // When a method has multiple overload signatures, TypeDoc places the shared - // JSDoc on the method node rather than any individual signature. Always merge - // node.comment as the base so that block tags (@remarks, @example, etc.) are - // not lost when overload signatures already carry a minimal summary comment. - if (node.comment) { - const nodeComment = normalizeComment(node.comment) - if (nodeComment) { - comment = { ...nodeComment, ...comment } - } - } - - const types: MethodTypes = { - name: $ref, - params, - ret, - comment, - } - - if (node.signatures.length > 1) { - types.altSignatures = node.signatures - .slice(1) - .map((signature) => parseSignature(signature, map)) - } - - res.methods.set($ref, types) -} - -function parseVariable( - node: any, - map: Map, - currentPath: Array, - res: ModuleTypes -) { - const $ref = buildRefPath([...currentPath, node.name]) - - const type = parseType(node.type, map) - const comment = node.comment ? normalizeComment(node.comment) : undefined - - const types: VariableTypes = { - name: $ref, - type, - comment, - isConst: node.flags?.isConst ?? false, - } - - res.variables.set($ref, types) -} - -function parseSignature( +export function parseSignature( signature: any, map: Map ): { @@ -662,7 +436,7 @@ function parseSignature( // // with additional properties depending on the type. -function parseType(type: any, map: Map, typeArguments?: any, debug = false) { +export function parseType(type: any, map: Map, typeArguments?: any, debug = false) { switch (type.type) { case 'literal': return type diff --git a/apps/docs/features/docs/Reference.utils.ts b/apps/docs/features/docs/Reference.utils.ts index ae3633e5aca..5824f27901a 100644 --- a/apps/docs/features/docs/Reference.utils.ts +++ b/apps/docs/features/docs/Reference.utils.ts @@ -1,3 +1,8 @@ +import { clientSdkIds, REFERENCES, selfHostingServices } from '~/content/navigation.references' +import { getFlattenedSections } from '~/features/docs/Reference.generated.singleton' +import { generateOpenGraphImageMeta } from '~/features/seo/openGraph' +import { BASE_PATH } from '~/lib/constants' +import { getCustomContent } from '~/lib/custom-content/getCustomContent' import { fromMarkdown } from 'mdast-util-from-markdown' import { mdxFromMarkdown, mdxToMarkdown } from 'mdast-util-mdx' import { toMarkdown } from 'mdast-util-to-markdown' @@ -6,12 +11,6 @@ import type { Metadata, ResolvingMetadata } from 'next' import { redirect } from 'next/navigation' import { visit } from 'unist-util-visit' -import { clientSdkIds, REFERENCES, selfHostingServices } from '~/content/navigation.references' -import { getFlattenedSections } from '~/features/docs/Reference.generated.singleton' -import { generateOpenGraphImageMeta } from '~/features/seo/openGraph' -import { BASE_PATH } from '~/lib/constants' -import { getCustomContent } from '~/lib/custom-content/getCustomContent' - const { metadataTitle } = getCustomContent(['metadata:title']) export interface AbbrevApiReferenceSection { @@ -270,3 +269,5 @@ export function normalizeMarkdown(markdownUnescaped: string): string { return content } + +export { SUPPORTS_NEW_REFERENCE_PROCESS } from '~/features/docs/Reference.constants' diff --git a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap b/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap deleted file mode 100644 index 530844dc619..00000000000 --- a/apps/docs/features/docs/__snapshots__/Reference.typeSpec.test.ts.snap +++ /dev/null @@ -1,114409 +0,0 @@ -// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html - -exports[`TS type spec parsing > matches snapshot 1`] = ` -"[ - { - "name": "@supabase/supabase-js", - "methods": { - "@supabase/supabase-js.AuthApiError.constructor": { - "name": "@supabase/supabase-js.AuthApiError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthApiError" - } - } - }, - "@supabase/supabase-js.AuthApiError.toJSON": { - "name": "@supabase/supabase-js.AuthApiError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthError.constructor": { - "name": "@supabase/supabase-js.AuthError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - }, - "@supabase/supabase-js.AuthError.toJSON": { - "name": "@supabase/supabase-js.AuthError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthImplicitGrantRedirectError.constructor": { - "name": "@supabase/supabase-js.AuthImplicitGrantRedirectError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "details", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthImplicitGrantRedirectError" - } - } - }, - "@supabase/supabase-js.AuthImplicitGrantRedirectError.toJSON": { - "name": "@supabase/supabase-js.AuthImplicitGrantRedirectError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "details", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthInvalidCredentialsError.constructor": { - "name": "@supabase/supabase-js.AuthInvalidCredentialsError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthInvalidCredentialsError" - } - } - }, - "@supabase/supabase-js.AuthInvalidCredentialsError.toJSON": { - "name": "@supabase/supabase-js.AuthInvalidCredentialsError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthInvalidJwtError.constructor": { - "name": "@supabase/supabase-js.AuthInvalidJwtError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthInvalidJwtError" - } - } - }, - "@supabase/supabase-js.AuthInvalidJwtError.toJSON": { - "name": "@supabase/supabase-js.AuthInvalidJwtError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthInvalidTokenResponseError.constructor": { - "name": "@supabase/supabase-js.AuthInvalidTokenResponseError.constructor", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthInvalidTokenResponseError" - } - } - }, - "@supabase/supabase-js.AuthInvalidTokenResponseError.toJSON": { - "name": "@supabase/supabase-js.AuthInvalidTokenResponseError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthPKCECodeVerifierMissingError.constructor": { - "name": "@supabase/supabase-js.AuthPKCECodeVerifierMissingError.constructor", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthPKCECodeVerifierMissingError" - } - } - }, - "@supabase/supabase-js.AuthPKCECodeVerifierMissingError.toJSON": { - "name": "@supabase/supabase-js.AuthPKCECodeVerifierMissingError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthPKCEGrantCodeExchangeError.constructor": { - "name": "@supabase/supabase-js.AuthPKCEGrantCodeExchangeError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "details", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthPKCEGrantCodeExchangeError" - } - } - }, - "@supabase/supabase-js.AuthPKCEGrantCodeExchangeError.toJSON": { - "name": "@supabase/supabase-js.AuthPKCEGrantCodeExchangeError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "details", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthRefreshDiscardedError.constructor": { - "name": "@supabase/supabase-js.AuthRefreshDiscardedError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthRefreshDiscardedError" - } - } - }, - "@supabase/supabase-js.AuthRefreshDiscardedError.toJSON": { - "name": "@supabase/supabase-js.AuthRefreshDiscardedError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthRetryableFetchError.constructor": { - "name": "@supabase/supabase-js.AuthRetryableFetchError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthRetryableFetchError" - } - } - }, - "@supabase/supabase-js.AuthRetryableFetchError.toJSON": { - "name": "@supabase/supabase-js.AuthRetryableFetchError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthSessionMissingError.constructor": { - "name": "@supabase/supabase-js.AuthSessionMissingError.constructor", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthSessionMissingError" - } - } - }, - "@supabase/supabase-js.AuthSessionMissingError.toJSON": { - "name": "@supabase/supabase-js.AuthSessionMissingError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthUnknownError.constructor": { - "name": "@supabase/supabase-js.AuthUnknownError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "originalError", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthUnknownError" - } - } - }, - "@supabase/supabase-js.AuthUnknownError.toJSON": { - "name": "@supabase/supabase-js.AuthUnknownError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.AuthWeakPasswordError.constructor": { - "name": "@supabase/supabase-js.AuthWeakPasswordError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "reasons", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthWeakPasswordError" - } - } - }, - "@supabase/supabase-js.AuthWeakPasswordError.toJSON": { - "name": "@supabase/supabase-js.AuthWeakPasswordError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "reasons", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.CustomAuthError.constructor": { - "name": "@supabase/supabase-js.CustomAuthError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "CustomAuthError" - } - } - }, - "@supabase/supabase-js.CustomAuthError.toJSON": { - "name": "@supabase/supabase-js.CustomAuthError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "nameOnly", - "name": "ErrorCode" - }, - null - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.FunctionsError.constructor": { - "name": "@supabase/supabase-js.FunctionsError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsError" - } - } - }, - "@supabase/supabase-js.FunctionsError.toJSON": { - "name": "@supabase/supabase-js.FunctionsError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/supabase-js.FunctionsFetchError.constructor": { - "name": "@supabase/supabase-js.FunctionsFetchError.constructor", - "params": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsFetchError" - } - } - }, - "@supabase/supabase-js.FunctionsFetchError.toJSON": { - "name": "@supabase/supabase-js.FunctionsFetchError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/supabase-js.FunctionsHttpError.constructor": { - "name": "@supabase/supabase-js.FunctionsHttpError.constructor", - "params": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsHttpError" - } - } - }, - "@supabase/supabase-js.FunctionsHttpError.toJSON": { - "name": "@supabase/supabase-js.FunctionsHttpError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/supabase-js.FunctionsRelayError.constructor": { - "name": "@supabase/supabase-js.FunctionsRelayError.constructor", - "params": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsRelayError" - } - } - }, - "@supabase/supabase-js.FunctionsRelayError.toJSON": { - "name": "@supabase/supabase-js.FunctionsRelayError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/supabase-js.GoTrueAdminApi.constructor": { - "name": "@supabase/supabase-js.GoTrueAdminApi.constructor", - "params": [ - { - "type": { - "type": "object", - "properties": [ - { - "name": "experimental", - "type": { - "name": "ExperimentalFeatureFlags", - "type": "object", - "properties": [ - { - "name": "passkey", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Enables passkey support:\\n - \`auth.signInWithPasskey()\`, \`auth.registerPasskey()\`\\n - \`auth.passkey.*\`\\n - \`auth.admin.passkey.*\`\\n\\nDefaults to \`false\`. Calling any passkey method while this flag is\\ndisabled throws a descriptive error at call time." - } - } - ] - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "GoTrueAdminApi" - } - }, - "comment": { - "shortText": "Creates an admin API client that can be used to manage users and OAuth clients.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\\nconst { data, error } = await supabase.auth.admin.listUsers()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { GoTrueAdminApi } from '@supabase/auth-js'\\n\\nconst admin = new GoTrueAdminApi({\\n url: 'https://xyzcompany.supabase.co/auth/v1',\\n headers: { Authorization: \`Bearer \${process.env.SUPABASE_SECRET_KEY}\` },\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.createProvider": { - "name": "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.createProvider", - "params": [ - { - "name": "params", - "type": { - "name": "CreateCustomProviderParams", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client secret (write-only, not returned in responses)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "CustomProviderResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "CustomOAuthProvider", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was created" - } - }, - { - "name": "discovery_document", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OIDCDiscoveryDocument", - "type": "object", - "properties": [ - { - "name": "authorization_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the authorization endpoint" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The issuer identifier" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the JSON Web Key Set" - } - }, - { - "name": "revocation_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the revocation endpoint" - } - }, - { - "name": "supported_id_token_signing_algs", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported ID token signing algorithms" - } - }, - { - "name": "supported_response_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported response types" - } - }, - { - "name": "supported_scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported scopes" - } - }, - { - "name": "supported_subject_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported subject types" - } - }, - { - "name": "token_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the token endpoint" - } - }, - { - "name": "userinfo_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the userinfo endpoint" - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery document (OIDC providers only)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier (UUID)" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was last updated" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new custom OIDC/OAuth provider.\\n\\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\\nfrom the issuer's well-known endpoint (or the provided \`discovery_url\`) at creation time.\\nThis may return a validation error (\`error_code: \\"validation_failed\\"\`) if the discovery\\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\\nin the document does not match the expected issuer.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.deleteProvider": { - "name": "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.deleteProvider", - "params": [ - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a custom provider.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.getProvider": { - "name": "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.getProvider", - "params": [ - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "CustomProviderResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "CustomOAuthProvider", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was created" - } - }, - { - "name": "discovery_document", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OIDCDiscoveryDocument", - "type": "object", - "properties": [ - { - "name": "authorization_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the authorization endpoint" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The issuer identifier" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the JSON Web Key Set" - } - }, - { - "name": "revocation_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the revocation endpoint" - } - }, - { - "name": "supported_id_token_signing_algs", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported ID token signing algorithms" - } - }, - { - "name": "supported_response_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported response types" - } - }, - { - "name": "supported_scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported scopes" - } - }, - { - "name": "supported_subject_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported subject types" - } - }, - { - "name": "token_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the token endpoint" - } - }, - { - "name": "userinfo_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the userinfo endpoint" - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery document (OIDC providers only)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier (UUID)" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was last updated" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Gets details of a specific custom provider by identifier.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.listProviders": { - "name": "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.listProviders", - "params": [ - { - "name": "params", - "type": { - "name": "ListCustomProvidersParams", - "type": "object", - "properties": [ - { - "name": "type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Filter by provider type" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "CustomProviderListResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "name": "CustomOAuthProvider", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was created" - } - }, - { - "name": "discovery_document", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OIDCDiscoveryDocument", - "type": "object", - "properties": [ - { - "name": "authorization_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the authorization endpoint" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The issuer identifier" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the JSON Web Key Set" - } - }, - { - "name": "revocation_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the revocation endpoint" - } - }, - { - "name": "supported_id_token_signing_algs", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported ID token signing algorithms" - } - }, - { - "name": "supported_response_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported response types" - } - }, - { - "name": "supported_scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported scopes" - } - }, - { - "name": "supported_subject_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported subject types" - } - }, - { - "name": "token_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the token endpoint" - } - }, - { - "name": "userinfo_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the userinfo endpoint" - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery document (OIDC providers only)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier (UUID)" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was last updated" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "providers" - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all custom providers with optional type filter.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.updateProvider": { - "name": "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.updateProvider", - "params": [ - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "params", - "type": { - "name": "UpdateCustomProviderParams", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth client secret (write-only, not returned in responses)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "CustomProviderResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "CustomOAuthProvider", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was created" - } - }, - { - "name": "discovery_document", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OIDCDiscoveryDocument", - "type": "object", - "properties": [ - { - "name": "authorization_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the authorization endpoint" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The issuer identifier" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the JSON Web Key Set" - } - }, - { - "name": "revocation_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the revocation endpoint" - } - }, - { - "name": "supported_id_token_signing_algs", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported ID token signing algorithms" - } - }, - { - "name": "supported_response_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported response types" - } - }, - { - "name": "supported_scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported scopes" - } - }, - { - "name": "supported_subject_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported subject types" - } - }, - { - "name": "token_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the token endpoint" - } - }, - { - "name": "userinfo_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the userinfo endpoint" - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery document (OIDC providers only)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier (UUID)" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was last updated" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates an existing custom provider.\\n\\nWhen \`issuer\` or \`discovery_url\` is changed on an OIDC provider, the server re-fetches and\\nvalidates the discovery document before persisting. This may return a validation error\\n(\`error_code: \\"validation_failed\\"\`) if the discovery document is unreachable, invalid, or\\nthe issuer does not match.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminMFAApi.deleteFactor": { - "name": "@supabase/supabase-js.GoTrueAdminMFAApi.deleteFactor", - "params": [ - { - "name": "params", - "type": { - "name": "AuthMFAAdminDeleteFactorParams", - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the MFA factor to delete." - } - }, - { - "name": "userId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the user whose factor is being deleted." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAAdminDeleteFactorResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor that was successfully deleted." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\\nsessions if the deleted factor was verified.", - "examples": [ - { - "id": "delete-a-factor-for-a-user", - "name": "Delete a factor for a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminMFAApi.listFactors": { - "name": "@supabase/supabase-js.GoTrueAdminMFAApi.listFactors", - "params": [ - { - "name": "params", - "type": { - "name": "AuthMFAAdminListFactorsParams", - "type": "object", - "properties": [ - { - "name": "userId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the user." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAAdminListFactorsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "nameOnly", - "name": "Type" - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "nameOnly", - "name": "Status" - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "comment": { - "shortText": "All factors attached to the user." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all factors associated to a user.", - "examples": [ - { - "id": "list-all-factors-for-a-user", - "name": "List all factors for a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n factors: Factor[\\n {\\n id: '',\\n friendly_name: 'Auth App Factor',\\n factor_type: 'totp',\\n status: 'verified',\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z'\\n }\\n ]\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminOAuthApi.createClient": { - "name": "@supabase/supabase-js.GoTrueAdminOAuthApi.createClient", - "params": [ - { - "name": "params", - "type": { - "name": "CreateOAuthClientParams", - "type": "object", - "properties": [ - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of allowed response types (optional, defaults to code)" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Token endpoint authentication method (defaults to server default if not specified)" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthClient", - "type": "object", - "properties": [ - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client" - } - }, - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Client secret (only returned on registration and regeneration)" - } - }, - { - "name": "client_type", - "type": { - "type": "union", - "name": "OAuthClientType", - "subTypes": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - }, - "comment": { - "shortText": "Type of OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was created" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "registration_type", - "type": { - "type": "union", - "name": "OAuthClientRegistrationType", - "subTypes": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - }, - "comment": { - "shortText": "Registration type of the client" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "comment": { - "shortText": "Array of allowed response types" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "comment": { - "shortText": "Token endpoint authentication method" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was last updated" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminOAuthApi.deleteClient": { - "name": "@supabase/supabase-js.GoTrueAdminOAuthApi.deleteClient", - "params": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Deletes an OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminOAuthApi.getClient": { - "name": "@supabase/supabase-js.GoTrueAdminOAuthApi.getClient", - "params": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthClient", - "type": "object", - "properties": [ - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client" - } - }, - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Client secret (only returned on registration and regeneration)" - } - }, - { - "name": "client_type", - "type": { - "type": "union", - "name": "OAuthClientType", - "subTypes": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - }, - "comment": { - "shortText": "Type of OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was created" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "registration_type", - "type": { - "type": "union", - "name": "OAuthClientRegistrationType", - "subTypes": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - }, - "comment": { - "shortText": "Registration type of the client" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "comment": { - "shortText": "Array of allowed response types" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "comment": { - "shortText": "Token endpoint authentication method" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was last updated" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Gets details of a specific OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminOAuthApi.listClients": { - "name": "@supabase/supabase-js.GoTrueAdminOAuthApi.listClients", - "params": [ - { - "name": "params", - "type": { - "name": "PageParams", - "type": "object", - "properties": [ - { - "name": "page", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The page number" - } - }, - { - "name": "perPage", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Number of items returned per page" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientListResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "clients" - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all OAuth clients with optional pagination.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminOAuthApi.regenerateClientSecret": { - "name": "@supabase/supabase-js.GoTrueAdminOAuthApi.regenerateClientSecret", - "params": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthClient", - "type": "object", - "properties": [ - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client" - } - }, - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Client secret (only returned on registration and regeneration)" - } - }, - { - "name": "client_type", - "type": { - "type": "union", - "name": "OAuthClientType", - "subTypes": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - }, - "comment": { - "shortText": "Type of OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was created" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "registration_type", - "type": { - "type": "union", - "name": "OAuthClientRegistrationType", - "subTypes": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - }, - "comment": { - "shortText": "Registration type of the client" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "comment": { - "shortText": "Array of allowed response types" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "comment": { - "shortText": "Token endpoint authentication method" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was last updated" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Regenerates the secret for an OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminOAuthApi.updateClient": { - "name": "@supabase/supabase-js.GoTrueAdminOAuthApi.updateClient", - "params": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "params", - "type": { - "name": "UpdateOAuthClientParams", - "type": "object", - "properties": [ - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Token endpoint authentication method" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthClient", - "type": "object", - "properties": [ - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client" - } - }, - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Client secret (only returned on registration and regeneration)" - } - }, - { - "name": "client_type", - "type": { - "type": "union", - "name": "OAuthClientType", - "subTypes": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - }, - "comment": { - "shortText": "Type of OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was created" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "registration_type", - "type": { - "type": "union", - "name": "OAuthClientRegistrationType", - "subTypes": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - }, - "comment": { - "shortText": "Registration type of the client" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "comment": { - "shortText": "Array of allowed response types" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "comment": { - "shortText": "Token endpoint authentication method" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was last updated" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates an existing OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminPasskeyApi.deletePasskey": { - "name": "@supabase/supabase-js.GoTrueAdminPasskeyApi.deletePasskey", - "params": [ - { - "name": "params", - "type": { - "name": "AuthPasskeyAdminDeleteParams", - "type": "object", - "properties": [ - { - "name": "passkeyId", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "userId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyDeleteResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a specific passkey for a specific user.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminPasskeyApi.listPasskeys": { - "name": "@supabase/supabase-js.GoTrueAdminPasskeyApi.listPasskeys", - "params": [ - { - "name": "params", - "type": { - "name": "AuthPasskeyAdminListParams", - "type": "object", - "properties": [ - { - "name": "userId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyListResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "name": "PasskeyListItem", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_used_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all passkeys registered for a specific user.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/supabase-js.GoTrueAdminApi.createUser": { - "name": "@supabase/supabase-js.GoTrueAdminApi.createUser", - "params": [ - { - "name": "attributes", - "type": { - "type": "object", - "name": "AdminUserAttributes", - "properties": [ - { - "name": "app_metadata", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column.\\n\\nOnly a service role can modify.\\n\\nThe \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\\naccess control information." - } - }, - { - "name": "ban_duration", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Determines how long a user is banned for.\\n\\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\\nValid time units are \\"ns\\", \\"us\\" (or \\"µs\\"), \\"ms\\", \\"s\\", \\"m\\", \\"h\\".\\n\\nFor example, some possible durations include: '300ms', '2h45m'.\\n\\nSetting the ban duration to 'none' lifts the ban on the user." - } - }, - { - "name": "current_password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's current password\\n\\nThis is only ever present when the user is resetting\\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's email." - } - }, - { - "name": "email_confirm", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Sets the user's email as confirmed when true, or unconfirmed when false.\\n\\nOnly a service role can modify." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`id\` for the user.\\n\\nAllows you to overwrite the default \`id\` set for the user." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." - } - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's password." - } - }, - { - "name": "password_hash", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`password_hash\` for the user's password.\\n\\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\\n\\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's phone." - } - }, - { - "name": "phone_confirm", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Sets the user's phone as confirmed when true, or unconfirmed when false.\\n\\nOnly a service role can modify." - } - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`role\` claim set in the user's access token JWT.\\n\\nWhen a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\\n\\nSetting this role to \`service_role\` is not recommended as it grants the user admin privileges." - } - }, - { - "name": "user_metadata", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\n\\nThe \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\\nthis attribute is used instead of UserAttributes data." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new user.\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser.", - "text": "- To confirm the user's email address or phone number, set \`email_confirm\` or \`phone_confirm\` to true. Both arguments default to false.\\n- \`createUser()\` will not send a confirmation email to the user. You can use [\`inviteUserByEmail()\`](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the \`email_confirm\` or \`phone_confirm\` param to \`true\`.", - "examples": [ - { - "id": "with-custom-user-metadata", - "name": "With custom user metadata", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.createUser({\\n email: 'user@email.com',\\n password: 'password',\\n user_metadata: { name: 'Yoda' }\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n user: {\\n id: '1',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {},\\n user_metadata: {},\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"1\\",\\n \\"user_id\\": \\"1\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"1\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false,\\n }\\n }\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "auto-confirm-the-user-s-email", - "name": "Auto-confirm the user's email", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.createUser({\\n email: 'user@email.com',\\n email_confirm: true\\n})\\n\`\`\`" - }, - { - "id": "auto-confirm-the-user-s-phone-number", - "name": "Auto-confirm the user's phone number", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.createUser({\\n phone: '1234567890',\\n phone_confirm: true\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminApi.deleteUser": { - "name": "@supabase/supabase-js.GoTrueAdminApi.deleteUser", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user id you want to remove." - } - }, - { - "name": "shouldSoftDelete", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\\nDefaults to false for backward compatibility.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Delete a user. Requires a \`service_role\` key.", - "text": "- The \`deleteUser()\` method requires the user's ID, which maps to the \`auth.users.id\` column.", - "examples": [ - { - "id": "removes-a-user", - "name": "Removes a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.deleteUser(\\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\\n)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {}\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminApi.generateLink": { - "name": "@supabase/supabase-js.GoTrueAdminApi.generateLink", - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "GenerateLinkParams", - "subTypes": [ - { - "name": "GenerateSignupLinkParams", - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "isOptional": true - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "signup" - } - } - ] - }, - { - "name": "GenerateInviteOrMagiclinkParams", - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email" - } - }, - { - "name": "options", - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ] - }, - { - "name": "GenerateRecoveryLinkParams", - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email" - } - }, - { - "name": "options", - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "recovery" - } - } - ] - }, - { - "name": "GenerateEmailChangeLinkParams", - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email" - } - }, - { - "name": "newEmail", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - } - }, - { - "name": "options", - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "GenerateLinkResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "properties", - "type": { - "name": "GenerateLinkProperties", - "type": "object", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The email link to send to the user.\\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - } - }, - { - "name": "email_otp", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The raw email OTP.\\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - } - }, - { - "name": "hashed_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The hashed token appended to the action link." - } - }, - { - "name": "redirect_to", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The URL appended to the action link." - } - }, - { - "name": "verification_type", - "type": { - "type": "union", - "name": "GenerateLinkType", - "subTypes": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - }, - "comment": { - "shortText": "The verification type that the email link is associated to." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "properties", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Generates email links and OTPs to be sent via a custom email provider.", - "text": "- The following types can be passed into \`generateLink()\`: \`signup\`, \`magiclink\`, \`invite\`, \`recovery\`, \`email_change_current\`, \`email_change_new\`, \`phone_change\`.\\n- \`generateLink()\` only generates the email link for \`email_change_email\` if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\\n- \`generateLink()\` handles the creation of the user for \`signup\`, \`invite\` and \`magiclink\`.", - "examples": [ - { - "id": "generate-a-signup-link", - "name": "Generate a signup link", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'signup',\\n email: 'email@example.com',\\n password: 'secret'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"properties\\": {\\n \\"action_link\\": \\"\\",\\n \\"email_otp\\": \\"999999\\",\\n \\"hashed_token\\": \\"\\",\\n \\"verification_type\\": \\"signup\\"\\n },\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"email@example.com\\",\\n \\"phone\\": \\"\\",\\n \\"confirmation_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"email@example.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "generate-an-invite-link", - "name": "Generate an invite link", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'invite',\\n email: 'email@example.com'\\n})\\n\`\`\`" - }, - { - "id": "generate-a-magic-link", - "name": "Generate a magic link", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'magiclink',\\n email: 'email@example.com'\\n})\\n\`\`\`" - }, - { - "id": "generate-a-recovery-link", - "name": "Generate a recovery link", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'recovery',\\n email: 'email@example.com'\\n})\\n\`\`\`" - }, - { - "id": "generate-links-to-change-current-email-address", - "name": "Generate links to change current email address", - "code": "\`\`\`js\\n// generate an email change link to be sent to the current email address\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'email_change_current',\\n email: 'current.email@example.com',\\n newEmail: 'new.email@example.com'\\n})\\n\\n// generate an email change link to be sent to the new email address\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'email_change_new',\\n email: 'current.email@example.com',\\n newEmail: 'new.email@example.com'\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminApi.getUserById": { - "name": "@supabase/supabase-js.GoTrueAdminApi.getUserById", - "params": [ - { - "name": "uid", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's unique identifier\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Get user by id.", - "text": "- Fetches the user object from the database based on the user's id.\\n- The \`getUserById()\` method requires the user's id which maps to the \`auth.users.id\` column.", - "examples": [ - { - "id": "fetch-the-user-object-using-the-access-token-jwt", - "name": "Fetch the user object using the access_token jwt", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.getUserById(1)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n user: {\\n id: '1',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {},\\n user_metadata: {},\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"1\\",\\n \\"user_id\\": \\"1\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"1\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false,\\n }\\n }\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminApi.inviteUserByEmail": { - "name": "@supabase/supabase-js.GoTrueAdminApi.inviteUserByEmail", - "params": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The email address of the user." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store additional metadata about the user. This maps to the \`auth.users.user_metadata\` column." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Additional options to be included when inviting." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sends an invite link to an email address.", - "text": "- Sends an invite link to the user's email address.\\n- The \`inviteUserByEmail()\` method is typically used by administrators to invite users to join the application.\\n- Note that PKCE is not supported when using \`inviteUserByEmail\`. This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow.", - "examples": [ - { - "id": "invite-a-user", - "name": "Invite a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"invited_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmation_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminApi.listUsers": { - "name": "@supabase/supabase-js.GoTrueAdminApi.listUsers", - "params": [ - { - "name": "params", - "type": { - "name": "PageParams", - "type": "object", - "properties": [ - { - "name": "page", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The page number" - } - }, - { - "name": "perPage", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Number of items returned per page" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "An object which supports \`page\` and \`perPage\` as numbers, to alter the paginated results." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "users" - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Get a list of users.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser.", - "text": "- Defaults to return 50 users per page.", - "examples": [ - { - "id": "get-a-page-of-users", - "name": "Get a page of users", - "code": "\`\`\`js\\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\\n\`\`\`" - }, - { - "id": "paginated-list-of-users", - "name": "Paginated list of users", - "code": "\`\`\`js\\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\\n page: 1,\\n perPage: 1000\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueAdminApi.signOut": { - "name": "@supabase/supabase-js.GoTrueAdminApi.signOut", - "params": [ - { - "name": "jwt", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A valid, logged-in JWT." - } - }, - { - "name": "scope", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The logout sope." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Removes a logged-in session." - } - }, - "@supabase/supabase-js.GoTrueAdminApi.updateUserById": { - "name": "@supabase/supabase-js.GoTrueAdminApi.updateUserById", - "params": [ - { - "name": "uid", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's unique identifier" - } - }, - { - "name": "attributes", - "type": { - "type": "object", - "name": "AdminUserAttributes", - "properties": [ - { - "name": "app_metadata", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column.\\n\\nOnly a service role can modify.\\n\\nThe \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\\naccess control information." - } - }, - { - "name": "ban_duration", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Determines how long a user is banned for.\\n\\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\\nValid time units are \\"ns\\", \\"us\\" (or \\"µs\\"), \\"ms\\", \\"s\\", \\"m\\", \\"h\\".\\n\\nFor example, some possible durations include: '300ms', '2h45m'.\\n\\nSetting the ban duration to 'none' lifts the ban on the user." - } - }, - { - "name": "current_password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's current password\\n\\nThis is only ever present when the user is resetting\\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's email." - } - }, - { - "name": "email_confirm", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Sets the user's email as confirmed when true, or unconfirmed when false.\\n\\nOnly a service role can modify." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`id\` for the user.\\n\\nAllows you to overwrite the default \`id\` set for the user." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." - } - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's password." - } - }, - { - "name": "password_hash", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`password_hash\` for the user's password.\\n\\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\\n\\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's phone." - } - }, - { - "name": "phone_confirm", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Sets the user's phone as confirmed when true, or unconfirmed when false.\\n\\nOnly a service role can modify." - } - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`role\` claim set in the user's access token JWT.\\n\\nWhen a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\\n\\nSetting this role to \`service_role\` is not recommended as it grants the user admin privileges." - } - }, - { - "name": "user_metadata", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\n\\nThe \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\\nthis attribute is used instead of UserAttributes data." - } - } - ] - }, - "comment": { - "shortText": "The data you want to update.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates the user data. Changes are applied directly without confirmation flows.", - "text": "**Important:** This is a server-side operation and does **not** trigger client-side\\n\`onAuthStateChange\` listeners. The admin API has no connection to client state.\\n\\nTo sync changes to the client after calling this method:\\n1. On the client, call \`supabase.auth.refreshSession()\` to fetch the updated user data\\n2. This will trigger the \`TOKEN_REFRESHED\` event and notify all listeners", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`typescript\\n// Server-side (Edge Function)\\nconst { data, error } = await supabase.auth.admin.updateUserById(\\n userId,\\n { user_metadata: { preferences: { theme: 'dark' } } }\\n)\\n\\n// Client-side (to sync the changes)\\nconst { data, error } = await supabase.auth.refreshSession()\\n// onAuthStateChange listeners will now be notified with updated user\\n\`\`\`" - }, - { - "id": "updates-a-user-s-email", - "name": "Updates a user's email", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '11111111-1111-1111-1111-111111111111',\\n { email: 'new@email.com' }\\n)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"new@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"recovery_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "updates-a-user-s-password", - "name": "Updates a user's password", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { password: 'new_password' }\\n)\\n\`\`\`" - }, - { - "id": "updates-a-user-s-metadata", - "name": "Updates a user's metadata", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { user_metadata: { hello: 'world' } }\\n)\\n\`\`\`" - }, - { - "id": "updates-a-user-s-app-metadata", - "name": "Updates a user's app_metadata", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { app_metadata: { plan: 'trial' } }\\n)\\n\`\`\`" - }, - { - "id": "confirms-a-user-s-email-address", - "name": "Confirms a user's email address", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { email_confirm: true }\\n)\\n\`\`\`" - }, - { - "id": "confirms-a-user-s-phone-number", - "name": "Confirms a user's phone number", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { phone_confirm: true }\\n)\\n\`\`\`" - }, - { - "id": "ban-a-user-for-100-years", - "name": "Ban a user for 100 years", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { ban_duration: '876000h' }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.constructor": { - "name": "@supabase/supabase-js.GoTrueClient.constructor", - "params": [ - { - "name": "options", - "type": { - "name": "GoTrueClientOptions", - "type": "object", - "properties": [ - { - "name": "autoRefreshToken", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "debug", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "function", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "args", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - ] - }, - "isOptional": true - }, - { - "name": "detectSessionInUrl", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "function", - "params": [ - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "params", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Set to \\"true\\" if you want to automatically detect OAuth grants in the URL and sign in the user.\\nSet to \\"false\\" to disable automatic detection.\\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\\nThe function receives the current URL and parsed parameters, and should return true if the URL\\nshould be processed as a Supabase auth callback, or false to ignore it.\\n\\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\ndetectSessionInUrl: (url, params) => {\\n // Ignore Facebook OAuth redirects\\n if (url.pathname === '/facebook/redirect') return false\\n // Use default detection for other URLs\\n return Boolean(params.access_token || params.error_description)\\n}\\n\`\`\`" - } - ] - } - }, - { - "name": "experimental", - "type": { - "name": "ExperimentalFeatureFlags", - "type": "object", - "properties": [ - { - "name": "passkey", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Enables passkey support:\\n - \`auth.signInWithPasskey()\`, \`auth.registerPasskey()\`\\n - \`auth.passkey.*\`\\n - \`auth.admin.passkey.*\`\\n\\nDefaults to \`false\`. Calling any passkey method while this flag is\\ndisabled throws a descriptive error at call time." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Opt-in flags for experimental features. These APIs may change without\\nnotice and are disabled by default.", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ] - } - }, - { - "name": "fetch", - "type": { - "type": "nameOnly", - "name": "Fetch" - }, - "isOptional": true - }, - { - "name": "flowType", - "type": { - "type": "union", - "name": "AuthFlowType", - "subTypes": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - }, - null - ] - }, - "isOptional": true - }, - { - "name": "hasCustomAuthorizationHeader", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Set to \\"true\\" if there is a custom authorization header set globally.", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ] - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "lock", - "type": { - "name": "LockFunc", - "type": "function", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the lock to be acquired." - } - }, - { - "name": "acquireTimeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "If negative, no timeout should occur. If positive it\\n should throw an Error with an \`isAcquireTimeout\`\\n property set to true if the operation fails to be\\n acquired after this much time (ms)." - } - }, - { - "name": "fn", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "R" - } - } - } - }, - "comment": { - "shortText": "The operation to execute when the lock is acquired." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "R" - } - } - } - }, - "isOptional": true, - "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default\\nthe client coordinates refreshes itself (single-flight via\\n\`refreshingDeferred\` + commit guard) and relies on the GoTrue server to\\nresolve cross-tab refresh races. Passing a custom lock opts into a\\nlegacy path that wraps every auth operation in your supplied lock — this\\npath is preserved for backwards compatibility (typically React Native\\n\`processLock\` or Node multi-process setups)." - } - }, - { - "name": "lockAcquireTimeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The maximum time in milliseconds to wait for acquiring the custom lock\\nsupplied via the \`lock\` option. Only consulted when a custom \`lock\` is\\npassed — the default lockless path doesn't use this timeout." - } - }, - { - "name": "persistSession", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "skipAutoInitialize", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If true, skips automatic initialization in constructor. Useful for SSR\\ncontexts where initialization timing must be controlled to prevent race\\nconditions with HTTP response generation." - } - }, - { - "name": "storage", - "type": { - "type": "nameOnly", - "name": "SupportedStorage" - }, - "isOptional": true - }, - { - "name": "storageKey", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "throwOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If there is an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response." - } - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "userStorage", - "type": { - "type": "nameOnly", - "name": "SupportedStorage" - }, - "isOptional": true, - "comment": { - "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, \`storage\` will only store a JSON object containing the access and refresh token and some adjacent metadata, while \`userStorage\` will only contain the user object under the key \`storageKey + '-user'\`.\\n\\nWhen this option is set and cookie storage is used, \`getSession()\` and other functions that load a session from the cookie store might not return back a user. It's very important to always use \`getUser()\` to fetch a user object in those scenarios.", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ] - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "GoTrueClient" - } - }, - "comment": { - "shortText": "Create a new client for use in the browser.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.auth.getUser()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { GoTrueClient } from '@supabase/auth-js'\\n\\nconst auth = new GoTrueClient({\\n url: 'https://xyzcompany.supabase.co/auth/v1',\\n headers: { apikey: 'your-publishable-key' },\\n storageKey: 'supabase-auth',\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueMFAApi.challenge": { - "name": "@supabase/supabase-js.GoTrueMFAApi.challenge", - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAChallengeParamsBase" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "AuthMFAChallengeResponseBase" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\\nfactor.", - "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\\n- To verify a challenge, see [\`mfa.verify()\`](/docs/reference/javascript/auth-mfa-verify).\\n- A phone factor sends a code to the user upon challenge. The channel defaults to \`sms\` unless otherwise specified.", - "examples": [ - { - "id": "create-a-challenge-for-a-factor", - "name": "Create a challenge for a factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.challenge({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n type: 'totp',\\n expires_at: 1700000000\\n },\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "create-a-challenge-for-a-phone-factor", - "name": "Create a challenge for a phone factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.challenge({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n type: 'phone',\\n expires_at: 1700000000\\n },\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "create-a-challenge-for-a-phone-factor-whatsapp", - "name": "Create a challenge for a phone factor (WhatsApp)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.challenge({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n channel: 'whatsapp',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n expires_at: 1700000000\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAChallengePhoneParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "AuthMFAChallengeResponseBase" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAChallengeWebauthnParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "MFAChallengeParams", - "subTypes": [ - { - "type": "nameOnly", - "name": "MFAChallengeTOTPParams" - }, - { - "type": "nameOnly", - "name": "MFAChallengePhoneParams" - }, - { - "type": "nameOnly", - "name": "MFAChallengeWebauthnParams" - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAChallengeResponse", - "subTypes": [ - { - "type": "union", - "name": "AuthMFAChallengeTOTPResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - }, - { - "type": "union", - "name": "AuthMFAChallengePhoneResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - }, - { - "type": "union", - "name": "AuthMFAChallengeWebauthnResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - ] - } - } - } - } - ] - }, - "@supabase/supabase-js.GoTrueMFAApi.challengeAndVerify": { - "name": "@supabase/supabase-js.GoTrueMFAApi.challengeAndVerify", - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAChallengeAndVerifyTOTPParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\\nprovided by the user by entering a code seen in their authenticator app.", - "text": "- Intended for use with only TOTP factors.\\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking \`challengeAndVerify()\`.\\n- Executes [\`mfa.challenge()\`](/docs/reference/javascript/auth-mfa-challenge) and [\`mfa.verify()\`](/docs/reference/javascript/auth-mfa-verify) in a single step.", - "examples": [ - { - "id": "create-and-verify-a-challenge-for-a-factor", - "name": "Create and verify a challenge for a factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n code: '123456'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n access_token: '',\\n token_type: 'Bearer',\\n expires_in: 3600,\\n refresh_token: '',\\n user: {\\n id: '11111111-1111-1111-1111-111111111111',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {\\n provider: 'email',\\n providers: [\\n \\"email\\",\\n ]\\n },\\n user_metadata: {},\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false,\\n factors: [\\n \\"id\\": '',\\n \\"friendly_name\\": 'Important Auth App',\\n \\"factor_type\\": 'totp',\\n \\"status\\": 'verified',\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n ]\\n }\\n }\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueMFAApi.enroll": { - "name": "@supabase/supabase-js.GoTrueMFAApi.enroll", - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAEnrollTOTPParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAEnrollTOTPResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\\nfactor. This method creates a new \`unverified\` factor.\\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\\nauthenticator app.\\nThe user has to enter the code from their authenticator app to verify it.\\n\\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to \`aal2\`.", - "text": "- Use \`totp\` or \`phone\` as the \`factorType\` and use the returned \`id\` to create a challenge.\\n- To create a challenge, see [\`mfa.challenge()\`](/docs/reference/javascript/auth-mfa-challenge).\\n- To verify a challenge, see [\`mfa.verify()\`](/docs/reference/javascript/auth-mfa-verify).\\n- To create and verify a TOTP challenge in a single step, see [\`mfa.challengeAndVerify()\`](/docs/reference/javascript/auth-mfa-challengeandverify).\\n- To generate a QR code for the \`totp\` secret in Next.js, you can do the following:\\n\`\`\`html\\n{data.totp.uri}\\n\`\`\`\\n- The \`challenge\` and \`verify\` steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge.", - "examples": [ - { - "id": "enroll-a-time-based-one-time-password-totp-factor", - "name": "Enroll a time-based, one-time password (TOTP) factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.enroll({\\n factorType: 'totp',\\n friendlyName: 'your_friendly_name'\\n})\\n\\n// Use the id to create a challenge.\\n// The challenge can be verified by entering the code generated from the authenticator app.\\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n type: 'totp'\\n totp: {\\n qr_code: '',\\n secret: '',\\n uri: '',\\n }\\n friendly_name?: 'Important app'\\n },\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "enroll-a-phone-factor", - "name": "Enroll a Phone Factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.enroll({\\n factorType: 'phone',\\n friendlyName: 'your_friendly_name',\\n phone: '+12345678',\\n})\\n\\n// Use the id to create a challenge and send an SMS with a code to the user.\\nconst { id, type, friendly_name, phone } = data\\n\\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n type: 'phone',\\n friendly_name?: 'Important app',\\n phone: '+5787123456'\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAEnrollPhoneParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAEnrollPhoneResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAEnrollParamsBase" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAEnrollWebauthnResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "MFAEnrollParams", - "subTypes": [ - { - "type": "nameOnly", - "name": "MFAEnrollTOTPParams" - }, - { - "type": "nameOnly", - "name": "MFAEnrollPhoneParams" - }, - { - "type": "nameOnly", - "name": "MFAEnrollWebauthnParams" - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAEnrollResponse", - "subTypes": [ - { - "type": "union", - "name": "AuthMFAEnrollTOTPResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - }, - { - "type": "union", - "name": "AuthMFAEnrollPhoneResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - }, - { - "type": "union", - "name": "AuthMFAEnrollWebauthnResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - ] - } - } - } - } - ] - }, - "@supabase/supabase-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel": { - "name": "@supabase/supabase-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel", - "params": [ - { - "name": "jwt", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "currentAuthenticationMethods", - "type": { - "type": "union", - "subTypes": [ - { - "type": "array", - "elemType": { - "type": "object", - "name": "AMREntry", - "properties": [ - { - "name": "method", - "type": { - "type": "union", - "name": "AMRMethod", - "subTypes": [ - { - "type": "nameOnly", - "name": "['number']" - }, - null - ] - }, - "comment": { - "shortText": "Authentication method name." - } - }, - { - "name": "timestamp", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - } - ] - } - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "comment": { - "shortText": "A list of all authentication methods attached to this session. Use\\nthe information here to detect the last time a user verified a\\nfactor, for example if implementing a step-up scenario.\\n\\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\\n- String format: ['password', 'otp'] - RFC-8176 compliant\\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - }, - { - "name": "currentLevel", - "type": { - "type": "union", - "subTypes": [ - { - "type": "union", - "name": "AuthenticatorAssuranceLevels", - "subTypes": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - null - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "comment": { - "shortText": "Current AAL level of the session." - } - }, - { - "name": "nextLevel", - "type": { - "type": "union", - "subTypes": [ - { - "type": "union", - "name": "AuthenticatorAssuranceLevels", - "subTypes": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - null - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "comment": { - "shortText": "Next possible AAL level for the session. If the next level is higher\\nthan the current one, the user should go through MFA." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.\\n\\n- \`aal1\` (or \`null\`) means that the user's identity has been verified only\\nwith a conventional login (email+password, OTP, magic link, social login,\\netc.).\\n- \`aal2\` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\\n\\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\\nand rarely uses the network. When a JWT is provided (useful in server-side\\nenvironments like Edge Functions where no session is stored), this method\\nwill make a network request to validate the user and fetch their MFA factors.", - "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\\n- In Supabase, having an AAL of \`aal1\` refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while \`aal2\` refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\\n- If the user has a verified factor, the \`nextLevel\` field will return \`aal2\`, else, it will return \`aal1\`.\\n- An optional \`jwt\` parameter can be passed to check the AAL level of a specific JWT instead of the current session.", - "examples": [ - { - "id": "get-the-aal-details-of-a-session", - "name": "Get the AAL details of a session", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n currentLevel: 'aal1',\\n nextLevel: 'aal2',\\n currentAuthenticationMethods: [\\n {\\n method: 'password',\\n timestamp: 1700000000\\n }\\n ]\\n }\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "get-the-aal-details-for-a-specific-jwt", - "name": "Get the AAL details for a specific JWT", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueMFAApi.listFactors": { - "name": "@supabase/supabase-js.GoTrueMFAApi.listFactors", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAListFactorsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Returns the list of MFA factors enabled for this user." - } - }, - "@supabase/supabase-js.GoTrueMFAApi.unenroll": { - "name": "@supabase/supabase-js.GoTrueMFAApi.unenroll", - "params": [ - { - "name": "params", - "type": { - "name": "MFAUnenrollParams", - "type": "object", - "properties": [ - { - "name": "factorId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor being unenrolled." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAUnenrollResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor that was successfully unenrolled." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Unenroll removes a MFA factor.\\nA user has to have an \`aal2\` authenticator level in order to unenroll a \`verified\` factor.", - "examples": [ - { - "id": "unenroll-a-factor", - "name": "Unenroll a factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.unenroll({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: ''\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueMFAApi.verify": { - "name": "@supabase/supabase-js.GoTrueMFAApi.verify", - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAVerifyTOTPParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\\nprovided by the user by entering a code seen in their authenticator app.", - "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first.", - "examples": [ - { - "id": "verify-a-challenge-for-a-factor", - "name": "Verify a challenge for a factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.verify({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\\n code: '123456'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n access_token: '',\\n token_type: 'Bearer',\\n expires_in: 3600,\\n refresh_token: '',\\n user: {\\n id: '11111111-1111-1111-1111-111111111111',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {\\n provider: 'email',\\n providers: [\\n \\"email\\",\\n ]\\n },\\n user_metadata: {},\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false,\\n factors: [\\n \\"id\\": '',\\n \\"friendly_name\\": 'Important Auth App',\\n \\"factor_type\\": 'totp',\\n \\"status\\": 'verified',\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n ]\\n }\\n }\\n error: null\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAVerifyPhoneParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAVerifyWebauthnParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "MFAVerifyParams", - "subTypes": [ - { - "type": "nameOnly", - "name": "MFAVerifyTOTPParams" - }, - { - "type": "nameOnly", - "name": "MFAVerifyPhoneParams" - }, - { - "type": "nameOnly", - "name": "MFAVerifyWebauthnParams" - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - } - ] - }, - "@supabase/supabase-js.AuthOAuthServerApi.approveAuthorization": { - "name": "@supabase/supabase-js.AuthOAuthServerApi.approveAuthorization", - "params": [ - { - "name": "authorizationId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The authorization ID to approve" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional parameters" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthConsentResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthRedirect", - "type": "object", - "properties": [ - { - "name": "redirect_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Complete redirect URL with authorization code and state parameters (e.g., \\"https://app.com/callback?code=xxx&state=yyy\\")" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Approves an OAuth authorization request.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nAfter approval, the user's consent is stored and an authorization code is generated.\\nThe response contains a complete redirect URL with the authorization code and state." - } - }, - "@supabase/supabase-js.AuthOAuthServerApi.denyAuthorization": { - "name": "@supabase/supabase-js.AuthOAuthServerApi.denyAuthorization", - "params": [ - { - "name": "authorizationId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The authorization ID to deny" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional parameters" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthConsentResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthRedirect", - "type": "object", - "properties": [ - { - "name": "redirect_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Complete redirect URL with authorization code and state parameters (e.g., \\"https://app.com/callback?code=xxx&state=yyy\\")" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Denies an OAuth authorization request.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nAfter denial, the response contains a redirect URL with an OAuth error\\n(access_denied) to inform the OAuth client that the user rejected the request." - } - }, - "@supabase/supabase-js.AuthOAuthServerApi.getAuthorizationDetails": { - "name": "@supabase/supabase-js.AuthOAuthServerApi.getAuthorizationDetails", - "params": [ - { - "name": "authorizationId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The authorization ID from the authorization request" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthAuthorizationDetailsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OAuthAuthorizationDetails", - "type": "object", - "properties": [ - { - "name": "authorization_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The authorization ID used to approve or deny the request" - } - }, - { - "name": "client", - "type": { - "name": "OAuthAuthorizationClient", - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client (UUID)" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URI of the OAuth client's website" - } - } - ] - }, - "comment": { - "shortText": "OAuth client requesting authorization" - } - }, - { - "name": "redirect_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The OAuth client's registered redirect URI (base URI without query parameters)" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Space-separated list of requested scopes (e.g., \\"openid profile email\\")" - } - }, - { - "name": "user", - "type": { - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "User email" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "User ID (UUID)" - } - } - ] - }, - "comment": { - "shortText": "User object associated with the authorization" - } - } - ] - }, - { - "name": "OAuthRedirect", - "type": "object", - "properties": [ - { - "name": "redirect_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Complete redirect URL with authorization code and state parameters (e.g., \\"https://app.com/callback?code=xxx&state=yyy\\")" - } - } - ] - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves details about an OAuth authorization request.\\nUsed to display consent information to the user.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis method returns one of two response types:\\n- \`OAuthAuthorizationDetails\`: User needs to consent - show consent page with client info\\n- \`OAuthRedirect\`: User already consented - redirect immediately to the OAuth client\\n\\nUse type narrowing to distinguish between the responses:\\n\`\`\`typescript\\nif ('authorization_id' in data) {\\n // Show consent page\\n} else {\\n // Redirect to data.redirect_url\\n}\\n\`\`\`" - } - }, - "@supabase/supabase-js.AuthOAuthServerApi.listGrants": { - "name": "@supabase/supabase-js.AuthOAuthServerApi.listGrants", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthGrantsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "name": "OAuthGrant", - "type": "object", - "properties": [ - { - "name": "client", - "type": { - "name": "OAuthAuthorizationClient", - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client (UUID)" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URI of the OAuth client's website" - } - } - ] - }, - "comment": { - "shortText": "OAuth client information" - } - }, - { - "name": "granted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the grant was created (ISO 8601 date-time)" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of scopes granted to this client" - } - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all OAuth grants that the authenticated user has authorized.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - }, - "@supabase/supabase-js.AuthOAuthServerApi.revokeGrant": { - "name": "@supabase/supabase-js.AuthOAuthServerApi.revokeGrant", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The OAuth client identifier (UUID) to revoke access for" - } - } - ] - }, - "comment": { - "shortText": "Revocation options" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthRevokeGrantResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Revokes a user's OAuth grant for a specific client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\\nand invalidates associated refresh tokens." - } - }, - "@supabase/supabase-js.AuthPasskeyApi.delete": { - "name": "@supabase/supabase-js.AuthPasskeyApi.delete", - "params": [ - { - "name": "params", - "type": { - "name": "PasskeyDeleteParams", - "type": "object", - "properties": [ - { - "name": "passkeyId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "UUID of the passkey to delete" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyDeleteResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a passkey for the currently signed-in user." - } - }, - "@supabase/supabase-js.AuthPasskeyApi.list": { - "name": "@supabase/supabase-js.AuthPasskeyApi.list", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyListResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "name": "PasskeyListItem", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_used_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all passkeys registered for the currently signed-in user." - } - }, - "@supabase/supabase-js.AuthPasskeyApi.startAuthentication": { - "name": "@supabase/supabase-js.AuthPasskeyApi.startAuthentication", - "params": [ - { - "name": "params", - "type": { - "name": "StartPasskeyAuthenticationParams", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyAuthenticationOptionsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyAuthenticationOptionsResponse", - "type": "object", - "properties": [ - { - "name": "challenge_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "ServerCredentialRequestOptions" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Starts the passkey authentication ceremony. Fetches an authentication\\nchallenge and credential request options from the server. Used as the\\nfirst step of a two-step sign-in flow when the caller wants to handle\\n\`navigator.credentials.get()\` themselves." - } - }, - "@supabase/supabase-js.AuthPasskeyApi.startRegistration": { - "name": "@supabase/supabase-js.AuthPasskeyApi.startRegistration", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyRegistrationOptionsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyRegistrationOptionsResponse", - "type": "object", - "properties": [ - { - "name": "challenge_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "ServerCredentialCreationOptions" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Starts the passkey registration ceremony. Fetches a registration challenge\\nand credential creation options from the server. Used as the first step of\\na two-step registration flow when the caller wants to handle\\n\`navigator.credentials.create()\` themselves." - } - }, - "@supabase/supabase-js.AuthPasskeyApi.update": { - "name": "@supabase/supabase-js.AuthPasskeyApi.update", - "params": [ - { - "name": "params", - "type": { - "name": "PasskeyUpdateParams", - "type": "object", - "properties": [ - { - "name": "friendlyName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New friendly name (max 120 chars)" - } - }, - { - "name": "passkeyId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "UUID of the passkey to update" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyUpdateResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyListItem", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_used_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates a passkey's friendly name." - } - }, - "@supabase/supabase-js.AuthPasskeyApi.verifyAuthentication": { - "name": "@supabase/supabase-js.AuthPasskeyApi.verifyAuthentication", - "params": [ - { - "name": "params", - "type": { - "name": "VerifyPasskeyAuthenticationParams", - "type": "object", - "properties": [ - { - "name": "challengeId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Challenge ID from startAuthentication" - } - }, - { - "name": "credential", - "type": { - "type": "nameOnly", - "name": "ServerCredentialResponse" - }, - "comment": { - "shortText": "Serialized credential from navigator.credentials.get()" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyAuthenticationVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Verifies a passkey authentication credential against a previously issued\\nchallenge. Used as the second step of a two-step sign-in flow." - } - }, - "@supabase/supabase-js.AuthPasskeyApi.verifyRegistration": { - "name": "@supabase/supabase-js.AuthPasskeyApi.verifyRegistration", - "params": [ - { - "name": "params", - "type": { - "name": "VerifyPasskeyRegistrationParams", - "type": "object", - "properties": [ - { - "name": "challengeId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Challenge ID from startRegistration" - } - }, - { - "name": "credential", - "type": { - "type": "nameOnly", - "name": "ServerCredentialResponse" - }, - "comment": { - "shortText": "Serialized credential from navigator.credentials.create()" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyRegistrationVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyMetadata", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Verifies a passkey registration credential against a previously issued\\nchallenge. Used as the second step of a two-step registration flow." - } - }, - "@supabase/supabase-js.GoTrueClient._refreshSession": { - "name": "@supabase/supabase-js.GoTrueClient._refreshSession", - "params": [ - { - "name": "currentSession", - "type": { - "type": "object", - "properties": [ - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - } - }, - "@supabase/supabase-js.GoTrueClient._setSession": { - "name": "@supabase/supabase-js.GoTrueClient._setSession", - "params": [ - { - "name": "currentSession", - "type": { - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - } - }, - "@supabase/supabase-js.GoTrueClient._signOut": { - "name": "@supabase/supabase-js.GoTrueClient._signOut", - "params": [ - { - "type": { - "name": "SignOut", - "type": "object", - "properties": [ - { - "name": "scope", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Determines which sessions should be\\nlogged out. Global means all\\nsessions by this account. Local\\nmeans only this session. Others\\nmeans all other sessions except the\\ncurrent one. When using others,\\nthere is no sign-out event fired on\\nthe current session!" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - } - }, - "@supabase/supabase-js.GoTrueClient._updateUser": { - "name": "@supabase/supabase-js.GoTrueClient._updateUser", - "params": [ - { - "name": "attributes", - "type": { - "type": "object", - "name": "UserAttributes", - "properties": [ - { - "name": "current_password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's current password\\n\\nThis is only ever present when the user is resetting\\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's email." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." - } - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's password." - } - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's phone." - } - } - ] - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "emailRedirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - } - }, - "@supabase/supabase-js.GoTrueClient.dispose": { - "name": "@supabase/supabase-js.GoTrueClient.dispose", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Tears down the client's background work: stops the auto-refresh interval,\\nremoves the \`visibilitychange\` listener, closes the cross-tab\\n\`BroadcastChannel\`, and clears registered \`onAuthStateChange\` subscribers.\\n\\nCall this from cleanup hooks when the client is being replaced before\\nits JS realm is destroyed. React Strict Mode and HMR are the common\\ncases. Any in-flight \`fetch\` calls continue to completion and may still\\nwrite to storage; dispose doesn't abort them or erase storage.\\n\\nLifecycle caveat: because in-flight refreshes are not aborted, a\\ndisposed instance can still persist a rotated session to storage after\\n\`dispose()\` returns. A subsequent \`createClient\` against the same\\n\`storageKey\` will pick up that session on its next read. If you need\\nstrict isolation between client lifecycles, await any pending auth\\noperation before calling \`dispose()\` (or change the \`storageKey\` for\\nthe replacement client).\\n\\nSafe to call repeatedly.", - "examples": [ - { - "id": "cleanup-on-react-unmount", - "name": "Cleanup on React unmount", - "code": "\`\`\`ts\\nuseEffect(() => {\\n const client = createClient(...)\\n return () => { client.auth.dispose() }\\n}, [])\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.exchangeCodeForSession": { - "name": "@supabase/supabase-js.GoTrueClient.exchangeCodeForSession", - "params": [ - { - "name": "authCode", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthTokenResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow.", - "text": "- Used when \`flowType\` is set to \`pkce\` in client options.", - "examples": [ - { - "id": "exchange-auth-code", - "name": "Exchange Auth Code", - "code": "\`\`\`js\\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n session: {\\n access_token: '',\\n token_type: 'bearer',\\n expires_in: 3600,\\n expires_at: 1700000000,\\n refresh_token: '',\\n user: {\\n id: '11111111-1111-1111-1111-111111111111',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com'\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\",\\n \\"\\"\\n ]\\n },\\n user_metadata: {\\n email: 'email@email.com',\\n email_verified: true,\\n full_name: 'User Name',\\n iss: '',\\n name: 'User Name',\\n phone_verified: false,\\n provider_id: '',\\n sub: ''\\n },\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n {\\n \\"identity_id\\": \\"33333333-3333-3333-3333-333333333333\\",\\n \\"id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"full_name\\": \\"User Name\\",\\n \\"iss\\": \\"\\",\\n \\"name\\": \\"User Name\\",\\n \\"phone_verified\\": false,\\n \\"provider_id\\": \\"\\",\\n \\"sub\\": \\"\\"\\n },\\n \\"provider\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false\\n },\\n provider_token: '',\\n provider_refresh_token: ''\\n },\\n user: {\\n id: '11111111-1111-1111-1111-111111111111',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {\\n provider: 'email',\\n providers: [\\n \\"email\\",\\n \\"\\"\\n ]\\n },\\n user_metadata: {\\n email: 'email@email.com',\\n email_verified: true,\\n full_name: 'User Name',\\n iss: '',\\n name: 'User Name',\\n phone_verified: false,\\n provider_id: '',\\n sub: ''\\n },\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n {\\n \\"identity_id\\": \\"33333333-3333-3333-3333-333333333333\\",\\n \\"id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"full_name\\": \\"User Name\\",\\n \\"iss\\": \\"\\",\\n \\"name\\": \\"User Name\\",\\n \\"phone_verified\\": false,\\n \\"provider_id\\": \\"\\",\\n \\"sub\\": \\"\\"\\n },\\n \\"provider\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false\\n },\\n redirectType: null\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.getClaims": { - "name": "@supabase/supabase-js.GoTrueClient.getClaims", - "params": [ - { - "name": "jwt", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "An optional specific JWT you wish to verify, not the one you\\n can obtain from #getSession." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "allowExpired", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to \`true\` the \`exp\` claim will not be validated against the current time." - } - }, - { - "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": [ - null, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." - } - }, - { - "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": [ - null, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ] - } - }, - "isOptional": true, - "comment": { - "shortText": "" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Various additional options that allow you to customize the\\n behavior of this method." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "claims", - "type": { - "type": "object", - "name": "JwtPayload", - "properties": [ - { - "name": "aal", - "type": { - "type": "union", - "name": "AuthenticatorAssuranceLevels", - "subTypes": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - null - ] - } - }, - { - "name": "amr", - "type": { - "type": "union", - "subTypes": [ - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elemType": { - "type": "object", - "name": "AMREntry", - "properties": [ - { - "name": "method", - "type": { - "type": "union", - "name": "AMRMethod", - "subTypes": [ - { - "type": "nameOnly", - "name": "['number']" - }, - null - ] - }, - "comment": { - "shortText": "Authentication method name." - } - }, - { - "name": "timestamp", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - } - ] - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Authentication Method References.\\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\\n- String format: ['password', 'otp'] - RFC-8176 compliant\\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - }, - "isOptional": true - }, - { - "name": "aud", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "exp", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "iat", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "iss", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "jti", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "nbf", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "ref", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "session_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "sub", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - }, - "isOptional": true - } - ] - } - }, - { - "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" - }, - null - ] - } - }, - { - "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": { - "shortText": "Extracts the JWT claims present in the access token by first verifying the\\nJWT against the server's JSON Web Key Set endpoint\\n\`/.well-known/jwks.json\` which is often cached, resulting in significantly\\nfaster responses. Prefer this method over #getUser which always\\nsends a request to the Auth server for each JWT.\\n\\nIf the project is not using an asymmetric JWT signing key (like ECC or\\nRSA) it always sends a request to the Auth server (similar to #getUser) to verify the JWT.", - "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\\n- A network request is sent to your project's JWT signing key discovery endpoint \`https://project-id.supabase.co/auth/v1/.well-known/jwks.json\`, which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to \`getUser()\` to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook).", - "examples": [ - { - "id": "get-jwt-claims-header-and-signature", - "name": "Get JWT claims, header and signature", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.getClaims()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"claims\\": {\\n \\"aal\\": \\"aal1\\",\\n \\"amr\\": [{\\n \\"method\\": \\"email\\",\\n \\"timestamp\\": 1715766000\\n }],\\n \\"app_metadata\\": {},\\n \\"aud\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"exp\\": 1715769600,\\n \\"iat\\": 1715766000,\\n \\"is_anonymous\\": false,\\n \\"iss\\": \\"https://project-id.supabase.co/auth/v1\\",\\n \\"phone\\": \\"+13334445555\\",\\n \\"role\\": \\"authenticated\\",\\n \\"session_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_metadata\\": {}\\n },\\n \\"header\\": {\\n \\"alg\\": \\"RS256\\",\\n \\"typ\\": \\"JWT\\",\\n \\"kid\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"signature\\": [/** Uint8Array */],\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.getSession": { - "name": "@supabase/supabase-js.GoTrueClient.getSession", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Returns the session, refreshing it if necessary.\\n\\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\\n\\n**IMPORTANT:** This method loads values directly from the storage attached\\nto the client. If that storage is based on request cookies for example,\\nthe values in it may not be authentic and therefore it's strongly advised\\nagainst using this method and its results in such circumstances. A warning\\nwill be emitted if this is detected. Use #getUser() instead.", - "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use \`getClaims()\` or \`getUser()\` instead.\\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\\n- The session contains an access token (signed JWT), a refresh token and the user object.\\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\\n- When using in a browser, or you've called \`startAutoRefresh()\` in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using \`getClaims()\` or your own JWT verification library to securely establish the user's identity and access. You can also use \`getUser()\` to fetch the user object directly from the Auth server for this purpose.\\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed.", - "examples": [ - { - "id": "get-the-session-data", - "name": "Get the session data", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.getSession()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.getUser": { - "name": "@supabase/supabase-js.GoTrueClient.getUser", - "params": [ - { - "name": "jwt", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Gets the current user details if there is an existing session. This method\\nperforms a network request to the Supabase Auth server, so the returned\\nvalue is authentic and can be used to base authorization rules on.", - "text": "- This method fetches the user object from the database instead of local session.\\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\\n- Should always be used when checking for user authorization on the server. On the client, you can instead use \`getSession().session.user\` for faster results. \`getSession\` is insecure on the server.", - "examples": [ - { - "id": "get-the-logged-in-user-with-the-current-existing-session", - "name": "Get the logged in user with the current existing session", - "code": "\`\`\`js\\nconst { data: { user } } = await supabase.auth.getUser()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "get-the-logged-in-user-with-a-custom-access-token-jwt", - "name": "Get the logged in user with a custom access token jwt", - "code": "\`\`\`js\\nconst { data: { user } } = await supabase.auth.getUser(jwt)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.getUserIdentities": { - "name": "@supabase/supabase-js.GoTrueClient.getUserIdentities", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Gets all the identities linked to a user.", - "text": "- The user needs to be signed in to call \`getUserIdentities()\`.", - "examples": [ - { - "id": "returns-a-list-of-identities-linked-to-the-user", - "name": "Returns a list of identities linked to the user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.getUserIdentities()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"2024-01-01T00:00:00Z\\",\\n \\"user_id\\": \\"2024-01-01T00:00:00Z\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ]\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.initialize": { - "name": "@supabase/supabase-js.GoTrueClient.initialize", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "name": "InitializeResult", - "type": "object", - "properties": [ - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "AuthError" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Initializes the client session either from the url or from storage.\\nThis method is automatically called when instantiating the client, but should also be called\\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - } - }, - "@supabase/supabase-js.GoTrueClient.isThrowOnErrorEnabled": { - "name": "@supabase/supabase-js.GoTrueClient.isThrowOnErrorEnabled", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Returns whether error throwing mode is enabled for this client." - } - }, - "@supabase/supabase-js.GoTrueClient.linkIdentity": { - "name": "@supabase/supabase-js.GoTrueClient.linkIdentity", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithOAuthCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "queryParams", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "An object of query params" - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - } - }, - { - "name": "scopes", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." - } - }, - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - } - ] - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - }, - "comment": { - "shortText": "One of the providers supported by GoTrue." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - } - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - } - }, - { - "name": "url", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Links an oauth identity to an existing user.\\nThis method supports the PKCE flow." - }, - "altSignatures": [ - { - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithIdTokenCredentials", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "If the ID token contains an \`at_hash\` claim, then the hash of this value is compared to the value in the ID token." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "If the ID token contains a \`nonce\` claim, then the hash of this value is compared to the value in the ID token." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - null, - null - ] - }, - "comment": { - "shortText": "Provider name or OIDC \`iss\` value identifying which provider should be used to verify the provided token. Supported names: \`google\`, \`apple\`, \`azure\`, \`facebook\`, \`kakao\`. Use the \`custom:\` prefix for custom OIDC providers (e.g. \`custom:my-oidc-provider\`)." - } - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OIDC ID token issued by the specified provider. The \`iss\` claim in the ID token must match the supplied provider. Some ID tokens contain an \`at_hash\` which require that you provide an \`access_token\` value to be accepted properly. If the token contains a \`nonce\` claim you must supply the nonce used to obtain the ID token." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthTokenResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Links an OIDC identity to an existing user." - } - } - ] - }, - "@supabase/supabase-js.GoTrueClient.onAuthStateChange": { - "name": "@supabase/supabase-js.GoTrueClient.onAuthStateChange", - "params": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED", - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "A callback function to be invoked when an auth event happens." - } - } - ], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "subscription", - "type": { - "type": "object", - "name": "Subscription", - "properties": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED", - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - } - }, - { - "name": "id", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - "comment": { - "shortText": "A unique identifier for this subscription, set by the client.\\nThis is an internal identifier used for managing callbacks and should not be\\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - }, - { - "name": "unsubscribe", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Call this to remove the listener." - } - } - ] - } - } - ] - } - } - ] - } - }, - "comment": { - "shortText": "Receive a notification every time an auth event happens.\\nSafe to use without an async function as callback." - }, - "altSignatures": [ - { - "params": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED", - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - } - }, - "comment": { - "shortText": "A callback function to be invoked when an auth event happens." - } - } - ], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "subscription", - "type": { - "type": "object", - "name": "Subscription", - "properties": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED", - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - } - }, - { - "name": "id", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - "comment": { - "shortText": "A unique identifier for this subscription, set by the client.\\nThis is an internal identifier used for managing callbacks and should not be\\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - }, - { - "name": "unsubscribe", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Call this to remove the listener." - } - } - ] - } - } - ] - } - } - ] - } - }, - "comment": { - "shortText": "Receive a notification every time an auth event happens. Common reentry\\npatterns (\`getUser\`, \`setSession\`, reading the session from inside a\\nhandler) complete normally. One hazard remains: calling \`refreshSession\`\\n(or anything that routes through \`_callRefreshToken\`) from inside a\\n\`TOKEN_REFRESHED\` handler. \`refreshingDeferred\` resolves only after\\n\`_notifyAllSubscribers\` returns, so the inner refresh dedupes onto the\\nouter's unresolved promise and the two wait on each other." - } - } - ] - }, - "@supabase/supabase-js.GoTrueClient.reauthenticate": { - "name": "@supabase/supabase-js.GoTrueClient.reauthenticate", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sends a reauthentication OTP to the user's email or phone number.\\nRequires the user to be signed-in.", - "text": "- This method is used together with \`updateUser()\` when a user's password needs to be updated.\\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\\n- After receiving the OTP, include it as the \`nonce\` in your \`updateUser()\` call to finalize the password change.", - "examples": [ - { - "id": "send-reauthentication-nonce", - "name": "Send reauthentication nonce", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.reauthenticate()\\n\`\`\`", - "description": "Sends a reauthentication nonce to the user's email or phone number." - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.refreshSession": { - "name": "@supabase/supabase-js.GoTrueClient.refreshSession", - "params": [ - { - "name": "currentSession", - "type": { - "type": "object", - "properties": [ - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The current session. If passed in, it must contain a refresh token." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Returns a new session, regardless of expiry status.\\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\\nIf the current session's refresh token is invalid, an error will be thrown.", - "text": "- This method will refresh and return a new session whether the current one is expired or not.", - "examples": [ - { - "id": "refresh-session-using-the-current-session", - "name": "Refresh session using the current session", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.refreshSession()\\nconst { session, user } = data\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "refresh-session-using-a-refresh-token", - "name": "Refresh session using a refresh token", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\\nconst { session, user } = data\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.registerPasskey": { - "name": "@supabase/supabase-js.GoTrueClient.registerPasskey", - "params": [ - { - "name": "credentials", - "type": { - "name": "RegisterPasskeyCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyRegistrationVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyMetadata", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Register a passkey for the current authenticated user. Handles the full WebAuthn ceremony:\\n1. Fetches registration challenge from server\\n2. Prompts user via navigator.credentials.create()\\n3. Verifies credential with server\\n\\nRequires an active session. Requires \`auth.experimental.passkey: true\`." - } - }, - "@supabase/supabase-js.GoTrueClient.resend": { - "name": "@supabase/supabase-js.GoTrueClient.resend", - "params": [ - { - "name": "credentials", - "type": { - "type": "union", - "name": "ResendParams", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "emailRedirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they have signed-in." - } - } - ] - }, - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOtpResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "messageId", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true - }, - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "messageId", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP.", - "text": "- Resends a signup confirmation, email change or phone change email to the user.\\n- Passwordless sign-ins can be resent by calling the \`signInWithOtp()\` method again.\\n- Password recovery emails can be resent by calling the \`resetPasswordForEmail()\` method again.\\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use \`signInWithOtp()\` again to resend the OTP).\\n- You can specify a redirect url when you resend an email link using the \`emailRedirectTo\` option.", - "examples": [ - { - "id": "resend-an-email-signup-confirmation", - "name": "Resend an email signup confirmation", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.resend({\\n type: 'signup',\\n email: 'email@example.com',\\n options: {\\n emailRedirectTo: 'https://example.com/welcome'\\n }\\n})\\n\`\`\`", - "description": "Resends the email signup confirmation to the user" - }, - { - "id": "resend-a-phone-signup-confirmation", - "name": "Resend a phone signup confirmation", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.resend({\\n type: 'sms',\\n phone: '1234567890'\\n})\\n\`\`\`", - "description": "Resends the phone signup confirmation email to the user" - }, - { - "id": "resend-email-change-email", - "name": "Resend email change email", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.resend({\\n type: 'email_change',\\n email: 'email@example.com'\\n})\\n\`\`\`", - "description": "Resends the email change email to the user" - }, - { - "id": "resend-phone-change-otp", - "name": "Resend phone change OTP", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.resend({\\n type: 'phone_change',\\n phone: '1234567890'\\n})\\n\`\`\`", - "description": "Resends the phone change OTP to the user" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.resetPasswordForEmail": { - "name": "@supabase/supabase-js.GoTrueClient.resetPasswordForEmail", - "params": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The email address of the user." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The URL to send the user to after they click the password reset link." - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sends a password reset request to an email address. This method supports the PKCE flow.", - "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\\n- The \`resetPasswordForEmail()\` only sends a password reset link to the user's email.\\nTo update the user's password, see [\`updateUser()\`](/docs/reference/javascript/auth-updateuser).\\n- A \`PASSWORD_RECOVERY\` event will be emitted when the password recovery link is clicked.\\nYou can use [\`onAuthStateChange()\`](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\\n- When the user clicks the reset link in the email they are redirected back to your application.\\nYou can configure the URL that the user is redirected to with the \`redirectTo\` parameter.\\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\\n- After the user has been redirected successfully, prompt them for a new password and call \`updateUser()\`:\\n\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n password: new_password\\n})\\n\`\`\`", - "examples": [ - { - "id": "reset-password", - "name": "Reset password", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\\n redirectTo: 'https://example.com/update-password',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {}\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "reset-password-react", - "name": "Reset password (React)", - "code": "\`\`\`js\\n/**\\n * Step 1: Send the user an email to get a password reset token.\\n * This email contains a link which sends the user back to your application.\\n */\\nconst { data, error } = await supabase.auth\\n .resetPasswordForEmail('user@email.com')\\n\\n/**\\n * Step 2: Once the user is redirected back to your application,\\n * ask the user to reset their password.\\n */\\n useEffect(() => {\\n supabase.auth.onAuthStateChange(async (event, session) => {\\n if (event == \\"PASSWORD_RECOVERY\\") {\\n const newPassword = prompt(\\"What would you like your new password to be?\\");\\n const { data, error } = await supabase.auth\\n .updateUser({ password: newPassword })\\n\\n if (data) alert(\\"Password updated successfully!\\")\\n if (error) alert(\\"There was an error updating your password.\\")\\n }\\n })\\n }, [])\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.setSession": { - "name": "@supabase/supabase-js.GoTrueClient.setSession", - "params": [ - { - "name": "currentSession", - "type": { - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "comment": { - "shortText": "The current session that minimally contains an access token and refresh token." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\\nIf the refresh token or access token in the current session is invalid, an error will be thrown.", - "text": "- This method sets the session using an \`access_token\` and \`refresh_token\`.\\n- If successful, a \`SIGNED_IN\` event is emitted.", - "examples": [ - { - "id": "set-the-session", - "name": "Set the session", - "code": "\`\`\`js\\n const { data, error } = await supabase.auth.setSession({\\n access_token,\\n refresh_token\\n })\\n\`\`\`", - "description": "Sets the session data from an access_token and refresh_token, then returns an auth response or error.", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"2024-01-01T00:00:00Z\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n },\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3500,\\n \\"expires_at\\": 1700000000\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signInAnonymously": { - "name": "@supabase/supabase-js.GoTrueClient.signInAnonymously", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInAnonymouslyCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new anonymous user.", - "text": "- Returns an anonymous user\\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the \`options\` param.", - "examples": [ - { - "id": "create-an-anonymous-user", - "name": "Create an anonymous user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInAnonymously({\\n options: {\\n captchaToken\\n }\\n});\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {},\\n \\"user_metadata\\": {},\\n \\"identities\\": [],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": true\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {},\\n \\"user_metadata\\": {},\\n \\"identities\\": [],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": true\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "create-an-anonymous-user-with-custom-user-metadata", - "name": "Create an anonymous user with custom user metadata", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInAnonymously({\\n options: {\\n data\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signInWithIdToken": { - "name": "@supabase/supabase-js.GoTrueClient.signInWithIdToken", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithIdTokenCredentials", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "If the ID token contains an \`at_hash\` claim, then the hash of this value is compared to the value in the ID token." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "If the ID token contains a \`nonce\` claim, then the hash of this value is compared to the value in the ID token." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - null, - null - ] - }, - "comment": { - "shortText": "Provider name or OIDC \`iss\` value identifying which provider should be used to verify the provided token. Supported names: \`google\`, \`apple\`, \`azure\`, \`facebook\`, \`kakao\`. Use the \`custom:\` prefix for custom OIDC providers (e.g. \`custom:my-oidc-provider\`)." - } - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OIDC ID token issued by the specified provider. The \`iss\` claim in the ID token must match the supplied provider. Some ID tokens contain an \`at_hash\` which require that you provide an \`access_token\` value to be accepted properly. If the token contains a \`nonce\` claim you must supply the nonce used to obtain the ID token." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthTokenResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Allows signing in with an OIDC ID token. The authentication provider used\\nshould be enabled and configured.", - "text": "- Use an ID token to sign in.\\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API.", - "examples": [ - { - "id": "sign-in-using-id-token", - "name": "Sign In using ID Token", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithIdToken({\\n provider: 'google',\\n token: 'your-id-token'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n ...\\n },\\n \\"user_metadata\\": {\\n ...\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"provider\\": \\"google\\",\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n ...\\n },\\n \\"user_metadata\\": {\\n ...\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"provider\\": \\"google\\",\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signInWithOAuth": { - "name": "@supabase/supabase-js.GoTrueClient.signInWithOAuth", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithOAuthCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "queryParams", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "An object of query params" - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - } - }, - { - "name": "scopes", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." - } - }, - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - } - ] - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - }, - "comment": { - "shortText": "One of the providers supported by GoTrue." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - } - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - } - }, - { - "name": "url", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in an existing user via a third-party provider.\\nThis method supports the PKCE flow.", - "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app.", - "examples": [ - { - "id": "sign-in-using-a-third-party-provider", - "name": "Sign in using a third-party provider", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOAuth({\\n provider: 'github'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n provider: 'github',\\n url: \\n },\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "sign-in-using-a-third-party-provider-with-redirect", - "name": "Sign in using a third-party provider with redirect", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOAuth({\\n provider: 'github',\\n options: {\\n redirectTo: 'https://example.com/welcome'\\n }\\n})\\n\`\`\`", - "description": "- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the \`redirectTo\` parameter. This parameter defaults to the [\`SITE_URL\`](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - }, - { - "id": "sign-in-with-scopes-and-access-provider-tokens", - "name": "Sign in with scopes and access provider tokens", - "code": "\`\`\`js\\n// Register this immediately after calling createClient!\\n// Because signInWithOAuth causes a redirect, you need to fetch the\\n// provider tokens from the callback.\\nsupabase.auth.onAuthStateChange((event, session) => {\\n if (session && session.provider_token) {\\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\\n }\\n\\n if (session && session.provider_refresh_token) {\\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\\n }\\n\\n if (event === 'SIGNED_OUT') {\\n window.localStorage.removeItem('oauth_provider_token')\\n window.localStorage.removeItem('oauth_provider_refresh_token')\\n }\\n})\\n\\n// Call this on your Sign in with GitHub button to initiate OAuth\\n// with GitHub with the requested elevated scopes.\\nawait supabase.auth.signInWithOAuth({\\n provider: 'github',\\n options: {\\n scopes: 'repo gist notifications'\\n }\\n})\\n\`\`\`", - "description": "If you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the \`scopes\` option takes in **a space-separated list** of scopes.\\n\\nBecause OAuth sign-in often includes redirects, you should register an \`onAuthStateChange\` callback immediately after you create the Supabase client. This callback will listen for the presence of \`provider_token\` and \`provider_refresh_token\` properties on the \`session\` object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\\n\\nFinally, make sure you remove them from local storage on the \`SIGNED_OUT\` event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signInWithOtp": { - "name": "@supabase/supabase-js.GoTrueClient.signInWithOtp", - "params": [ - { - "name": "credentials", - "type": { - "type": "union", - "name": "SignInWithPasswordlessCredentials", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email address." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - }, - { - "name": "emailRedirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The redirect url embedded in the email link" - } - }, - { - "name": "shouldCreateUser", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - } - } - ] - }, - "isOptional": true - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "channel", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - }, - { - "name": "shouldCreateUser", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - } - } - ] - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's phone number." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOtpResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "messageId", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true - }, - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "messageId", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).\\n\\nIf 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.", - "text": "- Requires either an email or phone number.\\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\\n- If the user doesn't exist, \`signInWithOtp()\` will signup the user instead. To restrict this behavior, you can set \`shouldCreateUser\` in \`SignInWithPasswordlessCredentials.options\` to \`false\`.\\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\\n- If you're using phone, you can configure whether you want the user to receive a OTP.\\n- The magic link's destination URL is determined by the [\`SITE_URL\`](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include \`{{ .Token }}\` instead of \`{{ .ConfirmationURL }}\`.\\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in.", - "examples": [ - { - "id": "sign-in-with-email", - "name": "Sign in with email", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOtp({\\n email: 'example@email.com',\\n options: {\\n emailRedirectTo: 'https://example.com/welcome'\\n }\\n})\\n\`\`\`", - "description": "The user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds.", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": null,\\n \\"session\\": null\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "sign-in-with-sms-otp", - "name": "Sign in with SMS OTP", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOtp({\\n phone: '+13334445555',\\n})\\n\`\`\`", - "description": "The user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." - }, - { - "id": "sign-in-with-whatsapp-otp", - "name": "Sign in with WhatsApp OTP", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOtp({\\n phone: '+13334445555',\\n options: {\\n channel:'whatsapp',\\n }\\n})\\n\`\`\`", - "description": "The user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signInWithPasskey": { - "name": "@supabase/supabase-js.GoTrueClient.signInWithPasskey", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithPasskeyCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyAuthenticationVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sign in with a passkey. Handles the full WebAuthn ceremony:\\n1. Fetches authentication challenge from server\\n2. Prompts user via navigator.credentials.get()\\n3. Verifies credential with server and creates session\\n\\nRequires \`auth.experimental.passkey: true\`." - } - }, - "@supabase/supabase-js.GoTrueClient.signInWithPassword": { - "name": "@supabase/supabase-js.GoTrueClient.signInWithPassword", - "params": [ - { - "name": "credentials", - "type": { - "type": "nameOnly", - "name": "SignInWithPasswordCredentials" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthTokenResponsePassword", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - }, - { - "name": "weakPassword", - "type": { - "name": "WeakPassword", - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "reasons", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "WeakPasswordReasons" - } - } - } - ] - }, - "isOptional": true - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "weakPassword", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in an existing user with an email and password or phone and password.\\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\\nemail/phone and password combination is wrong or that the account can only\\nbe accessed via social login.", - "text": "- Requires either an email and password or a phone number and password.", - "examples": [ - { - "id": "sign-in-with-email-and-password", - "name": "Sign in with email and password", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n email: 'example@email.com',\\n password: 'example-password',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "sign-in-with-phone-and-password", - "name": "Sign in with phone and password", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n phone: '+13334445555',\\n password: 'some-password',\\n})\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n email: 'example@email.com',\\n password: 'example-password',\\n})\\nif (error) {\\n console.error(error)\\n return\\n}\\n\`\`\`", - "description": "Log the full \`error\` object so fields like \`code\`, \`status\`, and \`name\` aren't hidden. The \`error.code\` (e.g. \`'invalid_credentials'\`, \`'email_not_confirmed'\`) is often more useful for branching than \`error.message\`, and the full object surfaces both." - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signInWithSSO": { - "name": "@supabase/supabase-js.GoTrueClient.signInWithSSO", - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "SignInWithSSO", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they have signed-in." - } - }, - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to true, the redirect will not happen on the client side.\\nThis parameter is used when you wish to handle the redirect yourself.\\nDefaults to false." - } - } - ] - }, - "isOptional": true - }, - { - "name": "providerId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "UUID of the SSO provider to invoke single-sign on to." - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "domain", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Domain name of the organization for which to invoke single-sign on." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they have signed-in." - } - }, - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to true, the redirect will not happen on the client side.\\nThis parameter is used when you wish to handle the redirect yourself.\\nDefaults to false." - } - } - ] - }, - "isOptional": true - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "SSOResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL to open in a browser which will complete the sign-in flow by\\ntaking the user to the identity provider's authentication flow.\\n\\nOn browsers you can set the URL to \`window.location.href\` to take\\nthe user to the authentication flow." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\\nsuccessful SSO attempt will redirect the current page to the identity\\nprovider authorization page. The redirect URL is implementation and SSO\\nprotocol specific.\\n\\nYou can use it by providing a SSO domain. Typically you can extract this\\ndomain by asking users for their email address. If this domain is\\nregistered on the Auth instance the redirect will use that organization's\\ncurrently active SSO Identity Provider for the login.\\n\\nIf you have built an organization-specific login page, you can use the\\norganization's SSO Identity Provider UUID directly instead.", - "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\\n- If you've associated an email domain to the identity provider, you can use the \`domain\` property to start a sign-in flow.\\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the \`providerId\` property. For example:\\n - Mapping specific user email addresses with an identity provider.\\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information.", - "examples": [ - { - "id": "sign-in-with-email-domain", - "name": "Sign in with email domain", - "code": "\`\`\`js\\n // You can extract the user's email domain and use it to trigger the\\n // authentication flow with the correct identity provider.\\n\\n const { data, error } = await supabase.auth.signInWithSSO({\\n domain: 'company.com'\\n })\\n\\n if (data?.url) {\\n // redirect the user to the identity provider's authentication flow\\n window.location.href = data.url\\n }\\n\`\`\`" - }, - { - "id": "sign-in-with-provider-uuid", - "name": "Sign in with provider UUID", - "code": "\`\`\`js\\n // Useful when you need to map a user's sign in request according\\n // to different rules that can't use email domains.\\n\\n const { data, error } = await supabase.auth.signInWithSSO({\\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\\n })\\n\\n if (data?.url) {\\n // redirect the user to the identity provider's authentication flow\\n window.location.href = data.url\\n }\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signInWithWeb3": { - "name": "@supabase/supabase-js.GoTrueClient.signInWithWeb3", - "params": [ - { - "name": "credentials", - "type": { - "type": "union", - "name": "Web3Credentials", - "subTypes": [ - { - "type": "union", - "name": "SolanaWeb3Credentials", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "chain", - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "signInWithSolana", - "type": { - "type": "nameOnly", - "name": "Partial" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - } - ] - }, - "isOptional": true - }, - { - "name": "statement", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - }, - { - "name": "wallet", - "type": { - "name": "SolanaWallet", - "type": "object", - "properties": [ - { - "name": "publicKey", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "toBase58", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true - }, - { - "name": "signIn", - "type": { - "type": "function", - "params": [ - { - "name": "inputs", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "SolanaSignInInput" - } - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "SolanaSignInOutput" - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "SolanaSignInOutput" - } - } - ] - } - } - } - }, - "isOptional": true - }, - { - "name": "signMessage", - "type": { - "type": "function", - "params": [ - { - "name": "message", - "type": { - "type": "nameOnly", - "name": "Uint8Array" - } - }, - { - "name": "encoding", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "utf8" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Uint8Array" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } - } - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Wallet interface to use. If not specified will default to \`window.solana\`." - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "chain", - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Sign in with Solana compatible message. Must include \`Issued At\`, \`URI\` and \`Version\`." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "signature", - "type": { - "type": "nameOnly", - "name": "Uint8Array" - }, - "comment": { - "shortText": "Ed25519 signature of the message." - } - } - ] - } - ] - }, - { - "type": "union", - "name": "EthereumWeb3Credentials", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "chain", - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "signInWithEthereum", - "type": { - "type": "nameOnly", - "name": "Partial" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - } - ] - }, - "isOptional": true - }, - { - "name": "statement", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - }, - { - "name": "wallet", - "type": { - "type": "nameOnly", - "name": "EthereumWallet" - }, - "isOptional": true, - "comment": { - "shortText": "Wallet interface to use. If not specified will default to \`window.ethereum\`." - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "chain", - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include \`Issued At\`, \`URI\` and \`Version\`." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "signature", - "type": { - "type": "nameOnly", - "name": "Hex" - }, - "comment": { - "shortText": "Ethereum curve (secp256k1) signature of the message." - } - } - ] - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Signs in a user by verifying a message signed by the user's private key.\\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\\nboth of which derive from the EIP-4361 standard\\nWith slight variation on Solana's side.", - "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it.", - "examples": [ - { - "id": "sign-in-with-solana-or-ethereum-window-api", - "name": "Sign in with Solana or Ethereum (Window API)", - "code": "\`\`\`js\\n // uses window.ethereum for the wallet\\n const { data, error } = await supabase.auth.signInWithWeb3({\\n chain: 'ethereum',\\n statement: 'I accept the Terms of Service at https://example.com/tos'\\n })\\n\\n // uses window.solana for the wallet\\n const { data, error } = await supabase.auth.signInWithWeb3({\\n chain: 'solana',\\n statement: 'I accept the Terms of Service at https://example.com/tos'\\n })\\n\`\`\`" - }, - { - "id": "sign-in-with-ethereum-message-and-signature", - "name": "Sign in with Ethereum (Message and Signature)", - "code": "\`\`\`js\\n const { data, error } = await supabase.auth.signInWithWeb3({\\n chain: 'ethereum',\\n message: '',\\n signature: '',\\n })\\n\`\`\`" - }, - { - "id": "sign-in-with-solana-brave", - "name": "Sign in with Solana (Brave)", - "code": "\`\`\`js\\n const { data, error } = await supabase.auth.signInWithWeb3({\\n chain: 'solana',\\n statement: 'I accept the Terms of Service at https://example.com/tos',\\n wallet: window.braveSolana\\n })\\n\`\`\`" - }, - { - "id": "sign-in-with-solana-wallet-adapter", - "name": "Sign in with Solana (Wallet Adapter)", - "code": "\`\`\`jsx\\n function SignInButton() {\\n const wallet = useWallet()\\n\\n return (\\n <>\\n {wallet.connected ? (\\n {\\n supabase.auth.signInWithWeb3({\\n chain: 'solana',\\n statement: 'I accept the Terms of Service at https://example.com/tos',\\n wallet,\\n })\\n }}\\n >\\n Sign in with Solana\\n \\n ) : (\\n \\n )}\\n \\n )\\n}\\n\\nfunction App() {\\n const endpoint = clusterApiUrl('devnet')\\n const wallets = useMemo(() => [], [])\\n\\n return (\\n \\n \\n \\n \\n \\n \\n \\n )\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signOut": { - "name": "@supabase/supabase-js.GoTrueClient.signOut", - "params": [ - { - "name": "options", - "type": { - "name": "SignOut", - "type": "object", - "properties": [ - { - "name": "scope", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Determines which sessions should be\\nlogged out. Global means all\\nsessions by this account. Local\\nmeans only this session. Others\\nmeans all other sessions except the\\ncurrent one. When using others,\\nthere is no sign-out event fired on\\nthe current session!" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Inside a browser context, \`signOut()\` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a \`\\"SIGNED_OUT\\"\` event.\\n\\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to \`auth.api.signOut(JWT: string)\`.\\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\\n\\nIf using \`others\` scope, no \`SIGNED_OUT\` event is fired!\\n\\n**Warning:** the default \`scope\` is \`'global'\`. This signs the user out of\\n**every device they are currently signed in on**, not just the current\\ntab/session. If you only want to sign the user out of the current session\\n(the behavior most other auth libraries default to), pass\\n\`{ scope: 'local' }\` explicitly.", - "text": "- In order to use the \`signOut()\` method, the user needs to be signed in first.\\n- By default, \`signOut()\` uses the **global** scope, which signs out the user\\n on every device they are signed in on (not just the current one). Pass\\n \`{ scope: 'local' }\` to only sign out the current session. This is\\n usually what apps want on a \\"Sign out\\" button, especially when users\\n sign in from multiple devices and do not expect signing out of one to\\n terminate the others.\\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires.", - "examples": [ - { - "id": "sign-out-of-every-device-global-default", - "name": "Sign out of every device (global – default)", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.signOut()\\n\`\`\`" - }, - { - "id": "sign-out-only-the-current-session-recommended-for-most-apps", - "name": "Sign out only the current session (recommended for most apps)", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\\n\`\`\`" - }, - { - "id": "sign-out-of-all-other-sessions-keep-the-current-one", - "name": "Sign out of all other sessions, keep the current one", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.signUp": { - "name": "@supabase/supabase-js.GoTrueClient.signUp", - "params": [ - { - "name": "credentials", - "type": { - "type": "nameOnly", - "name": "SignUpWithPasswordCredentials" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new user.\\n\\nBe aware that if a user account exists in the system you may get back an\\nerror message that attempts to hide this information from the user.\\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.", - "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\\n- **Confirm email** determines if users need to confirm their email address after signing up.\\n - If **Confirm email** is enabled, a \`user\` is returned but \`session\` is null.\\n - If **Confirm email** is disabled, both a \`user\` and a \`session\` are returned.\\n- When the user confirms their email address, they are redirected to the [\`SITE_URL\`](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your \`SITE_URL\` or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\\n- If signUp() is called for an existing confirmed user:\\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, \`User already registered\` is returned.\\n- To fetch the currently logged-in user, refer to [\`getUser()\`](/docs/reference/javascript/auth-getuser).", - "examples": [ - { - "id": "sign-up-with-an-email-and-password", - "name": "Sign up with an email and password", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp({\\n email: 'example@email.com',\\n password: 'example-password',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n// Some fields may be null if \\"confirm email\\" is enabled.\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "sign-up-with-a-phone-number-and-password-sms", - "name": "Sign up with a phone number and password (SMS)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp({\\n phone: '123456789',\\n password: 'example-password',\\n options: {\\n channel: 'sms'\\n }\\n})\\n\`\`\`" - }, - { - "id": "sign-up-with-a-phone-number-and-password-whatsapp", - "name": "Sign up with a phone number and password (whatsapp)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp({\\n phone: '123456789',\\n password: 'example-password',\\n options: {\\n channel: 'whatsapp'\\n }\\n})\\n\`\`\`", - "description": "The user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - }, - { - "id": "sign-up-with-additional-user-metadata", - "name": "Sign up with additional user metadata", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp(\\n {\\n email: 'example@email.com',\\n password: 'example-password',\\n options: {\\n data: {\\n first_name: 'John',\\n age: 27,\\n }\\n }\\n }\\n)\\n\`\`\`" - }, - { - "id": "sign-up-with-a-redirect-url", - "name": "Sign up with a redirect URL", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp(\\n {\\n email: 'example@email.com',\\n password: 'example-password',\\n options: {\\n emailRedirectTo: 'https://example.com/welcome'\\n }\\n }\\n)\\n\`\`\`", - "description": "- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.startAutoRefresh": { - "name": "@supabase/supabase-js.GoTrueClient.startAutoRefresh", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Starts an auto-refresh process in the background. The session is checked\\nevery few seconds. Close to the time of expiration a process is started to\\nrefresh the session. If refreshing fails it will be retried for as long as\\nnecessary.\\n\\nIf you set the GoTrueClientOptions#autoRefreshToken you don't need\\nto call this function, it will be called for you.\\n\\nOn browsers the refresh process works only when the tab/window is in the\\nforeground to conserve resources as well as prevent race conditions and\\nflooding auth with requests. If you call this method any managed\\nvisibility change callback will be removed and you must manage visibility\\nchanges on your own.\\n\\nOn non-browser platforms the refresh process works *continuously* in the\\nbackground, which may not be desirable. You should hook into your\\nplatform's foreground indication mechanism and call these methods\\nappropriately to conserve resources.\\n\\n#stopAutoRefresh", - "text": "- Only useful in non-browser environments such as React Native or Electron.\\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\\n- To give this hint to the application, you should be calling this method when the app is in focus and calling \`supabase.auth.stopAutoRefresh()\` when it's out of focus.", - "examples": [ - { - "id": "start-and-stop-auto-refresh-in-react-native", - "name": "Start and stop auto refresh in React Native", - "code": "\`\`\`js\\nimport { AppState } from 'react-native'\\n\\n// make sure you register this only once!\\nAppState.addEventListener('change', (state) => {\\n if (state === 'active') {\\n supabase.auth.startAutoRefresh()\\n } else {\\n supabase.auth.stopAutoRefresh()\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.stopAutoRefresh": { - "name": "@supabase/supabase-js.GoTrueClient.stopAutoRefresh", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Stops an active auto refresh process running in the background (if any).\\n\\nIf you call this method any managed visibility change callback will be\\nremoved and you must manage visibility changes on your own.\\n\\nSee #startAutoRefresh for more details.", - "text": "- Only useful in non-browser environments such as React Native or Electron.\\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session.", - "examples": [ - { - "id": "start-and-stop-auto-refresh-in-react-native", - "name": "Start and stop auto refresh in React Native", - "code": "\`\`\`js\\nimport { AppState } from 'react-native'\\n\\n// make sure you register this only once!\\nAppState.addEventListener('change', (state) => {\\n if (state === 'active') {\\n supabase.auth.startAutoRefresh()\\n } else {\\n supabase.auth.stopAutoRefresh()\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.unlinkIdentity": { - "name": "@supabase/supabase-js.GoTrueClient.unlinkIdentity", - "params": [ - { - "name": "identity", - "type": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked.", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\\n- The user needs to be signed in to call \`unlinkIdentity()\`.\\n- The user must have at least 2 identities in order to unlink an identity.\\n- The identity to be unlinked must belong to the user.", - "examples": [ - { - "id": "unlink-an-identity", - "name": "Unlink an identity", - "code": "\`\`\`js\\n// retrieve all identities linked to a user\\nconst identities = await supabase.auth.getUserIdentities()\\n\\n// find the google identity\\nconst googleIdentity = identities.find(\\n identity => identity.provider === 'google'\\n)\\n\\n// unlink the google identity\\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.updateUser": { - "name": "@supabase/supabase-js.GoTrueClient.updateUser", - "params": [ - { - "name": "attributes", - "type": { - "type": "object", - "name": "UserAttributes", - "properties": [ - { - "name": "current_password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's current password\\n\\nThis is only ever present when the user is resetting\\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's email." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." - } - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's password." - } - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's phone." - } - } - ] - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "emailRedirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates user data for a logged in user.", - "text": "- In order to use the \`updateUser()\` method, the user needs to be signed in first.\\n- By default, email updates sends a confirmation link to both the user's current and new email.\\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers).", - "examples": [ - { - "id": "update-the-email-for-an-authenticated-user", - "name": "Update the email for an authenticated user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n email: 'new@email.com'\\n})\\n\`\`\`", - "description": "Sends a \\"Confirm Email Change\\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email).", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"new_email\\": \\"new@email.com\\",\\n \\"email_change_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "update-the-phone-number-for-an-authenticated-user", - "name": "Update the phone number for an authenticated user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n phone: '123456789'\\n})\\n\`\`\`", - "description": "Sends a one-time password (OTP) to the new phone number." - }, - { - "id": "update-the-password-for-an-authenticated-user", - "name": "Update the password for an authenticated user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n password: 'new password'\\n})\\n\`\`\`" - }, - { - "id": "update-the-user-s-metadata", - "name": "Update the user's metadata", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n data: { hello: 'world' }\\n})\\n\`\`\`", - "description": "Updates the user's custom metadata.\\n\\n**Note**: The \`data\` field maps to the \`auth.users.raw_user_meta_data\` column in your Supabase database. When calling \`getUser()\`, the data will be available as \`user.user_metadata\`." - }, - { - "id": "update-the-user-s-password-with-a-nonce", - "name": "Update the user's password with a nonce", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n password: 'new password',\\n nonce: '123456'\\n})\\n\`\`\`", - "description": "If **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." - } - ] - } - }, - "@supabase/supabase-js.GoTrueClient.verifyOtp": { - "name": "@supabase/supabase-js.GoTrueClient.verifyOtp", - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "VerifyOtpParams", - "subTypes": [ - { - "type": "object", - "name": "VerifyMobileOtpParams", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - } - } - ] - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's phone number." - } - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The otp sent to the user's phone number." - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "MobileOtpType", - "subTypes": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - }, - null - ] - }, - "comment": { - "shortText": "The user's verification type." - } - } - ] - }, - { - "type": "object", - "name": "VerifyEmailOtpParams", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email address." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - } - } - ] - }, - "isOptional": true - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The otp sent to the user's email address." - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "EmailOtpType", - "subTypes": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - null - ] - }, - "comment": { - "shortText": "The user's verification type." - } - } - ] - }, - { - "type": "object", - "name": "VerifyTokenHashParams", - "properties": [ - { - "name": "token_hash", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The token hash used in an email link" - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "EmailOtpType", - "subTypes": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - null - ] - }, - "comment": { - "shortText": "The user's verification type." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthSession", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "AuthUser", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in a user given a User supplied OTP or TokenHash received through mobile or email.", - "text": "- The \`verifyOtp\` method takes in different verification types.\\n- If a phone number is used, the type can either be:\\n 1. \`sms\` – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\\n 2. \`phone_change\` – Used when verifying an OTP sent to a new phone number during a phone number update process.\\n- If an email address is used, the type can be one of the following (note: \`signup\` and \`magiclink\` types are deprecated):\\n 1. \`email\` – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\\n 2. \`recovery\` – Used when verifying an OTP sent for account recovery, typically after a password reset request.\\n 3. \`invite\` – Used when verifying an OTP sent as part of an invitation to join a project or organization.\\n 4. \`email_change\` – Used when verifying an OTP sent to a new email address during an email update process.\\n- The verification type used should be determined based on the corresponding auth method called before \`verifyOtp\` to sign up / sign-in a user.\\n- The \`TokenHash\` is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details.", - "examples": [ - { - "id": "verify-signup-one-time-password-otp", - "name": "Verify Signup One-Time Password (OTP)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"recovery_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"recovery_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "verify-sms-one-time-password-otp", - "name": "Verify SMS One-Time Password (OTP)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\\n\`\`\`" - }, - { - "id": "verify-email-auth-token-hash", - "name": "Verify Email Auth (Token Hash)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.NavigatorLockAcquireTimeoutError.constructor": { - "name": "@supabase/supabase-js.NavigatorLockAcquireTimeoutError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "NavigatorLockAcquireTimeoutError" - } - } - }, - "@supabase/supabase-js.PostgrestBuilder.constructor": { - "name": "@supabase/supabase-js.PostgrestBuilder.constructor", - "params": [ - { - "name": "builder", - "type": { - "type": "object", - "properties": [ - { - "name": "body", - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - } - }, - { - "name": "isMaybeSingle", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "method", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "shouldStripNulls", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "shouldThrowOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Creates a builder configured for a specific PostgREST request.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('users').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\\n\\nconst builder = new PostgrestQueryBuilder(\\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestBuilder.overrideTypes": { - "name": "@supabase/supabase-js.PostgrestBuilder.overrideTypes", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`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\`\`\`" - }, - { - "id": "complete-override-type-of-successful-response", - "name": "Complete Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes, { merge: false }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "complete-override-type-of-object-response", - "name": "Complete Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType | null\\n\`\`\`" - }, - { - "id": "partial-override-type-of-successful-response", - "name": "Partial Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // Array\\n\`\`\`" - }, - { - "id": "partial-override-type-of-object-response", - "name": "Partial Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes<{ status: \\"A\\" | \\"B\\" }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // CountryRowProperties & { status: \\"A\\" | \\"B\\" } | null\\n\`\`\`" - }, - { - "id": "merge-vs-replace-existing-types", - "name": "Merge vs replace existing types", - "code": "\`\`\`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/supabase-js.PostgrestBuilder.retry": { - "name": "@supabase/supabase-js.PostgrestBuilder.retry", - "params": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "Whether to enable retries for this request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\n// Disable retries for a specific query\\nconst { data, error } = await supabase\\n .from('users')\\n .select()\\n .retry(false)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestBuilder.returns": { - "name": "@supabase/supabase-js.PostgrestBuilder.returns", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\`." - } - }, - "@supabase/supabase-js.PostgrestBuilder.setHeader": { - "name": "@supabase/supabase-js.PostgrestBuilder.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request." - } - }, - "@supabase/supabase-js.PostgrestBuilder.stripNulls": { - "name": "@supabase/supabase-js.PostgrestBuilder.stripNulls", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Strip null values from the response data. Properties with \`null\` values\\nwill be omitted from the returned JSON objects.\\n\\nRequires PostgREST 11.2.0+.\\n\\nhttps://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .stripNulls()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text, bio text);\\n\\ninsert into\\n characters (id, name, bio)\\nvalues\\n (1, 'Luke', null),\\n (2, 'Leia', 'Princess of Alderaan');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\",\\n \\"bio\\": \\"Princess of Alderaan\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestBuilder.then": { - "name": "@supabase/supabase-js.PostgrestBuilder.then", - "params": [ - { - "name": "onfulfilled", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "value" - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is resolved." - } - }, - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult2" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PromiseLike" - } - }, - "comment": { - "shortText": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - }, - "@supabase/supabase-js.PostgrestBuilder.throwOnError": { - "name": "@supabase/supabase-js.PostgrestBuilder.throwOnError", - "params": [], - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" - } - }, - "@supabase/supabase-js.PostgrestError.constructor": { - "name": "@supabase/supabase-js.PostgrestError.constructor", - "params": [ - { - "name": "context", - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "details", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "hint", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestError" - } - }, - "comment": { - "shortText": "", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\nimport PostgrestError from '@supabase/postgrest-js'\\n\\nthrow new PostgrestError({\\n message: 'Row level security prevented the request',\\n details: 'RLS denied the insert',\\n hint: 'Check your policies',\\n code: 'PGRST301',\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestError.toJSON": { - "name": "@supabase/supabase-js.PostgrestError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "details", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "hint", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.constructor": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.constructor", - "params": [ - { - "name": "builder", - "type": { - "type": "object", - "properties": [ - { - "name": "body", - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - } - }, - { - "name": "isMaybeSingle", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "method", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "shouldStripNulls", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "shouldThrowOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Creates a builder configured for a specific PostgREST request.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('users').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\\n\\nconst builder = new PostgrestQueryBuilder(\\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.abortSignal": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.abortSignal", - "params": [ - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "comment": { - "shortText": "The AbortSignal to use for the fetch request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set the AbortSignal for the fetch request.", - "text": "You can use this to set a timeout for the request.", - "examples": [ - { - "id": "aborting-requests-in-flight", - "name": "Aborting requests in-flight", - "code": "\`\`\`ts\\nconst ac = new AbortController()\\n\\nconst { data, error } = await supabase\\n .from('very_big_table')\\n .select()\\n .abortSignal(ac.signal)\\n\\n// Abort the request after 100 ms\\nsetTimeout(() => ac.abort(), 100)\\n\`\`\`", - "description": "You can use an [\`AbortController\`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\\nNote that \`status\` and \`statusText\` don't mean anything for aborted requests as the request wasn't fulfilled.", - "response": "\`\`\`json\\n {\\n \\"error\\": {\\n \\"message\\": \\"AbortError: The user aborted a request.\\",\\n \\"details\\": \\"\\",\\n \\"hint\\": \\"The request was aborted locally via the provided AbortSignal.\\",\\n \\"code\\": \\"\\"\\n },\\n \\"status\\": 0,\\n \\"statusText\\": \\"\\"\\n }\\n\\n\`\`\`" - }, - { - "id": "set-a-timeout", - "name": "Set a timeout", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('very_big_table')\\n .select()\\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\\n\`\`\`", - "response": "\`\`\`json\\n {\\n \\"error\\": {\\n \\"message\\": \\"FetchError: The user aborted a request.\\",\\n \\"details\\": \\"\\",\\n \\"hint\\": \\"\\",\\n \\"code\\": \\"\\"\\n },\\n \\"status\\": 400,\\n \\"statusText\\": \\"Bad Request\\"\\n }\\n\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.containedBy": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.containedBy", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.contains": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.contains", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.csv": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.csv", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a string in CSV format.", - "examples": [ - { - "id": "return-data-as-csv", - "name": "Return data as CSV", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .csv()\\n\`\`\`", - "description": "By default, the data is returned in JSON format, but can also be returned as Comma Separated Values.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": \\"id,name\\\\n1,Luke\\\\n2,Leia\\\\n3,Han\\",\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.eq": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.eq", - "params": [ - { - "name": "column", - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "value", - "comment": { - "shortText": "The value to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is equal to \`value\`.\\n\\nTo check if the value of \`column\` is NULL, you should use \`.is()\` instead.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .eq('name', 'Leia')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.explain": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.explain", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "analyze", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, the query will be executed and the\\nactual run time will be returned" - } - }, - { - "name": "buffers", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on buffer usage" - } - }, - { - "name": "format", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The format of the output, can be \`\\"text\\"\` (default)\\nor \`\\"json\\"\`" - } - }, - { - "name": "settings", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on configuration\\nparameters that affect query planning" - } - }, - { - "name": "verbose", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, the query identifier will be returned\\nand \`data\` will include the output columns of the query" - } - }, - { - "name": "wal", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on WAL record generation" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "PostgrestBuilder" - }, - { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - ] - } - }, - "comment": { - "shortText": "Return \`data\` as the EXPLAIN plan for the query.\\n\\nYou need to enable the\\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\\nsetting before using this method.", - "examples": [ - { - "id": "get-the-execution-plan", - "name": "Get the execution plan", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .explain()\\n\`\`\`", - "description": "By default, the data is returned in TEXT format, but can also be returned as JSON by using the \`format\` parameter.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`js\\nAggregate (cost=33.34..33.36 rows=1 width=112)\\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\\n\`\`\`" - }, - { - "id": "get-the-execution-plan-with-analyze-and-verbose", - "name": "Get the execution plan with analyze and verbose", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .explain({analyze:true,verbose:true})\\n\`\`\`", - "description": "By default, the data is returned in TEXT format, but can also be returned as JSON by using the \`format\` parameter.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`js\\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\\n Output: characters.id, characters.name\\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\\n Output: characters.id, characters.name\\nQuery Identifier: -4730654291623321173\\nPlanning Time: 0.407 ms\\nExecution Time: 0.119 ms\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.filter": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.filter", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "operator", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "FilterOperator" - }, - { - "type": "literal", - "value": "not.match" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.isdistinct" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - }, - { - "type": "literal", - "value": "not.imatch" - } - ] - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "operator", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.geojson": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.geojson", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as an object in [GeoJSON](https://geojson.org) format." - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.gt": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.gt", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.gte": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.gte", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.ilike": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.ilike", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.ilikeAllOf": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.ilikeAllOf", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.ilikeAnyOf": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.ilikeAnyOf", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.in": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.in", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "values", - "type": { - "type": "array" - }, - "comment": { - "shortText": "The values array to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is included in the \`values\` array.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .in('name', ['Leia', 'Han'])\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.is": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.is", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value" - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.isDistinct": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.isDistinct", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "value", - "comment": { - "shortText": "The value to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` IS DISTINCT FROM \`value\`.\\n\\nUnlike \`.neq()\`, this treats \`NULL\` as a comparable value. Two \`NULL\` values\\nare considered equal (not distinct), and comparing \`NULL\` with any non-NULL\\nvalue returns true (distinct)." - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.like": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.like", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.likeAllOf": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.likeAllOf", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.likeAnyOf": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.likeAnyOf", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.limit": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.limit", - "params": [ - { - "name": "count", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The maximum number of rows to return" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to limit rows of referenced\\ntables instead of the parent table" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Limit the query result by \`count\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .limit(1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-a-referenced-table", - "name": "On a referenced table", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments (\\n name\\n )\\n \`)\\n .limit(1, { referencedTable: 'instruments' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 1, 'harp'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.lt": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.lt", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.lte": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.lte", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.match": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.match", - "params": [ - { - "name": "query", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "nameOnly", - "name": "ColumnName" - }, - "valueType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "query", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.maxAffected": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.maxAffected", - "params": [ - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The maximum number of rows that can be affected" - } - } - ], - "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.maybeSingle": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.maybeSingle", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be zero or one row (e.g. using \`.limit(1)\`), otherwise\\nthis returns an error.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .eq('name', 'Katniss')\\n .maybeSingle()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.neq": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.neq", - "params": [ - { - "name": "column", - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "value", - "comment": { - "shortText": "The value to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is not equal to \`value\`.\\n\\nThis filter does not include rows where \`column\` is \`NULL\`. To match null\\nvalues, use \`.is(column, null)\` instead.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .neq('name', 'Leia')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.not": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.not", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "operator", - "type": { - "type": "literal", - "value": "is" - } - }, - { - "name": "value", - "type": { - "type": "literal", - "value": null - } - } - ], - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "operator", - "type": { - "type": "nameOnly", - "name": "FilterOperator" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "operator", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.notIn": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.notIn", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "values", - "type": { - "type": "array" - }, - "comment": { - "shortText": "The values array to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is NOT included in the \`values\` array." - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.or": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.or", - "params": [ - { - "name": "filters", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The filters to use, following PostgREST syntax" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`referencedTable\` instead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to filter on referenced tables\\ninstead of the parent table" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows which satisfy at least one of the filters.\\n\\nUnlike most filters, \`filters\` is used as-is and needs to follow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure it's properly sanitized.\\n\\nIt's currently not possible to do an \`.or()\` filter across multiple tables.", - "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\\n\\n\`\`\`ts\\n.or('id.in.(5,6,7), arraycol.cs.{\\"a\\",\\"b\\"}') // Use \`()\` for \`in\` filter, \`{}\` for array values and \`cs\` for \`contains()\`.\\n.or('id.in.(5,6,7), arraycol.cd.{\\"a\\",\\"b\\"}') // Use \`cd\` for \`containedBy()\`\\n\`\`\`", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .or('id.eq.2,name.eq.Han')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Leia\\"\\n },\\n {\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "use-or-with-and", - "name": "Use \`or\` with \`and\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "use-or-on-referenced-tables", - "name": "Use \`or\` on referenced tables", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments!inner (\\n name\\n )\\n \`)\\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.order": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.order", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "" - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "" - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.overlaps": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.overlaps", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.overrideTypes": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.overrideTypes", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`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\`\`\`" - }, - { - "id": "complete-override-type-of-successful-response", - "name": "Complete Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes, { merge: false }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "complete-override-type-of-object-response", - "name": "Complete Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType | null\\n\`\`\`" - }, - { - "id": "partial-override-type-of-successful-response", - "name": "Partial Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // Array\\n\`\`\`" - }, - { - "id": "partial-override-type-of-object-response", - "name": "Partial Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes<{ status: \\"A\\" | \\"B\\" }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // CountryRowProperties & { status: \\"A\\" | \\"B\\" } | null\\n\`\`\`" - }, - { - "id": "merge-vs-replace-existing-types", - "name": "Merge vs replace existing types", - "code": "\`\`\`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/supabase-js.PostgrestFilterBuilder.range": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.range", - "params": [ - { - "name": "from", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The starting index from which to limit the result" - } - }, - { - "name": "to", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The last index to which to limit the result" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to limit rows of referenced\\ntables instead of the parent table" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "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.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .range(0, 1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"name\\": \\"Leia\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.rangeAdjacent": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.rangeAdjacent", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.rangeGt": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.rangeGt", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.rangeGte": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.rangeGte", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.rangeLt": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.rangeLt", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.rangeLte": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.rangeLte", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.regexIMatch": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.regexIMatch", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.regexMatch": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.regexMatch", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.retry": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.retry", - "params": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "Whether to enable retries for this request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\n// Disable retries for a specific query\\nconst { data, error } = await supabase\\n .from('users')\\n .select()\\n .retry(false)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.returns": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.returns", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestTransformBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\`.", - "text": "- Deprecated: use overrideTypes method instead", - "examples": [ - { - "id": "override-type-of-successful-response", - "name": "Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .returns>()\\n\`\`\`", - "response": "\`\`\`js\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "override-type-of-object-response", - "name": "Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .returns()\\n\`\`\`", - "response": "\`\`\`js\\nlet x: typeof data // MyType | null\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.rollback": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.rollback", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Rollback the query.\\n\\n\`data\` will still be returned, but the query is not committed." - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.select": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.select", - "params": [ - { - "name": "columns", - "type": { - "type": "nameOnly", - "name": "Query" - }, - "isOptional": true, - "comment": { - "shortText": "The columns to retrieve, separated by commas" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a SELECT on the query result.\\n\\nBy default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`.", - "examples": [ - { - "id": "with-upsert", - "name": "With \`upsert()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .upsert({ id: 1, name: 'Han Solo' })\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Han Solo\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.setHeader": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request." - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.single": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.single", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be one row (e.g. using \`.limit(1)\`), otherwise this\\nreturns an error.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .limit(1)\\n .single()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"name\\": \\"Luke\\"\\n },\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.stripNulls": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.stripNulls", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Strip null values from the response data. Properties with \`null\` values\\nwill be omitted from the returned JSON objects.\\n\\nRequires PostgREST 11.2.0+.\\n\\nhttps://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .stripNulls()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text, bio text);\\n\\ninsert into\\n characters (id, name, bio)\\nvalues\\n (1, 'Luke', null),\\n (2, 'Leia', 'Princess of Alderaan');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\",\\n \\"bio\\": \\"Princess of Alderaan\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.textSearch": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.textSearch", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "query", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "query", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/supabase-js.PostgrestFilterBuilder.then": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.then", - "params": [ - { - "name": "onfulfilled", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "value", - "type": { - "type": "union", - "name": "PostgrestSingleResponse", - "subTypes": [ - { - "type": "nameOnly", - "name": "PostgrestResponseSuccess" - }, - { - "type": "nameOnly", - "name": "PostgrestResponseFailure" - } - ] - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is resolved." - } - }, - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult2" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PromiseLike" - } - }, - "comment": { - "shortText": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - }, - "@supabase/supabase-js.PostgrestFilterBuilder.throwOnError": { - "name": "@supabase/supabase-js.PostgrestFilterBuilder.throwOnError", - "params": [], - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" - } - }, - "@supabase/supabase-js.PostgrestQueryBuilder.constructor": { - "name": "@supabase/supabase-js.PostgrestQueryBuilder.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - }, - "comment": { - "shortText": "The URL for the query" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true, - "comment": { - "shortText": "Custom fetch implementation" - } - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - }, - "isOptional": true, - "comment": { - "shortText": "Custom headers" - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Enable automatic retries for transient errors (default: true)" - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Postgres schema to use" - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Maximum URL length before warning" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestQueryBuilder" - } - }, - "comment": { - "shortText": "Creates a query builder scoped to a Postgres table or view.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('users').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\\n\\nconst query = new PostgrestQueryBuilder(\\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\\n { headers: { apikey: 'your-publishable-key' }, retry: true }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestQueryBuilder.delete": { - "name": "@supabase/supabase-js.PostgrestQueryBuilder.delete", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "exact" - }, - null, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count deleted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a DELETE on the table or view.\\n\\nBy default, deleted rows are not returned. To return it, chain the call\\nwith \`.select()\` after filters.", - "text": "- \`delete()\` should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\\n- If you use \`delete()\` with filters and you have\\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\\n rows visible through \`SELECT\` policies are deleted. Note that by default\\n no rows are visible, so you need at least one \`SELECT\`/\`ALL\` policy that\\n makes the rows visible.\\n- When using \`delete().in()\`, specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal.", - "examples": [ - { - "id": "delete-a-single-record", - "name": "Delete a single record", - "code": "\`\`\`ts\\nconst response = await supabase\\n .from('countries')\\n .delete()\\n .eq('id', 1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'Mordor');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\\nif (error) console.error(error)\\n\`\`\`", - "description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`." - }, - { - "id": "delete-a-record-and-return-it", - "name": "Delete a record and return it", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('countries')\\n .delete()\\n .eq('id', 1)\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'Mordor');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Mordor\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "delete-multiple-records", - "name": "Delete multiple records", - "code": "\`\`\`ts\\nconst response = await supabase\\n .from('countries')\\n .delete()\\n .in('id', [1, 2, 3])\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestQueryBuilder.insert": { - "name": "@supabase/supabase-js.PostgrestQueryBuilder.insert", - "params": [ - { - "name": "values", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RejectExcessProperties" - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "RejectExcessProperties" - } - } - ] - }, - "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\\nor an array to insert multiple rows." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "exact" - }, - null, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count inserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - }, - { - "name": "defaultToNull", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Make missing fields default to \`null\`.\\nOtherwise, use the default value for the column. Only applies for bulk\\ninserts." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform an INSERT into the table or view.\\n\\nBy default, inserted rows are not returned. To return it, chain the call\\nwith \`.select()\`.", - "examples": [ - { - "id": "create-a-record", - "name": "Create a record", - "code": "\`\`\`ts\\nconst { error } = await supabase\\n .from('countries')\\n .insert({ id: 1, name: 'Mordor' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\\nif (error) console.error(error)\\n\`\`\`", - "description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`." - }, - { - "id": "create-a-record-and-return-it", - "name": "Create a record and return it", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('countries')\\n .insert({ id: 1, name: 'Mordor' })\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Mordor\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - }, - { - "id": "bulk-create", - "name": "Bulk create", - "code": "\`\`\`ts\\nconst { error } = await supabase\\n .from('countries')\\n .insert([\\n { id: 1, name: 'Mordor' },\\n { id: 1, name: 'The Shire' },\\n ])\\n\`\`\`", - "description": "A bulk create operation is handled in a single transaction.\\nIf any of the inserts fail, none of the rows are inserted.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"error\\": {\\n \\"code\\": \\"23505\\",\\n \\"details\\": \\"Key (id)=(1) already exists.\\",\\n \\"hint\\": null,\\n \\"message\\": \\"duplicate key value violates unique constraint \\\\\\"countries_pkey\\\\\\"\\"\\n },\\n \\"status\\": 409,\\n \\"statusText\\": \\"Conflict\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestQueryBuilder.select": { - "name": "@supabase/supabase-js.PostgrestQueryBuilder.select", - "params": [ - { - "name": "columns", - "type": { - "type": "nameOnly", - "name": "Query" - }, - "isOptional": true, - "comment": { - "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with \`customName:columnName\`" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "exact" - }, - null, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count rows in the table or view.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - }, - { - "name": "head", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When set to \`true\`, \`data\` will not be returned.\\nUseful if you only need the count." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a SELECT query on the table or view.", - "text": "When using \`count\` with \`.range()\` or \`.limit()\`, the returned \`count\` is the total number of rows\\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\\n\\n- By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use \`range()\` queries to paginate through your data.\\n- \`select()\` can be combined with [Filters](/docs/reference/javascript/using-filters)\\n- \`select()\` can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\\n- \`apikey\` is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *", - "examples": [ - { - "id": "getting-your-data", - "name": "Getting your data", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Harry'),\\n (2, 'Frodo'),\\n (3, 'Katniss');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Harry\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Frodo\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Katniss\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { data, error } = await supabase.from('characters').select()\\nif (error) {\\n // Logs the full error: message, code, details, and hint.\\n console.error(error)\\n return\\n}\\n\`\`\`", - "description": "The most useful field on a Postgres error is usually \`hint\` — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (\`code: '42501'\`) arrives with a \`hint\` like \`\\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\\"\`. Log the full \`error\` object so the hint isn't hidden behind \`error.message\`.", - "response": "\`\`\`json\\n{\\n \\"error\\": {\\n \\"code\\": \\"42501\\",\\n \\"details\\": null,\\n \\"hint\\": \\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\\",\\n \\"message\\": \\"permission denied for table characters\\"\\n },\\n \\"status\\": 401,\\n \\"statusText\\": \\"Unauthorized\\"\\n}\\n\`\`\`" - }, - { - "id": "selecting-specific-columns", - "name": "Selecting specific columns", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Frodo'),\\n (2, 'Harry'),\\n (3, 'Katniss');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Frodo\\"\\n },\\n {\\n \\"name\\": \\"Harry\\"\\n },\\n {\\n \\"name\\": \\"Katniss\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "query-referenced-tables", - "name": "Query referenced tables", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments (\\n name\\n )\\n \`)\\n\`\`\`", - "description": "If your database has foreign key relationships, you can query related tables too.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n },\\n {\\n \\"name\\": \\"woodwinds\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"flute\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "query-referenced-tables-with-spaces-in-their-names", - "name": "Query referenced tables with spaces in their names", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .from('orchestral sections')\\n .select(\`\\n name,\\n \\"musical instruments\\" (\\n name\\n )\\n \`)\\n\`\`\`", - "description": "If your table name contains spaces, you must use double quotes in the \`select\` statement to reference the table.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n \\"orchestral sections\\" (id int8 primary key, name text);\\ncreate table\\n \\"musical instruments\\" (\\n id int8 primary key,\\n section_id int8 not null references \\"orchestral sections\\",\\n name text\\n );\\n\\ninsert into\\n \\"orchestral sections\\" (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n \\"musical instruments\\" (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"musical instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n },\\n {\\n \\"name\\": \\"woodwinds\\",\\n \\"musical instruments\\": [\\n {\\n \\"name\\": \\"flute\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "query-referenced-tables-through-a-join-table", - "name": "Query referenced tables through a join table", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .select(\`\\n name,\\n teams (\\n name\\n )\\n \`)\\n\\n\`\`\`", - "description": "If you're in a situation where your tables are **NOT** directly\\nrelated, but instead are joined by a _join table_, you can still use\\nthe \`select()\` method to query the related data. The join table needs\\nto have the foreign keys as part of its composite primary key.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text\\n );\\ncreate table\\n teams (\\n id int8 primary key,\\n name text\\n );\\n-- join table\\ncreate table\\n users_teams (\\n user_id int8 not null references users,\\n team_id int8 not null references teams,\\n -- both foreign keys must be part of a composite primary key\\n primary key (user_id, team_id)\\n );\\n\\ninsert into\\n users (id, name)\\nvalues\\n (1, 'Kiran'),\\n (2, 'Evan');\\ninsert into\\n teams (id, name)\\nvalues\\n (1, 'Green'),\\n (2, 'Blue');\\ninsert into\\n users_teams (user_id, team_id)\\nvalues\\n (1, 1),\\n (1, 2),\\n (2, 2);\\n\`\`\`" - }, - "response": "\`\`\`json\\n {\\n \\"data\\": [\\n {\\n \\"name\\": \\"Kiran\\",\\n \\"teams\\": [\\n {\\n \\"name\\": \\"Green\\"\\n },\\n {\\n \\"name\\": \\"Blue\\"\\n }\\n ]\\n },\\n {\\n \\"name\\": \\"Evan\\",\\n \\"teams\\": [\\n {\\n \\"name\\": \\"Blue\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n }\\n\\n\`\`\`" - }, - { - "id": "query-the-same-referenced-table-multiple-times", - "name": "Query the same referenced table multiple times", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('messages')\\n .select(\`\\n content,\\n from:sender_id(name),\\n to:receiver_id(name)\\n \`)\\n\\n// To infer types, use the name of the table (in this case \`users\`) and\\n// the name of the foreign key constraint.\\nconst { data, error } = await supabase\\n .from('messages')\\n .select(\`\\n content,\\n from:users!messages_sender_id_fkey(name),\\n to:users!messages_receiver_id_fkey(name)\\n \`)\\n\`\`\`", - "description": "If you need to query the same referenced table twice, use the name of the\\njoined column to identify which join to use. You can also give each\\ncolumn an alias.", - "data": { - "sql": "\`\`\`sql\\n create table\\n users (id int8 primary key, name text);\\n\\n create table\\n messages (\\n sender_id int8 not null references users,\\n receiver_id int8 not null references users,\\n content text\\n );\\n\\n insert into\\n users (id, name)\\n values\\n (1, 'Kiran'),\\n (2, 'Evan');\\n\\n insert into\\n messages (sender_id, receiver_id, content)\\n values\\n (1, 2, '👋');\\n \`\`\`\\n\`\`\`\\n\\n@exampleResponse Query the same referenced table multiple times\\n\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"content\\": \\"👋\\",\\n \\"from\\": {\\n \\"name\\": \\"Kiran\\"\\n },\\n \\"to\\": {\\n \\"name\\": \\"Evan\\"\\n }\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`\\n\\n@exampleDescription Query nested foreign tables through a join table\\nYou can use the result of a joined table to gather data in\\nanother foreign table. With multiple references to the same foreign\\ntable you must specify the column on which to conduct the join.\\n\\n@example Query nested foreign tables through a join table\\n\`\`\`ts\\n const { data, error } = await supabase\\n .from('games')\\n .select(\`\\n game_id:id,\\n away_team:teams!games_away_team_fkey (\\n users (\\n id,\\n name\\n )\\n )\\n \`)\\n\\n\`\`\`\\n\\n@exampleSql Query nested foreign tables through a join table\\n\`\`\`sql\\n\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text\\n );\\ncreate table\\n teams (\\n id int8 primary key,\\n name text\\n );\\n-- join table\\ncreate table\\n users_teams (\\n user_id int8 not null references users,\\n team_id int8 not null references teams,\\n\\n primary key (user_id, team_id)\\n );\\ncreate table\\n games (\\n id int8 primary key,\\n home_team int8 not null references teams,\\n away_team int8 not null references teams,\\n name text\\n );\\n\\ninsert into users (id, name)\\nvalues\\n (1, 'Kiran'),\\n (2, 'Evan');\\ninsert into\\n teams (id, name)\\nvalues\\n (1, 'Green'),\\n (2, 'Blue');\\ninsert into\\n users_teams (user_id, team_id)\\nvalues\\n (1, 1),\\n (1, 2),\\n (2, 2);\\ninsert into\\n games (id, home_team, away_team, name)\\nvalues\\n (1, 1, 2, 'Green vs Blue'),\\n (2, 2, 1, 'Blue vs Green');\\n\`\`\`" - } - }, - { - "id": "filtering-through-referenced-tables", - "name": "Filtering through referenced tables", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .select('name, orchestral_sections(*)')\\n .eq('orchestral_sections.name', 'percussion')\\n\`\`\`", - "description": "If the filter on a referenced table's column is not satisfied, the referenced\\ntable returns \`[]\` or \`null\` but the parent table is not filtered out.\\nIf you want to filter out the parent table rows, use the \`!inner\` hint", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"flute\\",\\n \\"orchestral_sections\\": null\\n },\\n {\\n \\"name\\": \\"violin\\",\\n \\"orchestral_sections\\": null\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "querying-referenced-table-with-count", - "name": "Querying referenced table with count", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`*, instruments(count)\`)\\n\`\`\`", - "description": "You can get the number of rows in a related table by using the\\n**count** property.", - "data": { - "sql": "\`\`\`sql\\ncreate table orchestral_sections (\\n \\"id\\" \\"uuid\\" primary key default \\"extensions\\".\\"uuid_generate_v4\\"() not null,\\n \\"name\\" text\\n);\\n\\ncreate table characters (\\n \\"id\\" \\"uuid\\" primary key default \\"extensions\\".\\"uuid_generate_v4\\"() not null,\\n \\"name\\" text,\\n \\"section_id\\" \\"uuid\\" references public.orchestral_sections on delete cascade\\n);\\n\\nwith section as (\\n insert into orchestral_sections (name)\\n values ('strings') returning id\\n)\\ninsert into instruments (name, section_id) values\\n('violin', (select id from section)),\\n('viola', (select id from section)),\\n('cello', (select id from section)),\\n('double bass', (select id from section));\\n\`\`\`" - }, - "response": "\`\`\`json\\n[\\n {\\n \\"id\\": \\"693694e7-d993-4360-a6d7-6294e325d9b6\\",\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"count\\": 4\\n }\\n ]\\n }\\n]\\n\`\`\`" - }, - { - "id": "querying-with-count-option", - "name": "Querying with count option", - "code": "\`\`\`ts\\nconst { count, error } = await supabase\\n .from('characters')\\n .select('*', { count: 'exact', head: true })\\n\`\`\`", - "description": "You can get the number of rows by using the\\n[count](/docs/reference/javascript/select#parameters) option.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"count\\": 3,\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "querying-json-data", - "name": "Querying JSON data", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .select(\`\\n id, name,\\n address->city\\n \`)\\n\`\`\`", - "description": "You can select and filter data inside of\\n[JSON](/docs/guides/database/json) columns. Postgres offers some\\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\\nquerying JSON data.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text,\\n address jsonb\\n );\\n\\ninsert into\\n users (id, name, address)\\nvalues\\n (1, 'Frodo', '{\\"city\\":\\"Hobbiton\\"}');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Frodo\\",\\n \\"city\\": \\"Hobbiton\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "querying-referenced-table-with-inner-join", - "name": "Querying referenced table with inner join", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .select('name, orchestral_sections!inner(name)')\\n .eq('orchestral_sections.name', 'woodwinds')\\n .limit(1)\\n\`\`\`", - "description": "If you don't want to return the referenced table contents, you can leave the parenthesis empty.\\nLike \`.select('name, orchestral_sections!inner()')\`.", - "data": { - "sql": "\`\`\`sql\\ncreate table orchestral_sections (\\n \\"id\\" \\"uuid\\" primary key default \\"extensions\\".\\"uuid_generate_v4\\"() not null,\\n \\"name\\" text\\n);\\n\\ncreate table instruments (\\n \\"id\\" \\"uuid\\" primary key default \\"extensions\\".\\"uuid_generate_v4\\"() not null,\\n \\"name\\" text,\\n \\"section_id\\" \\"uuid\\" references public.orchestral_sections on delete cascade\\n);\\n\\nwith section as (\\n insert into orchestral_sections (name)\\n values ('woodwinds') returning id\\n)\\ninsert into instruments (name, section_id) values\\n('flute', (select id from section)),\\n('clarinet', (select id from section)),\\n('bassoon', (select id from section)),\\n('piccolo', (select id from section));\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"flute\\",\\n \\"orchestral_sections\\": {\\"name\\": \\"woodwinds\\"}\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "switching-schemas-per-query", - "name": "Switching schemas per query", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .schema('myschema')\\n .from('mytable')\\n .select()\\n\`\`\`", - "description": "In addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas).", - "data": { - "sql": "\`\`\`sql\\ncreate schema myschema;\\n\\ncreate table myschema.mytable (\\n id uuid primary key default gen_random_uuid(),\\n data text\\n);\\n\\ninsert into myschema.mytable (data) values ('mydata');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": \\"4162e008-27b0-4c0f-82dc-ccaeee9a624d\\",\\n \\"data\\": \\"mydata\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestQueryBuilder.update": { - "name": "@supabase/supabase-js.PostgrestQueryBuilder.update", - "params": [ - { - "name": "values", - "type": { - "type": "nameOnly", - "name": "RejectExcessProperties" - }, - "comment": { - "shortText": "The values to update with" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "exact" - }, - null, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count updated rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform an UPDATE on the table or view.\\n\\nBy default, updated rows are not returned. To return it, chain the call\\nwith \`.select()\` after filters.", - "text": "- \`update()\` should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update.", - "examples": [ - { - "id": "updating-your-data", - "name": "Updating your data", - "code": "\`\`\`ts\\nconst { error } = await supabase\\n .from('instruments')\\n .update({ name: 'piano' })\\n .eq('id', 1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n instruments (id int8 primary key, name text);\\n\\ninsert into\\n instruments (id, name)\\nvalues\\n (1, 'harpsichord');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\\nif (error) console.error(error)\\n\`\`\`", - "description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`." - }, - { - "id": "update-a-record-and-return-it", - "name": "Update a record and return it", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .update({ name: 'piano' })\\n .eq('id', 1)\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n instruments (id int8 primary key, name text);\\n\\ninsert into\\n instruments (id, name)\\nvalues\\n (1, 'harpsichord');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"piano\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "updating-json-data", - "name": "Updating JSON data", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .update({\\n address: {\\n street: 'Melrose Place',\\n postcode: 90210\\n }\\n })\\n .eq('address->postcode', 90210)\\n .select()\\n\`\`\`", - "description": "Postgres offers some\\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\\nworking with JSON data. Currently, it is only possible to update the entire JSON document.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text,\\n address jsonb\\n );\\n\\ninsert into\\n users (id, name, address)\\nvalues\\n (1, 'Michael', '{ \\"postcode\\": 90210 }');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Michael\\",\\n \\"address\\": {\\n \\"street\\": \\"Melrose Place\\",\\n \\"postcode\\": 90210\\n }\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestQueryBuilder.upsert": { - "name": "@supabase/supabase-js.PostgrestQueryBuilder.upsert", - "params": [ - { - "name": "values", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RejectExcessProperties" - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "RejectExcessProperties" - } - } - ] - }, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\\nsingle row or an array to upsert multiple rows." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "exact" - }, - null, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count upserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - }, - { - "name": "defaultToNull", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Make missing fields default to \`null\`.\\nOtherwise, use the default value for the column. This only applies when\\ninserting new rows, not when merging with existing rows under\\n\`ignoreDuplicates: false\`. This also only applies when doing bulk upserts." - } - }, - { - "name": "ignoreDuplicates", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, duplicate rows are ignored. If\\n\`false\`, duplicate rows are merged with existing rows." - } - }, - { - "name": "onConflict", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\\nduplicate rows are determined. Two rows are duplicates if all the\\n\`onConflict\` columns are equal." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\\nto \`onConflict\`, \`.upsert()\` allows you to perform the equivalent of\\n\`.insert()\` if a row with the corresponding \`onConflict\` columns doesn't\\nexist, or if it does exist, perform an alternative action depending on\\n\`ignoreDuplicates\`.\\n\\nBy default, upserted rows are not returned. To return it, chain the call\\nwith \`.select()\`.", - "text": "- Primary keys must be included in \`values\` to use upsert.", - "examples": [ - { - "id": "upsert-a-single-row-using-a-unique-key", - "name": "Upsert a single row using a unique key", - "code": "\`\`\`ts\\n// Upserting a single row, overwriting based on the 'username' unique column\\nconst { data, error } = await supabase\\n .from('users')\\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\\n\\n// Example response:\\n// {\\n// data: [\\n// { id: 4, message: 'bar', username: 'supabot' }\\n// ],\\n// error: null\\n// }\\n\`\`\`" - }, - { - "id": "upsert-with-conflict-resolution-and-exact-row-counting", - "name": "Upsert with conflict resolution and exact row counting", - "code": "\`\`\`ts\\n// Upserting and returning exact count\\nconst { data, error, count } = await supabase\\n .from('users')\\n .upsert(\\n {\\n id: 3,\\n message: 'foo',\\n username: 'supabot'\\n },\\n {\\n onConflict: 'username',\\n count: 'exact'\\n }\\n )\\n\\n// Example response:\\n// {\\n// data: [\\n// {\\n// id: 42,\\n// handle: \\"saoirse\\",\\n// display_name: \\"Saoirse\\"\\n// }\\n// ],\\n// count: 1,\\n// error: null\\n// }\\n\`\`\`" - }, - { - "id": "upsert-your-data", - "name": "Upsert your data", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .upsert({ id: 1, name: 'piano' })\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n instruments (id int8 primary key, name text);\\n\\ninsert into\\n instruments (id, name)\\nvalues\\n (1, 'harpsichord');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"piano\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\\nif (error) console.error(error)\\n\`\`\`", - "description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`." - }, - { - "id": "bulk-upsert-your-data", - "name": "Bulk Upsert your data", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .upsert([\\n { id: 1, name: 'piano' },\\n { id: 2, name: 'harp' },\\n ])\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n instruments (id int8 primary key, name text);\\n\\ninsert into\\n instruments (id, name)\\nvalues\\n (1, 'harpsichord');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"piano\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"harp\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - }, - { - "id": "upserting-into-tables-with-constraints", - "name": "Upserting into tables with constraints", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\\n .select()\\n\`\`\`", - "description": "In the following query, \`upsert()\` implicitly uses the \`id\`\\n(primary key) column to determine conflicts. If there is no existing\\nrow with the same \`id\`, \`upsert()\` inserts a new row, which\\nwill fail in this case as there is already a row with \`handle\` \`\\"saoirse\\"\`.\\nUsing the \`onConflict\` option, you can instruct \`upsert()\` to use\\nanother column with a unique constraint to determine conflicts.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 generated by default as identity primary key,\\n handle text not null unique,\\n display_name text\\n );\\n\\ninsert into\\n users (id, handle, display_name)\\nvalues\\n (1, 'saoirse', null);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"error\\": {\\n \\"code\\": \\"23505\\",\\n \\"details\\": \\"Key (handle)=(saoirse) already exists.\\",\\n \\"hint\\": null,\\n \\"message\\": \\"duplicate key value violates unique constraint \\\\\\"users_handle_key\\\\\\"\\"\\n },\\n \\"status\\": 409,\\n \\"statusText\\": \\"Conflict\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.constructor": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.constructor", - "params": [ - { - "name": "builder", - "type": { - "type": "object", - "properties": [ - { - "name": "body", - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - } - }, - { - "name": "isMaybeSingle", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "method", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "shouldStripNulls", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "shouldThrowOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestTransformBuilder" - } - }, - "comment": { - "shortText": "Creates a builder configured for a specific PostgREST request.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('users').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\\n\\nconst builder = new PostgrestQueryBuilder(\\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.abortSignal": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.abortSignal", - "params": [ - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "comment": { - "shortText": "The AbortSignal to use for the fetch request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set the AbortSignal for the fetch request.", - "text": "You can use this to set a timeout for the request.", - "examples": [ - { - "id": "aborting-requests-in-flight", - "name": "Aborting requests in-flight", - "code": "\`\`\`ts\\nconst ac = new AbortController()\\n\\nconst { data, error } = await supabase\\n .from('very_big_table')\\n .select()\\n .abortSignal(ac.signal)\\n\\n// Abort the request after 100 ms\\nsetTimeout(() => ac.abort(), 100)\\n\`\`\`", - "description": "You can use an [\`AbortController\`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\\nNote that \`status\` and \`statusText\` don't mean anything for aborted requests as the request wasn't fulfilled.", - "response": "\`\`\`json\\n {\\n \\"error\\": {\\n \\"message\\": \\"AbortError: The user aborted a request.\\",\\n \\"details\\": \\"\\",\\n \\"hint\\": \\"The request was aborted locally via the provided AbortSignal.\\",\\n \\"code\\": \\"\\"\\n },\\n \\"status\\": 0,\\n \\"statusText\\": \\"\\"\\n }\\n\\n\`\`\`" - }, - { - "id": "set-a-timeout", - "name": "Set a timeout", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('very_big_table')\\n .select()\\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\\n\`\`\`", - "response": "\`\`\`json\\n {\\n \\"error\\": {\\n \\"message\\": \\"FetchError: The user aborted a request.\\",\\n \\"details\\": \\"\\",\\n \\"hint\\": \\"\\",\\n \\"code\\": \\"\\"\\n },\\n \\"status\\": 400,\\n \\"statusText\\": \\"Bad Request\\"\\n }\\n\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.csv": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.csv", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a string in CSV format.", - "examples": [ - { - "id": "return-data-as-csv", - "name": "Return data as CSV", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .csv()\\n\`\`\`", - "description": "By default, the data is returned in JSON format, but can also be returned as Comma Separated Values.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": \\"id,name\\\\n1,Luke\\\\n2,Leia\\\\n3,Han\\",\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.explain": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.explain", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "analyze", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, the query will be executed and the\\nactual run time will be returned" - } - }, - { - "name": "buffers", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on buffer usage" - } - }, - { - "name": "format", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The format of the output, can be \`\\"text\\"\` (default)\\nor \`\\"json\\"\`" - } - }, - { - "name": "settings", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on configuration\\nparameters that affect query planning" - } - }, - { - "name": "verbose", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, the query identifier will be returned\\nand \`data\` will include the output columns of the query" - } - }, - { - "name": "wal", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on WAL record generation" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "PostgrestBuilder" - }, - { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - ] - } - }, - "comment": { - "shortText": "Return \`data\` as the EXPLAIN plan for the query.\\n\\nYou need to enable the\\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\\nsetting before using this method.", - "examples": [ - { - "id": "get-the-execution-plan", - "name": "Get the execution plan", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .explain()\\n\`\`\`", - "description": "By default, the data is returned in TEXT format, but can also be returned as JSON by using the \`format\` parameter.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`js\\nAggregate (cost=33.34..33.36 rows=1 width=112)\\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\\n\`\`\`" - }, - { - "id": "get-the-execution-plan-with-analyze-and-verbose", - "name": "Get the execution plan with analyze and verbose", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .explain({analyze:true,verbose:true})\\n\`\`\`", - "description": "By default, the data is returned in TEXT format, but can also be returned as JSON by using the \`format\` parameter.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`js\\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\\n Output: characters.id, characters.name\\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\\n Output: characters.id, characters.name\\nQuery Identifier: -4730654291623321173\\nPlanning Time: 0.407 ms\\nExecution Time: 0.119 ms\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.geojson": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.geojson", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as an object in [GeoJSON](https://geojson.org) format." - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.limit": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.limit", - "params": [ - { - "name": "count", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The maximum number of rows to return" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to limit rows of referenced\\ntables instead of the parent table" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Limit the query result by \`count\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .limit(1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-a-referenced-table", - "name": "On a referenced table", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments (\\n name\\n )\\n \`)\\n .limit(1, { referencedTable: 'instruments' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 1, 'harp'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.maxAffected": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.maxAffected", - "params": [ - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The maximum number of rows that can be affected" - } - } - ], - "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.maybeSingle": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.maybeSingle", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be zero or one row (e.g. using \`.limit(1)\`), otherwise\\nthis returns an error.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .eq('name', 'Katniss')\\n .maybeSingle()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.order": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.order", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "" - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "" - } - } - ] - }, - "@supabase/supabase-js.PostgrestTransformBuilder.overrideTypes": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.overrideTypes", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`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\`\`\`" - }, - { - "id": "complete-override-type-of-successful-response", - "name": "Complete Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes, { merge: false }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "complete-override-type-of-object-response", - "name": "Complete Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType | null\\n\`\`\`" - }, - { - "id": "partial-override-type-of-successful-response", - "name": "Partial Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // Array\\n\`\`\`" - }, - { - "id": "partial-override-type-of-object-response", - "name": "Partial Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes<{ status: \\"A\\" | \\"B\\" }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // CountryRowProperties & { status: \\"A\\" | \\"B\\" } | null\\n\`\`\`" - }, - { - "id": "merge-vs-replace-existing-types", - "name": "Merge vs replace existing types", - "code": "\`\`\`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/supabase-js.PostgrestTransformBuilder.range": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.range", - "params": [ - { - "name": "from", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The starting index from which to limit the result" - } - }, - { - "name": "to", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The last index to which to limit the result" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to limit rows of referenced\\ntables instead of the parent table" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "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.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .range(0, 1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"name\\": \\"Leia\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.retry": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.retry", - "params": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "Whether to enable retries for this request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\n// Disable retries for a specific query\\nconst { data, error } = await supabase\\n .from('users')\\n .select()\\n .retry(false)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.returns": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.returns", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestTransformBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\`.", - "text": "- Deprecated: use overrideTypes method instead", - "examples": [ - { - "id": "override-type-of-successful-response", - "name": "Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .returns>()\\n\`\`\`", - "response": "\`\`\`js\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "override-type-of-object-response", - "name": "Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .returns()\\n\`\`\`", - "response": "\`\`\`js\\nlet x: typeof data // MyType | null\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.rollback": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.rollback", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Rollback the query.\\n\\n\`data\` will still be returned, but the query is not committed." - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.select": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.select", - "params": [ - { - "name": "columns", - "type": { - "type": "nameOnly", - "name": "Query" - }, - "isOptional": true, - "comment": { - "shortText": "The columns to retrieve, separated by commas" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a SELECT on the query result.\\n\\nBy default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`.", - "examples": [ - { - "id": "with-upsert", - "name": "With \`upsert()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .upsert({ id: 1, name: 'Han Solo' })\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Han Solo\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.setHeader": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request." - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.single": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.single", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be one row (e.g. using \`.limit(1)\`), otherwise this\\nreturns an error.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .limit(1)\\n .single()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"name\\": \\"Luke\\"\\n },\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.stripNulls": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.stripNulls", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Strip null values from the response data. Properties with \`null\` values\\nwill be omitted from the returned JSON objects.\\n\\nRequires PostgREST 11.2.0+.\\n\\nhttps://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .stripNulls()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text, bio text);\\n\\ninsert into\\n characters (id, name, bio)\\nvalues\\n (1, 'Luke', null),\\n (2, 'Leia', 'Princess of Alderaan');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\",\\n \\"bio\\": \\"Princess of Alderaan\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.then": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.then", - "params": [ - { - "name": "onfulfilled", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "value", - "type": { - "type": "union", - "name": "PostgrestSingleResponse", - "subTypes": [ - { - "type": "nameOnly", - "name": "PostgrestResponseSuccess" - }, - { - "type": "nameOnly", - "name": "PostgrestResponseFailure" - } - ] - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is resolved." - } - }, - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult2" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PromiseLike" - } - }, - "comment": { - "shortText": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - }, - "@supabase/supabase-js.PostgrestTransformBuilder.throwOnError": { - "name": "@supabase/supabase-js.PostgrestTransformBuilder.throwOnError", - "params": [], - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" - } - }, - "@supabase/supabase-js.RealtimeChannel.constructor": { - "name": "@supabase/supabase-js.RealtimeChannel.constructor", - "params": [ - { - "name": "topic", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Topic name can be any string." - } - }, - { - "name": "params", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "name": "RealtimeChannelOptions", - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "object", - "properties": [ - { - "name": "broadcast", - "type": { - "type": "object", - "properties": [ - { - "name": "ack", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "replay", - "type": { - "type": "nameOnly", - "name": "ReplayOption" - }, - "isOptional": true - }, - { - "name": "self", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "self option enables client to receive message it broadcast\\nack option instructs server to acknowledge that broadcast message was received\\nreplay option instructs server to replay broadcast messages" - } - }, - { - "name": "presence", - "type": { - "type": "object", - "properties": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "key option is used to track presence payload across clients" - } - }, - { - "name": "private", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - } - } - ] - } - } - ] - } - ] - } - }, - { - "name": "socket", - "type": { - "type": "nameOnly", - "name": "RealtimeClient" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\\n\\nThe topic determines which realtime stream you are subscribing to. Config options let you\\nenable acknowledgement for broadcasts, presence tracking, or private channels.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst channel = supabase.channel('room1')\\nchannel\\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\\n .subscribe()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport RealtimeClient from '@supabase/realtime-js'\\n\\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\\n params: { apikey: 'your-publishable-key' },\\n})\\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.RealtimePresence.constructor": { - "name": "@supabase/supabase-js.RealtimePresence.constructor", - "params": [ - { - "name": "channel", - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - }, - "comment": { - "shortText": "The realtime channel to bind to." - } - }, - { - "name": "opts", - "type": { - "type": "nameOnly", - "name": "RealtimePresenceOptions" - }, - "isOptional": true, - "comment": { - "shortText": "Optional custom event names, e.g. \`{ events: { state: 'state', diff: 'diff' } }\`." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimePresence" - } - }, - "comment": { - "shortText": "Creates a Presence helper that keeps the local presence state in sync with the server.", - "examples": [ - { - "id": "example-for-a-presence-channel", - "name": "Example for a presence channel", - "code": "\`\`\`ts\\nconst presence = new RealtimePresence(channel)\\n\\nchannel.on('presence', ({ event, key }) => {\\n console.log(\`Presence \${event} on \${key}\`)\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.RealtimeClient.constructor": { - "name": "@supabase/supabase-js.RealtimeClient.constructor", - "params": [ - { - "name": "endPoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \\"ws://example.com/socket\\", \\"wss://example.com\\", \\"/socket\\" (inherited host & protocol)" - } - }, - { - "name": "options", - "type": { - "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": { - "type": "nameOnly", - "name": "Decode" - }, - "isOptional": true - }, - { - "name": "disconnectOnEmptyChannelsAfterMs", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "encode", - "type": { - "type": "nameOnly", - "name": "Encode" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "nameOnly", - "name": "Fetch" - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "heartbeatCallback", - "type": { - "type": "function", - "params": [ - { - "name": "status", - "type": { - "type": "nameOnly", - "name": "HeartbeatStatus" - } - }, - { - "name": "latency", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "isOptional": true - }, - { - "name": "heartbeatIntervalMs", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "log_level", - "type": { - "type": "nameOnly", - "name": "LogLevel" - }, - "isOptional": true - }, - { - "name": "logger", - "type": { - "type": "function", - "params": [ - { - "name": "kind", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "msg", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "isOptional": true - }, - { - "name": "logLevel", - "type": { - "type": "nameOnly", - "name": "LogLevel" - }, - "isOptional": true - }, - { - "name": "params", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "reconnectAfterMs", - "type": { - "type": "function", - "params": [ - { - "name": "tries", - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - "isOptional": true - }, - { - "name": "sessionStorage", - "type": { - "type": "nameOnly", - "name": "Storage" - }, - "isOptional": true, - "comment": { - "shortText": "Storage compatible object used by the underlying socket for longpoll fallback history.\\nProvide a custom implementation in environments where reading \`globalThis.sessionStorage\`\\nthrows (sandboxed iframes, in-app webviews, \\"block third-party storage\\" privacy modes).\\nDefaults to \`globalThis.sessionStorage\` when accessible, otherwise an in-memory store." - } - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "transport", - "type": { - "type": "object", - "name": "WebSocketLikeConstructor", - "properties": [] - }, - "isOptional": true - }, - { - "name": "vsn", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "worker", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "workerUrl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeClient" - } - }, - "comment": { - "shortText": "Initializes the Socket.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst channel = supabase.channel('room1')\\nchannel\\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\\n .subscribe()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport RealtimeClient from '@supabase/realtime-js'\\n\\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\\n params: { apikey: 'your-publishable-key' },\\n})\\nclient.connect()\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.RealtimeClient.channel": { - "name": "@supabase/supabase-js.RealtimeClient.channel", - "params": [ - { - "name": "topic", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "params", - "type": { - "name": "RealtimeChannelOptions", - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "object", - "properties": [ - { - "name": "broadcast", - "type": { - "type": "object", - "properties": [ - { - "name": "ack", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "replay", - "type": { - "type": "nameOnly", - "name": "ReplayOption" - }, - "isOptional": true - }, - { - "name": "self", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "self option enables client to receive message it broadcast\\nack option instructs server to acknowledge that broadcast message was received\\nreplay option instructs server to replay broadcast messages" - } - }, - { - "name": "presence", - "type": { - "type": "object", - "properties": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "key option is used to track presence payload across clients" - } - }, - { - "name": "private", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - } - } - ] - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates (or reuses) a RealtimeChannel for the provided topic.\\n\\nTopics are automatically prefixed with \`realtime:\` to match the Realtime service.\\nIf a channel with the same topic already exists it will be returned instead of creating\\na duplicate connection." - } - }, - "@supabase/supabase-js.RealtimeClient.connect": { - "name": "@supabase/supabase-js.RealtimeClient.connect", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Connects the socket, unless already connected." - } - }, - "@supabase/supabase-js.RealtimeClient.connectionState": { - "name": "@supabase/supabase-js.RealtimeClient.connectionState", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "ConnectionState" - } - }, - "comment": { - "shortText": "Returns the current state of the socket." - } - }, - "@supabase/supabase-js.RealtimeClient.disconnect": { - "name": "@supabase/supabase-js.RealtimeClient.disconnect", - "params": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A numeric status code to send on disconnect." - } - }, - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A custom reason for the disconnect." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "timeout" - }, - { - "type": "literal", - "value": "ok" - } - ] - } - } - }, - "comment": { - "shortText": "Disconnects the socket." - } - }, - "@supabase/supabase-js.RealtimeClient.endpointURL": { - "name": "@supabase/supabase-js.RealtimeClient.endpointURL", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Returns the URL of the websocket." - } - }, - "@supabase/supabase-js.RealtimeClient.getChannels": { - "name": "@supabase/supabase-js.RealtimeClient.getChannels", - "params": [], - "ret": { - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - } - }, - "comment": { - "shortText": "Returns all created channels" - } - }, - "@supabase/supabase-js.RealtimeClient.isConnected": { - "name": "@supabase/supabase-js.RealtimeClient.isConnected", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Returns \`true\` is the connection is open." - } - }, - "@supabase/supabase-js.RealtimeClient.isConnecting": { - "name": "@supabase/supabase-js.RealtimeClient.isConnecting", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Returns \`true\` if the connection is currently connecting." - } - }, - "@supabase/supabase-js.RealtimeClient.isDisconnecting": { - "name": "@supabase/supabase-js.RealtimeClient.isDisconnecting", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Returns \`true\` if the connection is currently disconnecting." - } - }, - "@supabase/supabase-js.RealtimeClient.log": { - "name": "@supabase/supabase-js.RealtimeClient.log", - "params": [ - { - "name": "kind", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "msg", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Logs the message.\\n\\nFor customized logging, \`this.logger\` can be overridden in Client constructor." - } - }, - "@supabase/supabase-js.RealtimeClient.onHeartbeat": { - "name": "@supabase/supabase-js.RealtimeClient.onHeartbeat", - "params": [ - { - "name": "callback", - "type": { - "type": "nameOnly", - "name": "HeartbeatCallback" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Sets a callback that receives lifecycle events for internal heartbeat messages.\\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)." - } - }, - "@supabase/supabase-js.RealtimeClient.push": { - "name": "@supabase/supabase-js.RealtimeClient.push", - "params": [ - { - "name": "data", - "type": { - "name": "RealtimeMessage", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "join_ref", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "payload", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ref", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "topic", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "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/supabase-js.RealtimeClient.removeAllChannels": { - "name": "@supabase/supabase-js.RealtimeClient.removeAllChannels", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "array", - "elemType": { - "type": "union", - "name": "RealtimeRemoveChannelResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - } - }, - "comment": { - "shortText": "Unsubscribes, removes and tears down all channels" - } - }, - "@supabase/supabase-js.RealtimeClient.removeChannel": { - "name": "@supabase/supabase-js.RealtimeClient.removeChannel", - "params": [ - { - "name": "channel", - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - }, - "comment": { - "shortText": "A RealtimeChannel instance" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeRemoveChannelResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Unsubscribes, removes and tears down a single channel" - } - }, - "@supabase/supabase-js.RealtimeClient.sendHeartbeat": { - "name": "@supabase/supabase-js.RealtimeClient.sendHeartbeat", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - } - }, - "@supabase/supabase-js.RealtimeClient.setAuth": { - "name": "@supabase/supabase-js.RealtimeClient.setAuth", - "params": [ - { - "name": "token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "A JWT string to override the token set on the client." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "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.\\n\\nWhen a token is explicitly provided, it will be preserved across channel operations\\n(including removeChannel and resubscribe). The \`accessToken\` callback will not be\\ninvoked until \`setAuth()\` is called without arguments.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\nSetting the authorization header\\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\\nclient.realtime.setAuth('my-custom-jwt')\\n\\n// Switch back to using the accessToken callback\\nclient.realtime.setAuth()\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.RealtimeChannel.copyBindings": { - "name": "@supabase/supabase-js.RealtimeChannel.copyBindings", - "params": [ - { - "name": "other", - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "@supabase/supabase-js.RealtimeChannel.httpSend": { - "name": "@supabase/supabase-js.RealtimeChannel.httpSend", - "params": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The name of the broadcast event" - } - }, - { - "name": "payload", - "type": { - "type": "intrinsic", - "name": "any" - }, - "comment": { - "shortText": "Payload to be sent (required)" - } - }, - { - "name": "opts", - "type": { - "type": "object", - "properties": [ - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Options including timeout" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "success", - "type": { - "type": "literal", - "value": true - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "success", - "type": { - "type": "literal", - "value": false - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sends a broadcast message explicitly via REST API.\\n\\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\\n\\nPayloads that are \`ArrayBuffer\` or \`ArrayBufferView\` (e.g. \`Uint8Array\`) are sent as\\n\`application/octet-stream\`; all other payloads are JSON-encoded." - } - }, - "@supabase/supabase-js.RealtimeChannel.on": { - "name": "@supabase/supabase-js.RealtimeChannel.on", - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "sync" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - }, - "altSignatures": [ - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "join" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "name": "RealtimePresenceJoinPayload", - "type": "object", - "properties": [ - { - "name": "currentPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - }, - { - "name": "event" - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "newPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "leave" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "name": "RealtimePresenceLeavePayload", - "type": "object", - "properties": [ - { - "name": "currentPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - }, - { - "name": "event" - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "leftPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "*" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "union", - "subTypes": [ - { - "name": "RealtimePresenceJoinPayload", - "type": "object", - "properties": [ - { - "name": "currentPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - }, - { - "name": "event" - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "newPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - ] - }, - { - "name": "RealtimePresenceLeavePayload", - "type": "object", - "properties": [ - { - "name": "currentPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - }, - { - "name": "event" - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "leftPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - ] - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "*" - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "union", - "name": "RealtimePostgresChangesPayload", - "subTypes": [ - { - "type": "nameOnly", - "name": "RealtimePostgresInsertPayload" - }, - { - "type": "nameOnly", - "name": "RealtimePostgresUpdatePayload" - }, - { - "type": "nameOnly", - "name": "RealtimePostgresDeletePayload" - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "INSERT" - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimePostgresInsertPayload" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "UPDATE" - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "DELETE" - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimePostgresDeletePayload" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "*" - }, - { - "type": "literal", - "value": "INSERT" - }, - { - "type": "literal", - "value": "UPDATE" - } - ] - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "union", - "name": "RealtimePostgresChangesPayload", - "subTypes": [ - { - "type": "nameOnly", - "name": "RealtimePostgresInsertPayload" - }, - { - "type": "nameOnly", - "name": "RealtimePostgresUpdatePayload" - }, - { - "type": "nameOnly", - "name": "RealtimePostgresDeletePayload" - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - }, - "comment": { - "shortText": "One of \\"broadcast\\", \\"presence\\", or \\"postgres_changes\\"." - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "meta", - "type": { - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "replayed", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "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." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "meta", - "type": { - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "replayed", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "T" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "*", - "name": "ALL" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "*", - "name": "ALL" - } - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimeBroadcastPayload" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "INSERT", - "name": "INSERT" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "INSERT", - "name": "INSERT" - } - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimeBroadcastInsertPayload" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "UPDATE", - "name": "UPDATE" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "UPDATE", - "name": "UPDATE" - } - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimeBroadcastUpdatePayload" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "DELETE", - "name": "DELETE" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "DELETE", - "name": "DELETE" - } - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimeBroadcastDeletePayload" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "system" - } - }, - { - "name": "filter" - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - } - ] - }, - "@supabase/supabase-js.RealtimeChannel.presenceState": { - "name": "@supabase/supabase-js.RealtimeChannel.presenceState", - "params": [], - "ret": { - "type": { - "name": "RealtimePresenceState", - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - }, - "comment": { - "shortText": "Returns the current presence state for this channel.\\n\\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\\ntracked metadata for that user." - } - }, - "@supabase/supabase-js.RealtimeChannel.send": { - "name": "@supabase/supabase-js.RealtimeChannel.send", - "params": [ - { - "name": "args", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The name of the event being sent" - } - }, - { - "name": "payload", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true, - "comment": { - "shortText": "Payload to be sent" - } - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - }, - "comment": { - "shortText": "The type of event to send" - } - } - ] - }, - "comment": { - "shortText": "Arguments to send to channel" - } - }, - { - "name": "opts", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Options to be used during the send process" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeChannelSendResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Sends a message into the channel.", - "text": "- When using REST you don't need to subscribe to the channel\\n- REST calls are only available from 2.37.0 onwards\\n- If you create a channel only to send a REST broadcast, remove it from\\n the client when the send completes", - "examples": [ - { - "id": "send-a-message-via-websocket", - "name": "Send a message via websocket", - "code": "\`\`\`js\\nconst channel = supabase.channel('room1')\\n\\nchannel.subscribe((status) => {\\n if (status === 'SUBSCRIBED') {\\n channel.send({\\n type: 'broadcast',\\n event: 'cursor-pos',\\n payload: { x: Math.random(), y: Math.random() },\\n })\\n }\\n})\\n\`\`\`", - "response": "\`\`\`js\\nok | timed out | error\\n\`\`\`" - }, - { - "id": "send-a-message-via-rest", - "name": "Send a message via REST", - "code": "\`\`\`js\\nconst channel = supabase.channel('room1')\\n\\ntry {\\n await channel.httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\\n} finally {\\n await supabase.removeChannel(channel)\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.RealtimeChannel.subscribe": { - "name": "@supabase/supabase-js.RealtimeChannel.subscribe", - "params": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "status", - "type": { - "type": "nameOnly", - "name": "REALTIME_SUBSCRIBE_STATES" - } - }, - { - "name": "err", - "type": { - "type": "nameOnly", - "name": "Error" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "isOptional": true - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Subscribe registers your client with the server.\\n\\nThe optional \`callback\` receives a \`status\` and, on failure, an \`err\` argument.\\nLog the full \`err\` so its \`cause\`, \`name\`, and any structured fields aren't hidden\\nbehind \`err.message\`.", - "examples": [ - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nsupabase.channel('room1').subscribe((status, err) => {\\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\\n // Log the full error: its \`cause\` often holds the underlying reason.\\n console.error(status, err)\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.RealtimeChannel.teardown": { - "name": "@supabase/supabase-js.RealtimeChannel.teardown", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Destroys and stops related timers." - } - }, - "@supabase/supabase-js.RealtimeChannel.track": { - "name": "@supabase/supabase-js.RealtimeChannel.track", - "params": [ - { - "name": "payload", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "name": "opts", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeChannelSendResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Sends the supplied payload to the presence tracker so other subscribers can see that this\\nclient is online. Use \`untrack\` to stop broadcasting presence for the same key." - } - }, - "@supabase/supabase-js.RealtimeChannel.unsubscribe": { - "name": "@supabase/supabase-js.RealtimeChannel.unsubscribe", - "params": [ - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeChannelSendResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "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/supabase-js.RealtimeChannel.untrack": { - "name": "@supabase/supabase-js.RealtimeChannel.untrack", - "params": [ - { - "name": "opts", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeChannelSendResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Removes the current presence state for this client." - } - }, - "@supabase/supabase-js.RealtimeChannel.updateJoinPayload": { - "name": "@supabase/supabase-js.RealtimeChannel.updateJoinPayload", - "params": [ - { - "name": "payload", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Updates the payload that will be sent the next time the channel joins (reconnects).\\nUseful for rotating access tokens or updating config without re-creating the channel." - } - }, - "@supabase/supabase-js.StorageApiError.constructor": { - "name": "@supabase/supabase-js.StorageApiError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusCode", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "namespace", - "type": { - "type": "nameOnly", - "name": "ErrorNamespace" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageApiError" - } - } - }, - "@supabase/supabase-js.StorageApiError.toJSON": { - "name": "@supabase/supabase-js.StorageApiError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "statusCode", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - } - }, - "@supabase/supabase-js.SupabaseClient.constructor": { - "name": "@supabase/supabase-js.SupabaseClient.constructor", - "params": [ - { - "name": "supabaseUrl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - } - }, - { - "name": "supabaseKey", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - } - }, - { - "name": "options", - "type": { - "name": "SupabaseClientOptions", - "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, - "comment": { - "shortText": "Optional function for using a third-party authentication system with\\nSupabase. The function should return an access token or ID token (JWT) by\\nobtaining it from the third-party auth SDK. Note that this\\nfunction may be called concurrently and many times. Use memoization and\\nlocking techniques if this is not supported by the SDKs.\\n\\nWhen set, the \`auth\` namespace of the Supabase client cannot be used.\\nCreate another client if you wish to use Supabase Auth and third-party\\nauthentications concurrently in the same application." - } - }, - { - "name": "auth", - "type": { - "type": "object", - "properties": [ - { - "name": "autoRefreshToken", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Automatically refreshes the token for logged-in users. Defaults to true." - } - }, - { - "name": "debug", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['debug']" - }, - "isOptional": true, - "comment": { - "shortText": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." - } - }, - { - "name": "detectSessionInUrl", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "function", - "params": [ - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "params", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true.\\n\\nCan be set to a function to provide custom logic for determining if a URL contains\\na Supabase auth callback. The function receives the current URL and parsed parameters,\\nand should return true if the URL should be processed as a Supabase auth callback.\\n\\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that\\nalso return access_token in the URL fragment, which would otherwise be incorrectly\\nintercepted by Supabase Auth.", - "examples": [ - { - "id": "with-custom-detection-logic", - "name": "With custom detection logic", - "code": "\`\`\`ts\\ndetectSessionInUrl: (url, params) => {\\n // Ignore Facebook OAuth redirects\\n if (url.pathname === '/facebook/redirect') return false\\n // Use default detection for other URLs\\n return Boolean(params.access_token || params.error_description)\\n}\\n\`\`\`" - } - ] - } - }, - { - "name": "experimental", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['experimental']" - }, - "isOptional": true, - "comment": { - "shortText": "Opt-in flags for experimental features. These APIs may change without\\nnotice and are disabled by default.", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ] - } - }, - { - "name": "flowType", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['flowType']" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - } - }, - { - "name": "lock", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['lock']" - }, - "isOptional": true, - "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default\\nthe auth client coordinates refreshes itself and the server resolves\\ncross-tab races. Passing a custom \`lock\` opts into a legacy path that\\nwraps every auth operation in your supplied lock." - } - }, - { - "name": "lockAcquireTimeout", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['lockAcquireTimeout']" - }, - "isOptional": true, - "comment": { - "shortText": "Maximum time in milliseconds to wait for acquiring the custom lock\\nsupplied via \`lock\`. Only consulted when a custom \`lock\` is passed." - } - }, - { - "name": "persistSession", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to persist a logged-in session to storage. Defaults to true." - } - }, - { - "name": "skipAutoInitialize", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['skipAutoInitialize']" - }, - "isOptional": true, - "comment": { - "shortText": "If true, skips automatic initialization in the auth client constructor.\\nUseful for SSR contexts where initialization timing must be controlled to\\nprevent race conditions with HTTP response generation." - } - }, - { - "name": "storage", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['storage']" - }, - "isOptional": true, - "comment": { - "shortText": "A storage provider. Used to store the logged-in session." - } - }, - { - "name": "storageKey", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage." - } - }, - { - "name": "throwOnError", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['throwOnError']" - }, - "isOptional": true, - "comment": { - "shortText": "If there is an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response." - } - }, - { - "name": "userStorage", - "type": { - "type": "nameOnly", - "name": "SupabaseAuthClientOptions['userStorage']" - }, - "isOptional": true, - "comment": { - "shortText": "A storage provider to store the user profile separately from the session.\\nUseful when you need to store the session information in cookies,\\nwithout bloating the data with the redundant user object.", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ] - } - } - ] - }, - "isOptional": true - }, - { - "name": "db", - "type": { - "type": "object", - "properties": [ - { - "name": "schema", - "type": { - "type": "nameOnly", - "name": "@supabase/supabase-js.default.SchemaName" - }, - "isOptional": true - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Optional timeout in milliseconds for PostgREST requests.\\nWhen set, requests will automatically abort after this duration to prevent indefinite hangs.", - "examples": [ - { - "id": "with-timeout", - "name": "With timeout", - "code": "\`\`\`ts\\nconst supabase = createClient(url, key, {\\n db: { timeout: 30000 } // 30 second timeout\\n})\\n\`\`\`" - } - ] - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Maximum URL length in characters before warnings/errors are triggered.\\nDefaults to 8000 characters. Used to provide helpful hints when URLs\\nexceed server limits.", - "examples": [ - { - "id": "with-custom-url-length-limit", - "name": "With custom URL length limit", - "code": "\`\`\`ts\\nconst supabase = createClient(url, key, {\\n db: { urlLengthLimit: 10000 } // Custom limit\\n})\\n\`\`\`" - } - ] - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to \`public\`." - } - }, - { - "name": "global", - "type": { - "type": "object", - "properties": [ - { - "name": "fetch", - "type": { - "type": "nameOnly", - "name": "Fetch" - }, - "isOptional": true, - "comment": { - "shortText": "A custom \`fetch\` implementation." - } - }, - { - "name": "headers", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Optional headers for initializing the client." - } - } - ] - }, - "isOptional": true - }, - { - "name": "realtime", - "type": { - "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": { - "type": "nameOnly", - "name": "Decode" - }, - "isOptional": true - }, - { - "name": "disconnectOnEmptyChannelsAfterMs", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "encode", - "type": { - "type": "nameOnly", - "name": "Encode" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "nameOnly", - "name": "Fetch" - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "heartbeatCallback", - "type": { - "type": "function", - "params": [ - { - "name": "status", - "type": { - "type": "nameOnly", - "name": "HeartbeatStatus" - } - }, - { - "name": "latency", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "isOptional": true - }, - { - "name": "heartbeatIntervalMs", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "log_level", - "type": { - "type": "nameOnly", - "name": "LogLevel" - }, - "isOptional": true - }, - { - "name": "logger", - "type": { - "type": "function", - "params": [ - { - "name": "kind", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "msg", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "isOptional": true - }, - { - "name": "logLevel", - "type": { - "type": "nameOnly", - "name": "LogLevel" - }, - "isOptional": true - }, - { - "name": "params", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "reconnectAfterMs", - "type": { - "type": "function", - "params": [ - { - "name": "tries", - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - "isOptional": true - }, - { - "name": "sessionStorage", - "type": { - "type": "nameOnly", - "name": "Storage" - }, - "isOptional": true, - "comment": { - "shortText": "Storage compatible object used by the underlying socket for longpoll fallback history.\\nProvide a custom implementation in environments where reading \`globalThis.sessionStorage\`\\nthrows (sandboxed iframes, in-app webviews, \\"block third-party storage\\" privacy modes).\\nDefaults to \`globalThis.sessionStorage\` when accessible, otherwise an in-memory store." - } - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "transport", - "type": { - "type": "object", - "name": "WebSocketLikeConstructor", - "properties": [] - }, - "isOptional": true - }, - { - "name": "vsn", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "worker", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "workerUrl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Options passed to the realtime-js instance" - } - }, - { - "name": "storage", - "type": { - "type": "nameOnly", - "name": "StorageClientOptions" - }, - "isOptional": true - }, - { - "name": "tracePropagation", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "TracePropagationOptions", - "properties": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Enable trace propagation. Disabled by default.\\n\\nWhen enabled, automatically detects and propagates active trace context\\nfrom the OpenTelemetry API to outgoing Supabase requests. Trace context\\nis only propagated to Supabase domains (\`*.supabase.co\`, \`*.supabase.in\`,\\n\`localhost\`) for security — third-party hosts never receive trace headers.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\nconst supabase = createClient(url, key, {\\n tracePropagation: { enabled: true },\\n})\\n\`\`\`" - } - ] - } - }, - { - "name": "respectSamplingDecision", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Respect upstream sampling decisions.\\n\\nWhen true (the default), trace context is not propagated if the upstream\\ntrace indicates non-sampling (sampled flag = \`0\` in the \`traceparent\`\\nheader). This avoids overhead when traces are being recorded but dropped.\\n\\nSet to \`false\` to always propagate, regardless of the sampling decision\\n— useful when you want every Supabase request tagged with a \`trace_id\`\\nfor log correlation, even if the trace itself will not be exported.", - "examples": [ - { - "id": "always-propagate-ignore-sampling", - "name": "Always propagate, ignore sampling", - "code": "\`\`\`ts\\nconst supabase = createClient(url, key, {\\n tracePropagation: { enabled: true, respectSamplingDecision: false },\\n})\\n\`\`\`" - } - ] - } - } - ] - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Enable OpenTelemetry / W3C trace context propagation to Supabase services.\\n\\nDisabled by default. Pass \`true\` for the common case (auto-detect an\\nactive OpenTelemetry context and inject \`traceparent\` / \`tracestate\` /\\n\`baggage\` headers) or an object for fine-grained control.\\n\\nRequires \`@opentelemetry/api\` to be installed in your application; if\\nnot present, the SDK silently no-ops. Trace headers are only attached\\nto requests targeting Supabase domains, so third-party hosts called\\nthrough a custom \`fetch\` are never tagged.\\n\\nThe resulting \`trace_id\` appears in Supabase logs (API Gateway, Edge\\nFunctions), letting you correlate client-side spans with server-side\\nlog entries — including logs forwarded via Log Drains.", - "examples": [ - { - "id": "shorthand-opt-in-with-defaults", - "name": "Shorthand — opt in with defaults", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient(url, key, { tracePropagation: true })\\n\`\`\`" - }, - { - "id": "with-an-active-opentelemetry-span", - "name": "With an active OpenTelemetry span", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\nimport { trace } from '@opentelemetry/api'\\n\\nconst supabase = createClient(url, key, { tracePropagation: true })\\nconst tracer = trace.getTracer('my-app')\\n\\nawait tracer.startActiveSpan('fetch-users', async (span) => {\\n // Request carries the active trace context.\\n const { data, error } = await supabase.from('users').select('*')\\n span.end()\\n})\\n\`\`\`" - }, - { - "id": "advanced-always-propagate-even-for-non-sampled-traces", - "name": "Advanced — always propagate, even for non-sampled traces", - "code": "\`\`\`ts\\nconst supabase = createClient(url, key, {\\n tracePropagation: { enabled: true, respectSamplingDecision: false },\\n})\\n\`\`\`" - } - ] - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "SupabaseClient" - } - }, - "comment": { - "shortText": "Create a new client for use in the browser.", - "examples": [ - { - "id": "creating-a-client", - "name": "Creating a client", - "code": "\`\`\`js\\nimport { createClient } from '@supabase/supabase-js'\\n\\n// Create a single supabase client for interacting with your database\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\n\`\`\`" - }, - { - "id": "with-a-custom-domain", - "name": "With a custom domain", - "code": "\`\`\`js\\nimport { createClient } from '@supabase/supabase-js'\\n\\n// Use a custom domain as the supabase URL\\nconst supabase = createClient('https://my-custom-domain.com', 'your-publishable-key')\\n\`\`\`" - }, - { - "id": "with-additional-parameters", - "name": "With additional parameters", - "code": "\`\`\`js\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst options = {\\n db: {\\n schema: 'public',\\n },\\n auth: {\\n autoRefreshToken: true,\\n persistSession: true,\\n detectSessionInUrl: true\\n },\\n global: {\\n headers: { 'x-my-custom-header': 'my-app-name' },\\n },\\n}\\nconst supabase = createClient(\\"https://xyzcompany.supabase.co\\", \\"your-publishable-key\\", options)\\n\`\`\`" - }, - { - "id": "with-custom-schemas", - "name": "With custom schemas", - "code": "\`\`\`js\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\\n // Provide a custom schema. Defaults to \\"public\\".\\n db: { schema: 'other_schema' }\\n})\\n\`\`\`", - "description": "By default the API server points to the \`public\` schema. You can enable other database schemas within the Dashboard.\\nGo to [Settings > API > Exposed schemas](/dashboard/project/_/settings/api) and add the schema which you want to expose to the API.\\n\\nNote: each client connection can only access a single schema, so the code above can access the \`other_schema\` schema but cannot access the \`public\` schema." - }, - { - "id": "custom-fetch-implementation", - "name": "Custom fetch implementation", - "code": "\`\`\`js\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\\n global: { fetch: fetch.bind(globalThis) }\\n})\\n\`\`\`", - "description": "\`supabase-js\` uses the [\`cross-fetch\`](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests,\\nbut an alternative \`fetch\` implementation can be provided as an option.\\nThis is most useful in environments where \`cross-fetch\` is not compatible (for instance Cloudflare Workers)." - }, - { - "id": "react-native-options-with-asyncstorage", - "name": "React Native options with AsyncStorage", - "code": "\`\`\`js\\nimport 'react-native-url-polyfill/auto'\\nimport { createClient } from '@supabase/supabase-js'\\nimport AsyncStorage from \\"@react-native-async-storage/async-storage\\";\\n\\nconst supabase = createClient(\\"https://xyzcompany.supabase.co\\", \\"your-publishable-key\\", {\\n auth: {\\n storage: AsyncStorage,\\n autoRefreshToken: true,\\n persistSession: true,\\n detectSessionInUrl: false,\\n },\\n});\\n\`\`\`", - "description": "For React Native we recommend using \`AsyncStorage\` as the storage implementation for Supabase Auth." - }, - { - "id": "react-native-options-with-expo-securestore", - "name": "React Native options with Expo SecureStore", - "code": "\`\`\`ts\\nimport 'react-native-url-polyfill/auto'\\nimport { createClient } from '@supabase/supabase-js'\\nimport AsyncStorage from '@react-native-async-storage/async-storage';\\nimport * as SecureStore from 'expo-secure-store';\\nimport * as aesjs from 'aes-js';\\nimport 'react-native-get-random-values';\\n\\n// As Expo's SecureStore does not support values larger than 2048\\n// bytes, an AES-256 key is generated and stored in SecureStore, while\\n// it is used to encrypt/decrypt values stored in AsyncStorage.\\nclass LargeSecureStore {\\n private async _encrypt(key: string, value: string) {\\n const encryptionKey = crypto.getRandomValues(new Uint8Array(256 / 8));\\n\\n const cipher = new aesjs.ModeOfOperation.ctr(encryptionKey, new aesjs.Counter(1));\\n const encryptedBytes = cipher.encrypt(aesjs.utils.utf8.toBytes(value));\\n\\n await SecureStore.setItemAsync(key, aesjs.utils.hex.fromBytes(encryptionKey));\\n\\n return aesjs.utils.hex.fromBytes(encryptedBytes);\\n }\\n\\n private async _decrypt(key: string, value: string) {\\n const encryptionKeyHex = await SecureStore.getItemAsync(key);\\n if (!encryptionKeyHex) {\\n return encryptionKeyHex;\\n }\\n\\n const cipher = new aesjs.ModeOfOperation.ctr(aesjs.utils.hex.toBytes(encryptionKeyHex), new aesjs.Counter(1));\\n const decryptedBytes = cipher.decrypt(aesjs.utils.hex.toBytes(value));\\n\\n return aesjs.utils.utf8.fromBytes(decryptedBytes);\\n }\\n\\n async getItem(key: string) {\\n const encrypted = await AsyncStorage.getItem(key);\\n if (!encrypted) { return encrypted; }\\n\\n return await this._decrypt(key, encrypted);\\n }\\n\\n async removeItem(key: string) {\\n await AsyncStorage.removeItem(key);\\n await SecureStore.deleteItemAsync(key);\\n }\\n\\n async setItem(key: string, value: string) {\\n const encrypted = await this._encrypt(key, value);\\n\\n await AsyncStorage.setItem(key, encrypted);\\n }\\n}\\n\\nconst supabase = createClient(\\"https://xyzcompany.supabase.co\\", \\"your-publishable-key\\", {\\n auth: {\\n storage: new LargeSecureStore(),\\n autoRefreshToken: true,\\n persistSession: true,\\n detectSessionInUrl: false,\\n },\\n});\\n\`\`\`", - "description": "If you wish to encrypt the user's session information, you can use \`aes-js\` and store the encryption key in Expo SecureStore.\\nThe \`aes-js\` library, a reputable JavaScript-only implementation of the AES encryption algorithm in CTR mode.\\nA new 256-bit encryption key is generated using the \`react-native-get-random-values\` library.\\nThis key is stored inside Expo's SecureStore, while the value is encrypted and placed inside AsyncStorage.\\n\\nPlease make sure that:\\n- You keep the \`expo-secure-store\`, \`aes-js\` and \`react-native-get-random-values\` libraries up-to-date.\\n- Choose the correct [\`SecureStoreOptions\`](https://docs.expo.dev/versions/latest/sdk/securestore/#securestoreoptions) for your app's needs.\\n E.g. [\`SecureStore.WHEN_UNLOCKED\`](https://docs.expo.dev/versions/latest/sdk/securestore/#securestorewhen_unlocked) regulates when the data can be accessed.\\n- Carefully consider optimizations or other modifications to the above example, as those can lead to introducing subtle security vulnerabilities." - }, - { - "id": "with-a-database-query", - "name": "With a database query", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\n\\nconst { data } = await supabase.from('profiles').select('*')\\n\`\`\`" - }, - { - "id": "with-opentelemetry-tracing", - "name": "With OpenTelemetry tracing", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\nimport { trace } from '@opentelemetry/api'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\\n tracePropagation: true,\\n})\\n\\nconst tracer = trace.getTracer('my-app')\\n\\nawait tracer.startActiveSpan('fetch-users', async (span) => {\\n // Outgoing request carries the active trace context.\\n const { data, error } = await supabase.from('users').select('*')\\n span.end()\\n})\\n\`\`\`", - "description": "Opt in to W3C trace context propagation so the \`trace_id\` from your\\nclient-side spans is attached to Supabase requests and appears in API\\nGateway and Edge Function logs. Requires \`@opentelemetry/api\` to be\\ninstalled in your application. See [Tracing with the JS SDK](https://supabase.com/docs/guides/telemetry/client-side-tracing)." - } - ] - } - }, - "@supabase/supabase-js.SupabaseClient.channel": { - "name": "@supabase/supabase-js.SupabaseClient.channel", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The name of the Realtime channel." - } - }, - { - "name": "opts", - "type": { - "name": "RealtimeChannelOptions", - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "object", - "properties": [ - { - "name": "broadcast", - "type": { - "type": "object", - "properties": [ - { - "name": "ack", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "replay", - "type": { - "type": "nameOnly", - "name": "ReplayOption" - }, - "isOptional": true - }, - { - "name": "self", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "self option enables client to receive message it broadcast\\nack option instructs server to acknowledge that broadcast message was received\\nreplay option instructs server to replay broadcast messages" - } - }, - { - "name": "presence", - "type": { - "type": "object", - "properties": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "key option is used to track presence payload across clients" - } - }, - { - "name": "private", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - } - } - ] - } - } - ] - }, - "comment": { - "shortText": "The options to pass to the Realtime channel." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." - } - }, - "@supabase/supabase-js.SupabaseClient.from": { - "name": "@supabase/supabase-js.SupabaseClient.from", - "params": [ - { - "name": "relation", - "type": { - "type": "nameOnly", - "name": "TableName" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestQueryBuilder" - } - }, - "comment": { - "shortText": "Perform a query on a table or a view." - }, - "altSignatures": [ - { - "params": [ - { - "name": "relation", - "type": { - "type": "nameOnly", - "name": "ViewName" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestQueryBuilder" - } - } - } - ] - }, - "@supabase/supabase-js.SupabaseClient.getChannels": { - "name": "@supabase/supabase-js.SupabaseClient.getChannels", - "params": [], - "ret": { - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - } - }, - "comment": { - "shortText": "Returns all Realtime channels.", - "examples": [ - { - "id": "get-all-channels", - "name": "Get all channels", - "code": "\`\`\`js\\nconst channels = supabase.getChannels()\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.SupabaseClient.removeAllChannels": { - "name": "@supabase/supabase-js.SupabaseClient.removeAllChannels", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "array", - "elemType": { - "type": "union", - "name": "RealtimeRemoveChannelResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - } - }, - "comment": { - "shortText": "Unsubscribes and removes all Realtime channels from Realtime client.", - "text": "- Removing channels is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed.", - "examples": [ - { - "id": "remove-all-channels", - "name": "Remove all channels", - "code": "\`\`\`js\\nsupabase.removeAllChannels()\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.SupabaseClient.removeChannel": { - "name": "@supabase/supabase-js.SupabaseClient.removeChannel", - "params": [ - { - "name": "channel", - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - }, - "comment": { - "shortText": "The name of the Realtime channel." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeRemoveChannelResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Unsubscribes and removes Realtime channel from Realtime client.", - "text": "- Removing a channel is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed.", - "examples": [ - { - "id": "removes-a-channel", - "name": "Removes a channel", - "code": "\`\`\`js\\nsupabase.removeChannel(myChannel)\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.SupabaseClient.rpc": { - "name": "@supabase/supabase-js.SupabaseClient.rpc", - "params": [ - { - "name": "fn", - "type": { - "type": "nameOnly", - "name": "FnName" - }, - "comment": { - "shortText": "The function name to call" - } - }, - { - "name": "args", - "type": { - "type": "nameOnly", - "name": "Args" - }, - "comment": { - "shortText": "The arguments to pass to the function call" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count rows returned by the\\nfunction. Only applicable for [set-returning\\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - }, - { - "name": "get", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When set to \`true\`, the function will be called with\\nread-only access mode." - } - }, - { - "name": "head", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When set to \`true\`, \`data\` will not be returned.\\nUseful if you only need the count." - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a function call." - } - }, - "@supabase/supabase-js.SupabaseClient.schema": { - "name": "@supabase/supabase-js.SupabaseClient.schema", - "params": [ - { - "name": "schema", - "type": { - "type": "nameOnly", - "name": "DynamicSchema" - }, - "comment": { - "shortText": "The schema to query" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestClient" - } - }, - "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.\\n\\nThe schema needs to be on the list of exposed schemas inside Supabase." - } - }, - "@supabase/supabase-js.WebSocketFactory.getWebSocketConstructor": { - "name": "@supabase/supabase-js.WebSocketFactory.getWebSocketConstructor", - "params": [], - "ret": { - "type": { - "type": "function", - "params": [ - { - "name": "url", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "protocols", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "WebSocket" - } - } - } - }, - "comment": { - "shortText": "Returns the best available WebSocket constructor for the current runtime.", - "examples": [ - { - "id": "example-with-error-handling", - "name": "Example with error handling", - "code": "\`\`\`ts\\ntry {\\n const WS = WebSocketFactory.getWebSocketConstructor()\\n const socket = new WS('wss://example.com/socket')\\n} catch (error) {\\n console.error('WebSocket not available in this environment.', error)\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.WebSocketFactory.isWebSocketSupported": { - "name": "@supabase/supabase-js.WebSocketFactory.isWebSocketSupported", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Detects whether the runtime can establish WebSocket connections.", - "examples": [ - { - "id": "example-in-a-node-js-script", - "name": "Example in a Node.js script", - "code": "\`\`\`ts\\nif (!WebSocketFactory.isWebSocketSupported()) {\\n console.error('WebSockets are required for this script.')\\n process.exitCode = 1\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/supabase-js.WebSocketLike.addEventListener": { - "name": "@supabase/supabase-js.WebSocketLike.addEventListener", - "params": [ - { - "name": "type", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "listener", - "type": { - "type": "nameOnly", - "name": "EventListener" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Registers an event listener on the socket (compatible with browser WebSocket API)." - } - }, - "@supabase/supabase-js.WebSocketLike.close": { - "name": "@supabase/supabase-js.WebSocketLike.close", - "params": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Closes the socket, optionally providing a close code and reason." - } - }, - "@supabase/supabase-js.WebSocketLike.removeEventListener": { - "name": "@supabase/supabase-js.WebSocketLike.removeEventListener", - "params": [ - { - "name": "type", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "listener", - "type": { - "type": "nameOnly", - "name": "EventListener" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Removes a previously registered event listener." - } - }, - "@supabase/supabase-js.WebSocketLike.send": { - "name": "@supabase/supabase-js.WebSocketLike.send", - "params": [ - { - "name": "data", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "nameOnly", - "name": "ArrayBufferLike" - }, - { - "type": "nameOnly", - "name": "ArrayBufferView" - }, - { - "type": "nameOnly", - "name": "Blob" - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Sends data through the socket using the underlying implementation." - } - }, - "@supabase/supabase-js.WebSocketLikeConstructor.constructor": { - "name": "@supabase/supabase-js.WebSocketLikeConstructor.constructor", - "params": [ - { - "name": "address", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "subprotocols", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "object", - "name": "WebSocketLike", - "properties": [ - { - "name": "binaryType", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "bufferedAmount", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "CLOSED", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "CLOSING", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "CONNECTING", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "dispatchEvent", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "nameOnly", - "name": "Event" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - }, - "isOptional": true - }, - { - "name": "extensions", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "onclose", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "this", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ev", - "type": { - "type": "nameOnly", - "name": "CloseEvent" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - } - }, - { - "name": "onerror", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "this", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ev", - "type": { - "type": "nameOnly", - "name": "Event" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - } - }, - { - "name": "onmessage", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "this", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ev", - "type": { - "type": "nameOnly", - "name": "MessageEvent" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - } - }, - { - "name": "onopen", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "this", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ev", - "type": { - "type": "nameOnly", - "name": "Event" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - } - }, - { - "name": "OPEN", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "protocol", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "readyState", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - }, - "variables": {} - }, - { - "name": "@supabase/auth-js", - "methods": { - "@supabase/auth-js.AuthApiError.constructor": { - "name": "@supabase/auth-js.AuthApiError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthApiError" - } - } - }, - "@supabase/auth-js.AuthApiError.toJSON": { - "name": "@supabase/auth-js.AuthApiError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthError.constructor": { - "name": "@supabase/auth-js.AuthError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - }, - "@supabase/auth-js.AuthError.toJSON": { - "name": "@supabase/auth-js.AuthError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthImplicitGrantRedirectError.constructor": { - "name": "@supabase/auth-js.AuthImplicitGrantRedirectError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "details", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthImplicitGrantRedirectError" - } - } - }, - "@supabase/auth-js.AuthImplicitGrantRedirectError.toJSON": { - "name": "@supabase/auth-js.AuthImplicitGrantRedirectError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "details", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthInvalidCredentialsError.constructor": { - "name": "@supabase/auth-js.AuthInvalidCredentialsError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthInvalidCredentialsError" - } - } - }, - "@supabase/auth-js.AuthInvalidCredentialsError.toJSON": { - "name": "@supabase/auth-js.AuthInvalidCredentialsError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@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.AuthInvalidJwtError.toJSON": { - "name": "@supabase/auth-js.AuthInvalidJwtError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthInvalidTokenResponseError.constructor": { - "name": "@supabase/auth-js.AuthInvalidTokenResponseError.constructor", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthInvalidTokenResponseError" - } - } - }, - "@supabase/auth-js.AuthInvalidTokenResponseError.toJSON": { - "name": "@supabase/auth-js.AuthInvalidTokenResponseError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthPKCECodeVerifierMissingError.constructor": { - "name": "@supabase/auth-js.AuthPKCECodeVerifierMissingError.constructor", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthPKCECodeVerifierMissingError" - } - } - }, - "@supabase/auth-js.AuthPKCECodeVerifierMissingError.toJSON": { - "name": "@supabase/auth-js.AuthPKCECodeVerifierMissingError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.constructor": { - "name": "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "details", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthPKCEGrantCodeExchangeError" - } - } - }, - "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.toJSON": { - "name": "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "details", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthRefreshDiscardedError.constructor": { - "name": "@supabase/auth-js.AuthRefreshDiscardedError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthRefreshDiscardedError" - } - } - }, - "@supabase/auth-js.AuthRefreshDiscardedError.toJSON": { - "name": "@supabase/auth-js.AuthRefreshDiscardedError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthRetryableFetchError.constructor": { - "name": "@supabase/auth-js.AuthRetryableFetchError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthRetryableFetchError" - } - } - }, - "@supabase/auth-js.AuthRetryableFetchError.toJSON": { - "name": "@supabase/auth-js.AuthRetryableFetchError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthSessionMissingError.constructor": { - "name": "@supabase/auth-js.AuthSessionMissingError.constructor", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthSessionMissingError" - } - } - }, - "@supabase/auth-js.AuthSessionMissingError.toJSON": { - "name": "@supabase/auth-js.AuthSessionMissingError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthUnknownError.constructor": { - "name": "@supabase/auth-js.AuthUnknownError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "originalError", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthUnknownError" - } - } - }, - "@supabase/auth-js.AuthUnknownError.toJSON": { - "name": "@supabase/auth-js.AuthUnknownError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.AuthWeakPasswordError.constructor": { - "name": "@supabase/auth-js.AuthWeakPasswordError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "reasons", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "AuthWeakPasswordError" - } - } - }, - "@supabase/auth-js.AuthWeakPasswordError.toJSON": { - "name": "@supabase/auth-js.AuthWeakPasswordError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "reasons", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.CustomAuthError.constructor": { - "name": "@supabase/auth-js.CustomAuthError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "CustomAuthError" - } - } - }, - "@supabase/auth-js.CustomAuthError.toJSON": { - "name": "@supabase/auth-js.CustomAuthError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - null, - { - "type": "nameOnly", - "name": "ErrorCode" - } - ] - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ] - } - } - }, - "@supabase/auth-js.GoTrueAdminApi.constructor": { - "name": "@supabase/auth-js.GoTrueAdminApi.constructor", - "params": [ - { - "type": { - "type": "object", - "properties": [ - { - "name": "experimental", - "type": { - "name": "ExperimentalFeatureFlags", - "type": "object", - "properties": [ - { - "name": "passkey", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Enables passkey support:\\n - \`auth.signInWithPasskey()\`, \`auth.registerPasskey()\`\\n - \`auth.passkey.*\`\\n - \`auth.admin.passkey.*\`\\n\\nDefaults to \`false\`. Calling any passkey method while this flag is\\ndisabled throws a descriptive error at call time." - } - } - ] - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "URL" - }, - { - "type": "nameOnly", - "name": "RequestInfo" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "GoTrueAdminApi" - } - }, - "comment": { - "shortText": "Creates an admin API client that can be used to manage users and OAuth clients.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\\nconst { data, error } = await supabase.auth.admin.listUsers()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { GoTrueAdminApi } from '@supabase/auth-js'\\n\\nconst admin = new GoTrueAdminApi({\\n url: 'https://xyzcompany.supabase.co/auth/v1',\\n headers: { Authorization: \`Bearer \${process.env.SUPABASE_SECRET_KEY}\` },\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminCustomProvidersApi.createProvider": { - "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.createProvider", - "params": [ - { - "name": "params", - "type": { - "name": "CreateCustomProviderParams", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client secret (write-only, not returned in responses)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "CustomProviderResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "CustomOAuthProvider", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was created" - } - }, - { - "name": "discovery_document", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OIDCDiscoveryDocument", - "type": "object", - "properties": [ - { - "name": "authorization_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the authorization endpoint" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The issuer identifier" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the JSON Web Key Set" - } - }, - { - "name": "revocation_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the revocation endpoint" - } - }, - { - "name": "supported_id_token_signing_algs", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported ID token signing algorithms" - } - }, - { - "name": "supported_response_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported response types" - } - }, - { - "name": "supported_scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported scopes" - } - }, - { - "name": "supported_subject_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported subject types" - } - }, - { - "name": "token_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the token endpoint" - } - }, - { - "name": "userinfo_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the userinfo endpoint" - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery document (OIDC providers only)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier (UUID)" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was last updated" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new custom OIDC/OAuth provider.\\n\\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\\nfrom the issuer's well-known endpoint (or the provided \`discovery_url\`) at creation time.\\nThis may return a validation error (\`error_code: \\"validation_failed\\"\`) if the discovery\\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\\nin the document does not match the expected issuer.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminCustomProvidersApi.deleteProvider": { - "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.deleteProvider", - "params": [ - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a custom provider.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminCustomProvidersApi.getProvider": { - "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.getProvider", - "params": [ - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "CustomProviderResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "CustomOAuthProvider", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was created" - } - }, - { - "name": "discovery_document", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OIDCDiscoveryDocument", - "type": "object", - "properties": [ - { - "name": "authorization_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the authorization endpoint" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The issuer identifier" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the JSON Web Key Set" - } - }, - { - "name": "revocation_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the revocation endpoint" - } - }, - { - "name": "supported_id_token_signing_algs", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported ID token signing algorithms" - } - }, - { - "name": "supported_response_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported response types" - } - }, - { - "name": "supported_scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported scopes" - } - }, - { - "name": "supported_subject_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported subject types" - } - }, - { - "name": "token_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the token endpoint" - } - }, - { - "name": "userinfo_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the userinfo endpoint" - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery document (OIDC providers only)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier (UUID)" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was last updated" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Gets details of a specific custom provider by identifier.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminCustomProvidersApi.listProviders": { - "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.listProviders", - "params": [ - { - "name": "params", - "type": { - "name": "ListCustomProvidersParams", - "type": "object", - "properties": [ - { - "name": "type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Filter by provider type" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "CustomProviderListResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "name": "CustomOAuthProvider", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was created" - } - }, - { - "name": "discovery_document", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OIDCDiscoveryDocument", - "type": "object", - "properties": [ - { - "name": "authorization_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the authorization endpoint" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The issuer identifier" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the JSON Web Key Set" - } - }, - { - "name": "revocation_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the revocation endpoint" - } - }, - { - "name": "supported_id_token_signing_algs", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported ID token signing algorithms" - } - }, - { - "name": "supported_response_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported response types" - } - }, - { - "name": "supported_scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported scopes" - } - }, - { - "name": "supported_subject_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported subject types" - } - }, - { - "name": "token_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the token endpoint" - } - }, - { - "name": "userinfo_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the userinfo endpoint" - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery document (OIDC providers only)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier (UUID)" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was last updated" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "providers" - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all custom providers with optional type filter.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminCustomProvidersApi.updateProvider": { - "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.updateProvider", - "params": [ - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "params", - "type": { - "name": "UpdateCustomProviderParams", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth client secret (write-only, not returned in responses)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "CustomProviderResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "CustomOAuthProvider", - "type": "object", - "properties": [ - { - "name": "acceptable_client_ids", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional client IDs accepted during token validation" - } - }, - { - "name": "attribute_mapping", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Mapping of provider attributes to Supabase user attributes" - } - }, - { - "name": "authorization_params", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Additional parameters sent with the authorization request" - } - }, - { - "name": "authorization_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 authorization URL" - } - }, - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OAuth client ID" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was created" - } - }, - { - "name": "discovery_document", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OIDCDiscoveryDocument", - "type": "object", - "properties": [ - { - "name": "authorization_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the authorization endpoint" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The issuer identifier" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the JSON Web Key Set" - } - }, - { - "name": "revocation_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the revocation endpoint" - } - }, - { - "name": "supported_id_token_signing_algs", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported ID token signing algorithms" - } - }, - { - "name": "supported_response_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported response types" - } - }, - { - "name": "supported_scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported scopes" - } - }, - { - "name": "supported_subject_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "List of supported subject types" - } - }, - { - "name": "token_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the token endpoint" - } - }, - { - "name": "userinfo_endpoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL of the userinfo endpoint" - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery document (OIDC providers only)" - } - }, - { - "name": "discovery_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC discovery URL" - } - }, - { - "name": "email_optional", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether email is optional for this provider" - } - }, - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether the provider is enabled" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier (UUID)" - } - }, - { - "name": "identifier", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Provider identifier (e.g. \`custom:mycompany\`)" - } - }, - { - "name": "issuer", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OIDC issuer URL" - } - }, - { - "name": "jwks_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "JWKS URI for token verification" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name" - } - }, - { - "name": "pkce_enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether PKCE is enabled" - } - }, - { - "name": "provider_type", - "type": { - "type": "union", - "name": "CustomProviderType", - "subTypes": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - }, - "comment": { - "shortText": "Provider type" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "OAuth scopes requested during authorization" - } - }, - { - "name": "skip_nonce_check", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to skip nonce check (OIDC)" - } - }, - { - "name": "token_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 token URL" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the provider was last updated" - } - }, - { - "name": "userinfo_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "OAuth2 userinfo URL" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates an existing custom provider.\\n\\nWhen \`issuer\` or \`discovery_url\` is changed on an OIDC provider, the server re-fetches and\\nvalidates the discovery document before persisting. This may return a validation error\\n(\`error_code: \\"validation_failed\\"\`) if the discovery document is unreachable, invalid, or\\nthe issuer does not match.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminMFAApi.deleteFactor": { - "name": "@supabase/auth-js.GoTrueAdminMFAApi.deleteFactor", - "params": [ - { - "name": "params", - "type": { - "name": "AuthMFAAdminDeleteFactorParams", - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the MFA factor to delete." - } - }, - { - "name": "userId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the user whose factor is being deleted." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAAdminDeleteFactorResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor that was successfully deleted." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\\nsessions if the deleted factor was verified.", - "examples": [ - { - "id": "delete-a-factor-for-a-user", - "name": "Delete a factor for a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminMFAApi.listFactors": { - "name": "@supabase/auth-js.GoTrueAdminMFAApi.listFactors", - "params": [ - { - "name": "params", - "type": { - "name": "AuthMFAAdminListFactorsParams", - "type": "object", - "properties": [ - { - "name": "userId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the user." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAAdminListFactorsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "nameOnly", - "name": "Type" - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "nameOnly", - "name": "Status" - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "comment": { - "shortText": "All factors attached to the user." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all factors associated to a user.", - "examples": [ - { - "id": "list-all-factors-for-a-user", - "name": "List all factors for a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n factors: Factor[\\n {\\n id: '',\\n friendly_name: 'Auth App Factor',\\n factor_type: 'totp',\\n status: 'verified',\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z'\\n }\\n ]\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminOAuthApi.createClient": { - "name": "@supabase/auth-js.GoTrueAdminOAuthApi.createClient", - "params": [ - { - "name": "params", - "type": { - "name": "CreateOAuthClientParams", - "type": "object", - "properties": [ - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of allowed response types (optional, defaults to code)" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Token endpoint authentication method (defaults to server default if not specified)" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthClient", - "type": "object", - "properties": [ - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client" - } - }, - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Client secret (only returned on registration and regeneration)" - } - }, - { - "name": "client_type", - "type": { - "type": "union", - "name": "OAuthClientType", - "subTypes": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - }, - "comment": { - "shortText": "Type of OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was created" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "registration_type", - "type": { - "type": "union", - "name": "OAuthClientRegistrationType", - "subTypes": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - }, - "comment": { - "shortText": "Registration type of the client" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "comment": { - "shortText": "Array of allowed response types" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "comment": { - "shortText": "Token endpoint authentication method" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was last updated" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminOAuthApi.deleteClient": { - "name": "@supabase/auth-js.GoTrueAdminOAuthApi.deleteClient", - "params": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Deletes an OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminOAuthApi.getClient": { - "name": "@supabase/auth-js.GoTrueAdminOAuthApi.getClient", - "params": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthClient", - "type": "object", - "properties": [ - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client" - } - }, - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Client secret (only returned on registration and regeneration)" - } - }, - { - "name": "client_type", - "type": { - "type": "union", - "name": "OAuthClientType", - "subTypes": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - }, - "comment": { - "shortText": "Type of OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was created" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "registration_type", - "type": { - "type": "union", - "name": "OAuthClientRegistrationType", - "subTypes": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - }, - "comment": { - "shortText": "Registration type of the client" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "comment": { - "shortText": "Array of allowed response types" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "comment": { - "shortText": "Token endpoint authentication method" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was last updated" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Gets details of a specific OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminOAuthApi.listClients": { - "name": "@supabase/auth-js.GoTrueAdminOAuthApi.listClients", - "params": [ - { - "name": "params", - "type": { - "name": "PageParams", - "type": "object", - "properties": [ - { - "name": "page", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The page number" - } - }, - { - "name": "perPage", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Number of items returned per page" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientListResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "clients" - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all OAuth clients with optional pagination.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminOAuthApi.regenerateClientSecret": { - "name": "@supabase/auth-js.GoTrueAdminOAuthApi.regenerateClientSecret", - "params": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthClient", - "type": "object", - "properties": [ - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client" - } - }, - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Client secret (only returned on registration and regeneration)" - } - }, - { - "name": "client_type", - "type": { - "type": "union", - "name": "OAuthClientType", - "subTypes": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - }, - "comment": { - "shortText": "Type of OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was created" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "registration_type", - "type": { - "type": "union", - "name": "OAuthClientRegistrationType", - "subTypes": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - }, - "comment": { - "shortText": "Registration type of the client" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "comment": { - "shortText": "Array of allowed response types" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "comment": { - "shortText": "Token endpoint authentication method" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was last updated" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Regenerates the secret for an OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminOAuthApi.updateClient": { - "name": "@supabase/auth-js.GoTrueAdminOAuthApi.updateClient", - "params": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "params", - "type": { - "name": "UpdateOAuthClientParams", - "type": "object", - "properties": [ - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Token endpoint authentication method" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthClientResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthClient", - "type": "object", - "properties": [ - { - "name": "client_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client" - } - }, - { - "name": "client_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "client_secret", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Client secret (only returned on registration and regeneration)" - } - }, - { - "name": "client_type", - "type": { - "type": "union", - "name": "OAuthClientType", - "subTypes": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - }, - "comment": { - "shortText": "Type of OAuth client" - } - }, - { - "name": "client_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client" - } - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was created" - } - }, - { - "name": "grant_types", - "type": { - "type": "array", - "elemType": { - "type": "union", - "name": "OAuthClientGrantType", - "subTypes": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - null - ] - } - }, - "comment": { - "shortText": "Array of allowed grant types" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "redirect_uris", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of allowed redirect URIs" - } - }, - { - "name": "registration_type", - "type": { - "type": "union", - "name": "OAuthClientRegistrationType", - "subTypes": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - }, - "comment": { - "shortText": "Registration type of the client" - } - }, - { - "name": "response_types", - "type": { - "type": "array", - "elemType": { - "type": "literal", - "value": "code", - "name": "OAuthClientResponseType" - } - }, - "comment": { - "shortText": "Array of allowed response types" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Scope of the OAuth client" - } - }, - { - "name": "token_endpoint_auth_method", - "type": { - "type": "union", - "name": "OAuthClientTokenEndpointAuthMethod", - "subTypes": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - }, - "comment": { - "shortText": "Token endpoint authentication method" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the client was last updated" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates an existing OAuth client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminPasskeyApi.deletePasskey": { - "name": "@supabase/auth-js.GoTrueAdminPasskeyApi.deletePasskey", - "params": [ - { - "name": "params", - "type": { - "name": "AuthPasskeyAdminDeleteParams", - "type": "object", - "properties": [ - { - "name": "passkeyId", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "userId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyDeleteResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a specific passkey for a specific user.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminPasskeyApi.listPasskeys": { - "name": "@supabase/auth-js.GoTrueAdminPasskeyApi.listPasskeys", - "params": [ - { - "name": "params", - "type": { - "name": "AuthPasskeyAdminListParams", - "type": "object", - "properties": [ - { - "name": "userId", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyListResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "name": "PasskeyListItem", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_used_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all passkeys registered for a specific user.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - }, - "@supabase/auth-js.GoTrueAdminApi.createUser": { - "name": "@supabase/auth-js.GoTrueAdminApi.createUser", - "params": [ - { - "name": "attributes", - "type": { - "type": "object", - "name": "AdminUserAttributes", - "properties": [ - { - "name": "app_metadata", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column.\\n\\nOnly a service role can modify.\\n\\nThe \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\\naccess control information." - } - }, - { - "name": "ban_duration", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Determines how long a user is banned for.\\n\\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\\nValid time units are \\"ns\\", \\"us\\" (or \\"µs\\"), \\"ms\\", \\"s\\", \\"m\\", \\"h\\".\\n\\nFor example, some possible durations include: '300ms', '2h45m'.\\n\\nSetting the ban duration to 'none' lifts the ban on the user." - } - }, - { - "name": "current_password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's current password\\n\\nThis is only ever present when the user is resetting\\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's email." - } - }, - { - "name": "email_confirm", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Sets the user's email as confirmed when true, or unconfirmed when false.\\n\\nOnly a service role can modify." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`id\` for the user.\\n\\nAllows you to overwrite the default \`id\` set for the user." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." - } - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's password." - } - }, - { - "name": "password_hash", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`password_hash\` for the user's password.\\n\\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\\n\\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's phone." - } - }, - { - "name": "phone_confirm", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Sets the user's phone as confirmed when true, or unconfirmed when false.\\n\\nOnly a service role can modify." - } - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`role\` claim set in the user's access token JWT.\\n\\nWhen a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\\n\\nSetting this role to \`service_role\` is not recommended as it grants the user admin privileges." - } - }, - { - "name": "user_metadata", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\n\\nThe \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\\nthis attribute is used instead of UserAttributes data." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new user.\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser.", - "text": "- To confirm the user's email address or phone number, set \`email_confirm\` or \`phone_confirm\` to true. Both arguments default to false.\\n- \`createUser()\` will not send a confirmation email to the user. You can use [\`inviteUserByEmail()\`](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the \`email_confirm\` or \`phone_confirm\` param to \`true\`.", - "examples": [ - { - "id": "with-custom-user-metadata", - "name": "With custom user metadata", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.createUser({\\n email: 'user@email.com',\\n password: 'password',\\n user_metadata: { name: 'Yoda' }\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n user: {\\n id: '1',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {},\\n user_metadata: {},\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"1\\",\\n \\"user_id\\": \\"1\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"1\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false,\\n }\\n }\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "auto-confirm-the-user-s-email", - "name": "Auto-confirm the user's email", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.createUser({\\n email: 'user@email.com',\\n email_confirm: true\\n})\\n\`\`\`" - }, - { - "id": "auto-confirm-the-user-s-phone-number", - "name": "Auto-confirm the user's phone number", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.createUser({\\n phone: '1234567890',\\n phone_confirm: true\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminApi.deleteUser": { - "name": "@supabase/auth-js.GoTrueAdminApi.deleteUser", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user id you want to remove." - } - }, - { - "name": "shouldSoftDelete", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\\nDefaults to false for backward compatibility.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Delete a user. Requires a \`service_role\` key.", - "text": "- The \`deleteUser()\` method requires the user's ID, which maps to the \`auth.users.id\` column.", - "examples": [ - { - "id": "removes-a-user", - "name": "Removes a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.deleteUser(\\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\\n)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {}\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminApi.generateLink": { - "name": "@supabase/auth-js.GoTrueAdminApi.generateLink", - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "GenerateLinkParams", - "subTypes": [ - { - "name": "GenerateSignupLinkParams", - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "isOptional": true - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "signup" - } - } - ] - }, - { - "name": "GenerateInviteOrMagiclinkParams", - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email" - } - }, - { - "name": "options", - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ] - }, - { - "name": "GenerateRecoveryLinkParams", - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email" - } - }, - { - "name": "options", - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "recovery" - } - } - ] - }, - { - "name": "GenerateEmailChangeLinkParams", - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email" - } - }, - { - "name": "newEmail", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - } - }, - { - "name": "options", - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "GenerateLinkResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "properties", - "type": { - "name": "GenerateLinkProperties", - "type": "object", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The email link to send to the user.\\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - } - }, - { - "name": "email_otp", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The raw email OTP.\\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - } - }, - { - "name": "hashed_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The hashed token appended to the action link." - } - }, - { - "name": "redirect_to", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The URL appended to the action link." - } - }, - { - "name": "verification_type", - "type": { - "type": "union", - "name": "GenerateLinkType", - "subTypes": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - }, - "comment": { - "shortText": "The verification type that the email link is associated to." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "properties", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Generates email links and OTPs to be sent via a custom email provider.", - "text": "- The following types can be passed into \`generateLink()\`: \`signup\`, \`magiclink\`, \`invite\`, \`recovery\`, \`email_change_current\`, \`email_change_new\`, \`phone_change\`.\\n- \`generateLink()\` only generates the email link for \`email_change_email\` if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\\n- \`generateLink()\` handles the creation of the user for \`signup\`, \`invite\` and \`magiclink\`.", - "examples": [ - { - "id": "generate-a-signup-link", - "name": "Generate a signup link", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'signup',\\n email: 'email@example.com',\\n password: 'secret'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"properties\\": {\\n \\"action_link\\": \\"\\",\\n \\"email_otp\\": \\"999999\\",\\n \\"hashed_token\\": \\"\\",\\n \\"verification_type\\": \\"signup\\"\\n },\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"email@example.com\\",\\n \\"phone\\": \\"\\",\\n \\"confirmation_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"email@example.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "generate-an-invite-link", - "name": "Generate an invite link", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'invite',\\n email: 'email@example.com'\\n})\\n\`\`\`" - }, - { - "id": "generate-a-magic-link", - "name": "Generate a magic link", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'magiclink',\\n email: 'email@example.com'\\n})\\n\`\`\`" - }, - { - "id": "generate-a-recovery-link", - "name": "Generate a recovery link", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'recovery',\\n email: 'email@example.com'\\n})\\n\`\`\`" - }, - { - "id": "generate-links-to-change-current-email-address", - "name": "Generate links to change current email address", - "code": "\`\`\`js\\n// generate an email change link to be sent to the current email address\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'email_change_current',\\n email: 'current.email@example.com',\\n newEmail: 'new.email@example.com'\\n})\\n\\n// generate an email change link to be sent to the new email address\\nconst { data, error } = await supabase.auth.admin.generateLink({\\n type: 'email_change_new',\\n email: 'current.email@example.com',\\n newEmail: 'new.email@example.com'\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminApi.getUserById": { - "name": "@supabase/auth-js.GoTrueAdminApi.getUserById", - "params": [ - { - "name": "uid", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's unique identifier\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Get user by id.", - "text": "- Fetches the user object from the database based on the user's id.\\n- The \`getUserById()\` method requires the user's id which maps to the \`auth.users.id\` column.", - "examples": [ - { - "id": "fetch-the-user-object-using-the-access-token-jwt", - "name": "Fetch the user object using the access_token jwt", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.getUserById(1)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n user: {\\n id: '1',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {},\\n user_metadata: {},\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"1\\",\\n \\"user_id\\": \\"1\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"1\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false,\\n }\\n }\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminApi.inviteUserByEmail": { - "name": "@supabase/auth-js.GoTrueAdminApi.inviteUserByEmail", - "params": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The email address of the user." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store additional metadata about the user. This maps to the \`auth.users.user_metadata\` column." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - } - } - ] - }, - "comment": { - "shortText": "Additional options to be included when inviting." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sends an invite link to an email address.", - "text": "- Sends an invite link to the user's email address.\\n- The \`inviteUserByEmail()\` method is typically used by administrators to invite users to join the application.\\n- Note that PKCE is not supported when using \`inviteUserByEmail\`. This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow.", - "examples": [ - { - "id": "invite-a-user", - "name": "Invite a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"invited_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmation_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminApi.listUsers": { - "name": "@supabase/auth-js.GoTrueAdminApi.listUsers", - "params": [ - { - "name": "params", - "type": { - "name": "PageParams", - "type": "object", - "properties": [ - { - "name": "page", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The page number" - } - }, - { - "name": "perPage", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Number of items returned per page" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "An object which supports \`page\` and \`perPage\` as numbers, to alter the paginated results." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "users" - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Get a list of users.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser.", - "text": "- Defaults to return 50 users per page.", - "examples": [ - { - "id": "get-a-page-of-users", - "name": "Get a page of users", - "code": "\`\`\`js\\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\\n\`\`\`" - }, - { - "id": "paginated-list-of-users", - "name": "Paginated list of users", - "code": "\`\`\`js\\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\\n page: 1,\\n perPage: 1000\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueAdminApi.signOut": { - "name": "@supabase/auth-js.GoTrueAdminApi.signOut", - "params": [ - { - "name": "jwt", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A valid, logged-in JWT." - } - }, - { - "name": "scope", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "comment": { - "shortText": "The logout sope." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Removes a logged-in session." - } - }, - "@supabase/auth-js.GoTrueAdminApi.updateUserById": { - "name": "@supabase/auth-js.GoTrueAdminApi.updateUserById", - "params": [ - { - "name": "uid", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's unique identifier" - } - }, - { - "name": "attributes", - "type": { - "type": "object", - "name": "AdminUserAttributes", - "properties": [ - { - "name": "app_metadata", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column.\\n\\nOnly a service role can modify.\\n\\nThe \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\\naccess control information." - } - }, - { - "name": "ban_duration", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Determines how long a user is banned for.\\n\\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\\nValid time units are \\"ns\\", \\"us\\" (or \\"µs\\"), \\"ms\\", \\"s\\", \\"m\\", \\"h\\".\\n\\nFor example, some possible durations include: '300ms', '2h45m'.\\n\\nSetting the ban duration to 'none' lifts the ban on the user." - } - }, - { - "name": "current_password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's current password\\n\\nThis is only ever present when the user is resetting\\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's email." - } - }, - { - "name": "email_confirm", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Sets the user's email as confirmed when true, or unconfirmed when false.\\n\\nOnly a service role can modify." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`id\` for the user.\\n\\nAllows you to overwrite the default \`id\` set for the user." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." - } - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's password." - } - }, - { - "name": "password_hash", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`password_hash\` for the user's password.\\n\\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\\n\\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's phone." - } - }, - { - "name": "phone_confirm", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Sets the user's phone as confirmed when true, or unconfirmed when false.\\n\\nOnly a service role can modify." - } - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The \`role\` claim set in the user's access token JWT.\\n\\nWhen a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database.\\n\\nSetting this role to \`service_role\` is not recommended as it grants the user admin privileges." - } - }, - { - "name": "user_metadata", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\n\\nThe \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name.\\n\\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\\nthis attribute is used instead of UserAttributes data." - } - } - ] - }, - "comment": { - "shortText": "The data you want to update.\\n\\nThis function should only be called on a server. Never expose your \`service_role\` key in the browser." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates the user data. Changes are applied directly without confirmation flows.", - "text": "**Important:** This is a server-side operation and does **not** trigger client-side\\n\`onAuthStateChange\` listeners. The admin API has no connection to client state.\\n\\nTo sync changes to the client after calling this method:\\n1. On the client, call \`supabase.auth.refreshSession()\` to fetch the updated user data\\n2. This will trigger the \`TOKEN_REFRESHED\` event and notify all listeners", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`typescript\\n// Server-side (Edge Function)\\nconst { data, error } = await supabase.auth.admin.updateUserById(\\n userId,\\n { user_metadata: { preferences: { theme: 'dark' } } }\\n)\\n\\n// Client-side (to sync the changes)\\nconst { data, error } = await supabase.auth.refreshSession()\\n// onAuthStateChange listeners will now be notified with updated user\\n\`\`\`" - }, - { - "id": "updates-a-user-s-email", - "name": "Updates a user's email", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '11111111-1111-1111-1111-111111111111',\\n { email: 'new@email.com' }\\n)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"new@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"recovery_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "updates-a-user-s-password", - "name": "Updates a user's password", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { password: 'new_password' }\\n)\\n\`\`\`" - }, - { - "id": "updates-a-user-s-metadata", - "name": "Updates a user's metadata", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { user_metadata: { hello: 'world' } }\\n)\\n\`\`\`" - }, - { - "id": "updates-a-user-s-app-metadata", - "name": "Updates a user's app_metadata", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { app_metadata: { plan: 'trial' } }\\n)\\n\`\`\`" - }, - { - "id": "confirms-a-user-s-email-address", - "name": "Confirms a user's email address", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { email_confirm: true }\\n)\\n\`\`\`" - }, - { - "id": "confirms-a-user-s-phone-number", - "name": "Confirms a user's phone number", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { phone_confirm: true }\\n)\\n\`\`\`" - }, - { - "id": "ban-a-user-for-100-years", - "name": "Ban a user for 100 years", - "code": "\`\`\`js\\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\\n { ban_duration: '876000h' }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.constructor": { - "name": "@supabase/auth-js.GoTrueClient.constructor", - "params": [ - { - "name": "options", - "type": { - "name": "GoTrueClientOptions", - "type": "object", - "properties": [ - { - "name": "autoRefreshToken", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "debug", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "function", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "args", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - ] - }, - "isOptional": true - }, - { - "name": "detectSessionInUrl", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "function", - "params": [ - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "params", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Set to \\"true\\" if you want to automatically detect OAuth grants in the URL and sign in the user.\\nSet to \\"false\\" to disable automatic detection.\\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\\nThe function receives the current URL and parsed parameters, and should return true if the URL\\nshould be processed as a Supabase auth callback, or false to ignore it.\\n\\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\ndetectSessionInUrl: (url, params) => {\\n // Ignore Facebook OAuth redirects\\n if (url.pathname === '/facebook/redirect') return false\\n // Use default detection for other URLs\\n return Boolean(params.access_token || params.error_description)\\n}\\n\`\`\`" - } - ] - } - }, - { - "name": "experimental", - "type": { - "name": "ExperimentalFeatureFlags", - "type": "object", - "properties": [ - { - "name": "passkey", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Enables passkey support:\\n - \`auth.signInWithPasskey()\`, \`auth.registerPasskey()\`\\n - \`auth.passkey.*\`\\n - \`auth.admin.passkey.*\`\\n\\nDefaults to \`false\`. Calling any passkey method while this flag is\\ndisabled throws a descriptive error at call time." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Opt-in flags for experimental features. These APIs may change without\\nnotice and are disabled by default.", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ] - } - }, - { - "name": "fetch", - "type": { - "type": "nameOnly", - "name": "Fetch" - }, - "isOptional": true - }, - { - "name": "flowType", - "type": { - "type": "union", - "name": "AuthFlowType", - "subTypes": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - }, - null - ] - }, - "isOptional": true - }, - { - "name": "hasCustomAuthorizationHeader", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Set to \\"true\\" if there is a custom authorization header set globally.", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ] - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "lock", - "type": { - "name": "LockFunc", - "type": "function", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the lock to be acquired." - } - }, - { - "name": "acquireTimeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "If negative, no timeout should occur. If positive it\\n should throw an Error with an \`isAcquireTimeout\`\\n property set to true if the operation fails to be\\n acquired after this much time (ms)." - } - }, - { - "name": "fn", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "R" - } - } - } - }, - "comment": { - "shortText": "The operation to execute when the lock is acquired." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "R" - } - } - } - }, - "isOptional": true, - "comment": { - "shortText": "Provide your own locking mechanism based on the environment. By default\\nthe client coordinates refreshes itself (single-flight via\\n\`refreshingDeferred\` + commit guard) and relies on the GoTrue server to\\nresolve cross-tab refresh races. Passing a custom lock opts into a\\nlegacy path that wraps every auth operation in your supplied lock — this\\npath is preserved for backwards compatibility (typically React Native\\n\`processLock\` or Node multi-process setups)." - } - }, - { - "name": "lockAcquireTimeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The maximum time in milliseconds to wait for acquiring the custom lock\\nsupplied via the \`lock\` option. Only consulted when a custom \`lock\` is\\npassed — the default lockless path doesn't use this timeout." - } - }, - { - "name": "persistSession", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "skipAutoInitialize", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If true, skips automatic initialization in constructor. Useful for SSR\\ncontexts where initialization timing must be controlled to prevent race\\nconditions with HTTP response generation." - } - }, - { - "name": "storage", - "type": { - "type": "nameOnly", - "name": "SupportedStorage" - }, - "isOptional": true - }, - { - "name": "storageKey", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "throwOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If there is an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response." - } - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "userStorage", - "type": { - "type": "nameOnly", - "name": "SupportedStorage" - }, - "isOptional": true, - "comment": { - "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, \`storage\` will only store a JSON object containing the access and refresh token and some adjacent metadata, while \`userStorage\` will only contain the user object under the key \`storageKey + '-user'\`.\\n\\nWhen this option is set and cookie storage is used, \`getSession()\` and other functions that load a session from the cookie store might not return back a user. It's very important to always use \`getUser()\` to fetch a user object in those scenarios.", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ] - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "GoTrueClient" - } - }, - "comment": { - "shortText": "Create a new client for use in the browser.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.auth.getUser()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { GoTrueClient } from '@supabase/auth-js'\\n\\nconst auth = new GoTrueClient({\\n url: 'https://xyzcompany.supabase.co/auth/v1',\\n headers: { apikey: 'your-publishable-key' },\\n storageKey: 'supabase-auth',\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueMFAApi.challenge": { - "name": "@supabase/auth-js.GoTrueMFAApi.challenge", - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAChallengeParamsBase" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "AuthMFAChallengeResponseBase" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\\nfactor.", - "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\\n- To verify a challenge, see [\`mfa.verify()\`](/docs/reference/javascript/auth-mfa-verify).\\n- A phone factor sends a code to the user upon challenge. The channel defaults to \`sms\` unless otherwise specified.", - "examples": [ - { - "id": "create-a-challenge-for-a-factor", - "name": "Create a challenge for a factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.challenge({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n type: 'totp',\\n expires_at: 1700000000\\n },\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "create-a-challenge-for-a-phone-factor", - "name": "Create a challenge for a phone factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.challenge({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n type: 'phone',\\n expires_at: 1700000000\\n },\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "create-a-challenge-for-a-phone-factor-whatsapp", - "name": "Create a challenge for a phone factor (WhatsApp)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.challenge({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n channel: 'whatsapp',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n expires_at: 1700000000\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAChallengePhoneParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "AuthMFAChallengeResponseBase" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAChallengeWebauthnParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "MFAChallengeParams", - "subTypes": [ - { - "type": "nameOnly", - "name": "MFAChallengeTOTPParams" - }, - { - "type": "nameOnly", - "name": "MFAChallengePhoneParams" - }, - { - "type": "nameOnly", - "name": "MFAChallengeWebauthnParams" - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAChallengeResponse", - "subTypes": [ - { - "type": "union", - "name": "AuthMFAChallengeTOTPResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - }, - { - "type": "union", - "name": "AuthMFAChallengePhoneResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - }, - { - "type": "union", - "name": "AuthMFAChallengeWebauthnResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - ] - } - } - } - } - ] - }, - "@supabase/auth-js.GoTrueMFAApi.challengeAndVerify": { - "name": "@supabase/auth-js.GoTrueMFAApi.challengeAndVerify", - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAChallengeAndVerifyTOTPParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\\nprovided by the user by entering a code seen in their authenticator app.", - "text": "- Intended for use with only TOTP factors.\\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking \`challengeAndVerify()\`.\\n- Executes [\`mfa.challenge()\`](/docs/reference/javascript/auth-mfa-challenge) and [\`mfa.verify()\`](/docs/reference/javascript/auth-mfa-verify) in a single step.", - "examples": [ - { - "id": "create-and-verify-a-challenge-for-a-factor", - "name": "Create and verify a challenge for a factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n code: '123456'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n access_token: '',\\n token_type: 'Bearer',\\n expires_in: 3600,\\n refresh_token: '',\\n user: {\\n id: '11111111-1111-1111-1111-111111111111',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {\\n provider: 'email',\\n providers: [\\n \\"email\\",\\n ]\\n },\\n user_metadata: {},\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false,\\n factors: [\\n \\"id\\": '',\\n \\"friendly_name\\": 'Important Auth App',\\n \\"factor_type\\": 'totp',\\n \\"status\\": 'verified',\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n ]\\n }\\n }\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueMFAApi.enroll": { - "name": "@supabase/auth-js.GoTrueMFAApi.enroll", - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAEnrollTOTPParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAEnrollTOTPResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\\nfactor. This method creates a new \`unverified\` factor.\\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\\nauthenticator app.\\nThe user has to enter the code from their authenticator app to verify it.\\n\\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to \`aal2\`.", - "text": "- Use \`totp\` or \`phone\` as the \`factorType\` and use the returned \`id\` to create a challenge.\\n- To create a challenge, see [\`mfa.challenge()\`](/docs/reference/javascript/auth-mfa-challenge).\\n- To verify a challenge, see [\`mfa.verify()\`](/docs/reference/javascript/auth-mfa-verify).\\n- To create and verify a TOTP challenge in a single step, see [\`mfa.challengeAndVerify()\`](/docs/reference/javascript/auth-mfa-challengeandverify).\\n- To generate a QR code for the \`totp\` secret in Next.js, you can do the following:\\n\`\`\`html\\n{data.totp.uri}\\n\`\`\`\\n- The \`challenge\` and \`verify\` steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge.", - "examples": [ - { - "id": "enroll-a-time-based-one-time-password-totp-factor", - "name": "Enroll a time-based, one-time password (TOTP) factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.enroll({\\n factorType: 'totp',\\n friendlyName: 'your_friendly_name'\\n})\\n\\n// Use the id to create a challenge.\\n// The challenge can be verified by entering the code generated from the authenticator app.\\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n type: 'totp'\\n totp: {\\n qr_code: '',\\n secret: '',\\n uri: '',\\n }\\n friendly_name?: 'Important app'\\n },\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "enroll-a-phone-factor", - "name": "Enroll a Phone Factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.enroll({\\n factorType: 'phone',\\n friendlyName: 'your_friendly_name',\\n phone: '+12345678',\\n})\\n\\n// Use the id to create a challenge and send an SMS with a code to the user.\\nconst { id, type, friendly_name, phone } = data\\n\\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: '',\\n type: 'phone',\\n friendly_name?: 'Important app',\\n phone: '+5787123456'\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAEnrollPhoneParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAEnrollPhoneResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAEnrollParamsBase" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAEnrollWebauthnResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "MFAEnrollParams", - "subTypes": [ - { - "type": "nameOnly", - "name": "MFAEnrollTOTPParams" - }, - { - "type": "nameOnly", - "name": "MFAEnrollPhoneParams" - }, - { - "type": "nameOnly", - "name": "MFAEnrollWebauthnParams" - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAEnrollResponse", - "subTypes": [ - { - "type": "union", - "name": "AuthMFAEnrollTOTPResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - }, - { - "type": "union", - "name": "AuthMFAEnrollPhoneResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - }, - { - "type": "union", - "name": "AuthMFAEnrollWebauthnResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - ] - } - } - } - } - ] - }, - "@supabase/auth-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel": { - "name": "@supabase/auth-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel", - "params": [ - { - "name": "jwt", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "currentAuthenticationMethods", - "type": { - "type": "union", - "subTypes": [ - { - "type": "array", - "elemType": { - "type": "object", - "name": "AMREntry", - "properties": [ - { - "name": "method", - "type": { - "type": "union", - "name": "AMRMethod", - "subTypes": [ - { - "type": "nameOnly", - "name": "['number']" - }, - null - ] - }, - "comment": { - "shortText": "Authentication method name." - } - }, - { - "name": "timestamp", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - } - ] - } - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "comment": { - "shortText": "A list of all authentication methods attached to this session. Use\\nthe information here to detect the last time a user verified a\\nfactor, for example if implementing a step-up scenario.\\n\\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\\n- String format: ['password', 'otp'] - RFC-8176 compliant\\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - }, - { - "name": "currentLevel", - "type": { - "type": "union", - "subTypes": [ - { - "type": "union", - "name": "AuthenticatorAssuranceLevels", - "subTypes": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - null - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "comment": { - "shortText": "Current AAL level of the session." - } - }, - { - "name": "nextLevel", - "type": { - "type": "union", - "subTypes": [ - { - "type": "union", - "name": "AuthenticatorAssuranceLevels", - "subTypes": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - null - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "comment": { - "shortText": "Next possible AAL level for the session. If the next level is higher\\nthan the current one, the user should go through MFA." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.\\n\\n- \`aal1\` (or \`null\`) means that the user's identity has been verified only\\nwith a conventional login (email+password, OTP, magic link, social login,\\netc.).\\n- \`aal2\` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\\n\\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\\nand rarely uses the network. When a JWT is provided (useful in server-side\\nenvironments like Edge Functions where no session is stored), this method\\nwill make a network request to validate the user and fetch their MFA factors.", - "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\\n- In Supabase, having an AAL of \`aal1\` refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while \`aal2\` refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\\n- If the user has a verified factor, the \`nextLevel\` field will return \`aal2\`, else, it will return \`aal1\`.\\n- An optional \`jwt\` parameter can be passed to check the AAL level of a specific JWT instead of the current session.", - "examples": [ - { - "id": "get-the-aal-details-of-a-session", - "name": "Get the AAL details of a session", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n currentLevel: 'aal1',\\n nextLevel: 'aal2',\\n currentAuthenticationMethods: [\\n {\\n method: 'password',\\n timestamp: 1700000000\\n }\\n ]\\n }\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "get-the-aal-details-for-a-specific-jwt", - "name": "Get the AAL details for a specific JWT", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueMFAApi.listFactors": { - "name": "@supabase/auth-js.GoTrueMFAApi.listFactors", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAListFactorsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Returns the list of MFA factors enabled for this user." - } - }, - "@supabase/auth-js.GoTrueMFAApi.unenroll": { - "name": "@supabase/auth-js.GoTrueMFAApi.unenroll", - "params": [ - { - "name": "params", - "type": { - "name": "MFAUnenrollParams", - "type": "object", - "properties": [ - { - "name": "factorId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor being unenrolled." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAUnenrollResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor that was successfully unenrolled." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Unenroll removes a MFA factor.\\nA user has to have an \`aal2\` authenticator level in order to unenroll a \`verified\` factor.", - "examples": [ - { - "id": "unenroll-a-factor", - "name": "Unenroll a factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.unenroll({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n id: ''\\n },\\n error: null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueMFAApi.verify": { - "name": "@supabase/auth-js.GoTrueMFAApi.verify", - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAVerifyTOTPParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Verifies a code against a challenge. The verification code is\\nprovided by the user by entering a code seen in their authenticator app.", - "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first.", - "examples": [ - { - "id": "verify-a-challenge-for-a-factor", - "name": "Verify a challenge for a factor", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.mfa.verify({\\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\\n code: '123456'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n access_token: '',\\n token_type: 'Bearer',\\n expires_in: 3600,\\n refresh_token: '',\\n user: {\\n id: '11111111-1111-1111-1111-111111111111',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {\\n provider: 'email',\\n providers: [\\n \\"email\\",\\n ]\\n },\\n user_metadata: {},\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false,\\n factors: [\\n \\"id\\": '',\\n \\"friendly_name\\": 'Important Auth App',\\n \\"factor_type\\": 'totp',\\n \\"status\\": 'verified',\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n ]\\n }\\n }\\n error: null\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAVerifyPhoneParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "nameOnly", - "name": "MFAVerifyWebauthnParams" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - }, - { - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "MFAVerifyParams", - "subTypes": [ - { - "type": "nameOnly", - "name": "MFAVerifyTOTPParams" - }, - { - "type": "nameOnly", - "name": "MFAVerifyPhoneParams" - }, - { - "type": "nameOnly", - "name": "MFAVerifyWebauthnParams" - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthMFAVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "AuthMFAVerifyResponseData", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New access token (JWT) after successful verification." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - }, - "comment": { - "shortText": "Type of token, always \`bearer\`." - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "Updated user profile." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - } - } - ] - }, - "@supabase/auth-js.AuthOAuthServerApi.approveAuthorization": { - "name": "@supabase/auth-js.AuthOAuthServerApi.approveAuthorization", - "params": [ - { - "name": "authorizationId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The authorization ID to approve" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional parameters" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthConsentResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthRedirect", - "type": "object", - "properties": [ - { - "name": "redirect_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Complete redirect URL with authorization code and state parameters (e.g., \\"https://app.com/callback?code=xxx&state=yyy\\")" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Approves an OAuth authorization request.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nAfter approval, the user's consent is stored and an authorization code is generated.\\nThe response contains a complete redirect URL with the authorization code and state." - } - }, - "@supabase/auth-js.AuthOAuthServerApi.denyAuthorization": { - "name": "@supabase/auth-js.AuthOAuthServerApi.denyAuthorization", - "params": [ - { - "name": "authorizationId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The authorization ID to deny" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional parameters" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthConsentResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "OAuthRedirect", - "type": "object", - "properties": [ - { - "name": "redirect_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Complete redirect URL with authorization code and state parameters (e.g., \\"https://app.com/callback?code=xxx&state=yyy\\")" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Denies an OAuth authorization request.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nAfter denial, the response contains a redirect URL with an OAuth error\\n(access_denied) to inform the OAuth client that the user rejected the request." - } - }, - "@supabase/auth-js.AuthOAuthServerApi.getAuthorizationDetails": { - "name": "@supabase/auth-js.AuthOAuthServerApi.getAuthorizationDetails", - "params": [ - { - "name": "authorizationId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The authorization ID from the authorization request" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthAuthorizationDetailsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "union", - "subTypes": [ - { - "name": "OAuthAuthorizationDetails", - "type": "object", - "properties": [ - { - "name": "authorization_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The authorization ID used to approve or deny the request" - } - }, - { - "name": "client", - "type": { - "name": "OAuthAuthorizationClient", - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client (UUID)" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URI of the OAuth client's website" - } - } - ] - }, - "comment": { - "shortText": "OAuth client requesting authorization" - } - }, - { - "name": "redirect_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The OAuth client's registered redirect URI (base URI without query parameters)" - } - }, - { - "name": "scope", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Space-separated list of requested scopes (e.g., \\"openid profile email\\")" - } - }, - { - "name": "user", - "type": { - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "User email" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "User ID (UUID)" - } - } - ] - }, - "comment": { - "shortText": "User object associated with the authorization" - } - } - ] - }, - { - "name": "OAuthRedirect", - "type": "object", - "properties": [ - { - "name": "redirect_url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Complete redirect URL with authorization code and state parameters (e.g., \\"https://app.com/callback?code=xxx&state=yyy\\")" - } - } - ] - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves details about an OAuth authorization request.\\nUsed to display consent information to the user.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nThis method returns one of two response types:\\n- \`OAuthAuthorizationDetails\`: User needs to consent - show consent page with client info\\n- \`OAuthRedirect\`: User already consented - redirect immediately to the OAuth client\\n\\nUse type narrowing to distinguish between the responses:\\n\`\`\`typescript\\nif ('authorization_id' in data) {\\n // Show consent page\\n} else {\\n // Redirect to data.redirect_url\\n}\\n\`\`\`" - } - }, - "@supabase/auth-js.AuthOAuthServerApi.listGrants": { - "name": "@supabase/auth-js.AuthOAuthServerApi.listGrants", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthGrantsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "name": "OAuthGrant", - "type": "object", - "properties": [ - { - "name": "client", - "type": { - "name": "OAuthAuthorizationClient", - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the OAuth client (UUID)" - } - }, - { - "name": "logo_uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URI of the OAuth client's logo" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Human-readable name of the OAuth client" - } - }, - { - "name": "uri", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URI of the OAuth client's website" - } - } - ] - }, - "comment": { - "shortText": "OAuth client information" - } - }, - { - "name": "granted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Timestamp when the grant was created (ISO 8601 date-time)" - } - }, - { - "name": "scopes", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Array of scopes granted to this client" - } - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all OAuth grants that the authenticated user has authorized.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - }, - "@supabase/auth-js.AuthOAuthServerApi.revokeGrant": { - "name": "@supabase/auth-js.AuthOAuthServerApi.revokeGrant", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "clientId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The OAuth client identifier (UUID) to revoke access for" - } - } - ] - }, - "comment": { - "shortText": "Revocation options" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOAuthRevokeGrantResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Revokes a user's OAuth grant for a specific client.\\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\\n\\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\\nand invalidates associated refresh tokens." - } - }, - "@supabase/auth-js.AuthPasskeyApi.delete": { - "name": "@supabase/auth-js.AuthPasskeyApi.delete", - "params": [ - { - "name": "params", - "type": { - "name": "PasskeyDeleteParams", - "type": "object", - "properties": [ - { - "name": "passkeyId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "UUID of the passkey to delete" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyDeleteResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a passkey for the currently signed-in user." - } - }, - "@supabase/auth-js.AuthPasskeyApi.list": { - "name": "@supabase/auth-js.AuthPasskeyApi.list", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyListResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "name": "PasskeyListItem", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_used_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all passkeys registered for the currently signed-in user." - } - }, - "@supabase/auth-js.AuthPasskeyApi.startAuthentication": { - "name": "@supabase/auth-js.AuthPasskeyApi.startAuthentication", - "params": [ - { - "name": "params", - "type": { - "name": "StartPasskeyAuthenticationParams", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyAuthenticationOptionsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyAuthenticationOptionsResponse", - "type": "object", - "properties": [ - { - "name": "challenge_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "ServerCredentialRequestOptions" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Starts the passkey authentication ceremony. Fetches an authentication\\nchallenge and credential request options from the server. Used as the\\nfirst step of a two-step sign-in flow when the caller wants to handle\\n\`navigator.credentials.get()\` themselves." - } - }, - "@supabase/auth-js.AuthPasskeyApi.startRegistration": { - "name": "@supabase/auth-js.AuthPasskeyApi.startRegistration", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyRegistrationOptionsResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyRegistrationOptionsResponse", - "type": "object", - "properties": [ - { - "name": "challenge_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "ServerCredentialCreationOptions" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Starts the passkey registration ceremony. Fetches a registration challenge\\nand credential creation options from the server. Used as the first step of\\na two-step registration flow when the caller wants to handle\\n\`navigator.credentials.create()\` themselves." - } - }, - "@supabase/auth-js.AuthPasskeyApi.update": { - "name": "@supabase/auth-js.AuthPasskeyApi.update", - "params": [ - { - "name": "params", - "type": { - "name": "PasskeyUpdateParams", - "type": "object", - "properties": [ - { - "name": "friendlyName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "New friendly name (max 120 chars)" - } - }, - { - "name": "passkeyId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "UUID of the passkey to update" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyUpdateResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyListItem", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_used_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates a passkey's friendly name." - } - }, - "@supabase/auth-js.AuthPasskeyApi.verifyAuthentication": { - "name": "@supabase/auth-js.AuthPasskeyApi.verifyAuthentication", - "params": [ - { - "name": "params", - "type": { - "name": "VerifyPasskeyAuthenticationParams", - "type": "object", - "properties": [ - { - "name": "challengeId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Challenge ID from startAuthentication" - } - }, - { - "name": "credential", - "type": { - "type": "nameOnly", - "name": "ServerCredentialResponse" - }, - "comment": { - "shortText": "Serialized credential from navigator.credentials.get()" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyAuthenticationVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Verifies a passkey authentication credential against a previously issued\\nchallenge. Used as the second step of a two-step sign-in flow." - } - }, - "@supabase/auth-js.AuthPasskeyApi.verifyRegistration": { - "name": "@supabase/auth-js.AuthPasskeyApi.verifyRegistration", - "params": [ - { - "name": "params", - "type": { - "name": "VerifyPasskeyRegistrationParams", - "type": "object", - "properties": [ - { - "name": "challengeId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Challenge ID from startRegistration" - } - }, - { - "name": "credential", - "type": { - "type": "nameOnly", - "name": "ServerCredentialResponse" - }, - "comment": { - "shortText": "Serialized credential from navigator.credentials.create()" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyRegistrationVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyMetadata", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Verifies a passkey registration credential against a previously issued\\nchallenge. Used as the second step of a two-step registration flow." - } - }, - "@supabase/auth-js.GoTrueClient.dispose": { - "name": "@supabase/auth-js.GoTrueClient.dispose", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Tears down the client's background work: stops the auto-refresh interval,\\nremoves the \`visibilitychange\` listener, closes the cross-tab\\n\`BroadcastChannel\`, and clears registered \`onAuthStateChange\` subscribers.\\n\\nCall this from cleanup hooks when the client is being replaced before\\nits JS realm is destroyed. React Strict Mode and HMR are the common\\ncases. Any in-flight \`fetch\` calls continue to completion and may still\\nwrite to storage; dispose doesn't abort them or erase storage.\\n\\nLifecycle caveat: because in-flight refreshes are not aborted, a\\ndisposed instance can still persist a rotated session to storage after\\n\`dispose()\` returns. A subsequent \`createClient\` against the same\\n\`storageKey\` will pick up that session on its next read. If you need\\nstrict isolation between client lifecycles, await any pending auth\\noperation before calling \`dispose()\` (or change the \`storageKey\` for\\nthe replacement client).\\n\\nSafe to call repeatedly.", - "examples": [ - { - "id": "cleanup-on-react-unmount", - "name": "Cleanup on React unmount", - "code": "\`\`\`ts\\nuseEffect(() => {\\n const client = createClient(...)\\n return () => { client.auth.dispose() }\\n}, [])\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.exchangeCodeForSession": { - "name": "@supabase/auth-js.GoTrueClient.exchangeCodeForSession", - "params": [ - { - "name": "authCode", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthTokenResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow.", - "text": "- Used when \`flowType\` is set to \`pkce\` in client options.", - "examples": [ - { - "id": "exchange-auth-code", - "name": "Exchange Auth Code", - "code": "\`\`\`js\\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n session: {\\n access_token: '',\\n token_type: 'bearer',\\n expires_in: 3600,\\n expires_at: 1700000000,\\n refresh_token: '',\\n user: {\\n id: '11111111-1111-1111-1111-111111111111',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com'\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\",\\n \\"\\"\\n ]\\n },\\n user_metadata: {\\n email: 'email@email.com',\\n email_verified: true,\\n full_name: 'User Name',\\n iss: '',\\n name: 'User Name',\\n phone_verified: false,\\n provider_id: '',\\n sub: ''\\n },\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n {\\n \\"identity_id\\": \\"33333333-3333-3333-3333-333333333333\\",\\n \\"id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"full_name\\": \\"User Name\\",\\n \\"iss\\": \\"\\",\\n \\"name\\": \\"User Name\\",\\n \\"phone_verified\\": false,\\n \\"provider_id\\": \\"\\",\\n \\"sub\\": \\"\\"\\n },\\n \\"provider\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false\\n },\\n provider_token: '',\\n provider_refresh_token: ''\\n },\\n user: {\\n id: '11111111-1111-1111-1111-111111111111',\\n aud: 'authenticated',\\n role: 'authenticated',\\n email: 'example@email.com',\\n email_confirmed_at: '2024-01-01T00:00:00Z',\\n phone: '',\\n confirmation_sent_at: '2024-01-01T00:00:00Z',\\n confirmed_at: '2024-01-01T00:00:00Z',\\n last_sign_in_at: '2024-01-01T00:00:00Z',\\n app_metadata: {\\n provider: 'email',\\n providers: [\\n \\"email\\",\\n \\"\\"\\n ]\\n },\\n user_metadata: {\\n email: 'email@email.com',\\n email_verified: true,\\n full_name: 'User Name',\\n iss: '',\\n name: 'User Name',\\n phone_verified: false,\\n provider_id: '',\\n sub: ''\\n },\\n identities: [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"email@example.com\\"\\n },\\n {\\n \\"identity_id\\": \\"33333333-3333-3333-3333-333333333333\\",\\n \\"id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": true,\\n \\"full_name\\": \\"User Name\\",\\n \\"iss\\": \\"\\",\\n \\"name\\": \\"User Name\\",\\n \\"phone_verified\\": false,\\n \\"provider_id\\": \\"\\",\\n \\"sub\\": \\"\\"\\n },\\n \\"provider\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n created_at: '2024-01-01T00:00:00Z',\\n updated_at: '2024-01-01T00:00:00Z',\\n is_anonymous: false\\n },\\n redirectType: null\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.getClaims": { - "name": "@supabase/auth-js.GoTrueClient.getClaims", - "params": [ - { - "name": "jwt", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "An optional specific JWT you wish to verify, not the one you\\n can obtain from #getSession." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "allowExpired", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to \`true\` the \`exp\` claim will not be validated against the current time." - } - }, - { - "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": [ - null, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." - } - }, - { - "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": [ - null, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ] - } - }, - "isOptional": true, - "comment": { - "shortText": "" - } - } - ] - }, - "comment": { - "shortText": "Various additional options that allow you to customize the\\n behavior of this method." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "claims", - "type": { - "type": "object", - "name": "JwtPayload", - "properties": [ - { - "name": "aal", - "type": { - "type": "union", - "name": "AuthenticatorAssuranceLevels", - "subTypes": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - null - ] - } - }, - { - "name": "amr", - "type": { - "type": "union", - "subTypes": [ - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elemType": { - "type": "object", - "name": "AMREntry", - "properties": [ - { - "name": "method", - "type": { - "type": "union", - "name": "AMRMethod", - "subTypes": [ - { - "type": "nameOnly", - "name": "['number']" - }, - null - ] - }, - "comment": { - "shortText": "Authentication method name." - } - }, - { - "name": "timestamp", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - } - ] - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Authentication Method References.\\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\\n- String format: ['password', 'otp'] - RFC-8176 compliant\\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - }, - "isOptional": true - }, - { - "name": "aud", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "exp", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "iat", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "iss", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "jti", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "nbf", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "ref", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "session_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "sub", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - }, - "isOptional": true - } - ] - } - }, - { - "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" - }, - null - ] - } - }, - { - "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": { - "shortText": "Extracts the JWT claims present in the access token by first verifying the\\nJWT against the server's JSON Web Key Set endpoint\\n\`/.well-known/jwks.json\` which is often cached, resulting in significantly\\nfaster responses. Prefer this method over #getUser which always\\nsends a request to the Auth server for each JWT.\\n\\nIf the project is not using an asymmetric JWT signing key (like ECC or\\nRSA) it always sends a request to the Auth server (similar to #getUser) to verify the JWT.", - "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\\n- A network request is sent to your project's JWT signing key discovery endpoint \`https://project-id.supabase.co/auth/v1/.well-known/jwks.json\`, which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to \`getUser()\` to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook).", - "examples": [ - { - "id": "get-jwt-claims-header-and-signature", - "name": "Get JWT claims, header and signature", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.getClaims()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"claims\\": {\\n \\"aal\\": \\"aal1\\",\\n \\"amr\\": [{\\n \\"method\\": \\"email\\",\\n \\"timestamp\\": 1715766000\\n }],\\n \\"app_metadata\\": {},\\n \\"aud\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"exp\\": 1715769600,\\n \\"iat\\": 1715766000,\\n \\"is_anonymous\\": false,\\n \\"iss\\": \\"https://project-id.supabase.co/auth/v1\\",\\n \\"phone\\": \\"+13334445555\\",\\n \\"role\\": \\"authenticated\\",\\n \\"session_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_metadata\\": {}\\n },\\n \\"header\\": {\\n \\"alg\\": \\"RS256\\",\\n \\"typ\\": \\"JWT\\",\\n \\"kid\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"signature\\": [/** Uint8Array */],\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.getSession": { - "name": "@supabase/auth-js.GoTrueClient.getSession", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Returns the session, refreshing it if necessary.\\n\\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\\n\\n**IMPORTANT:** This method loads values directly from the storage attached\\nto the client. If that storage is based on request cookies for example,\\nthe values in it may not be authentic and therefore it's strongly advised\\nagainst using this method and its results in such circumstances. A warning\\nwill be emitted if this is detected. Use #getUser() instead.", - "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use \`getClaims()\` or \`getUser()\` instead.\\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\\n- The session contains an access token (signed JWT), a refresh token and the user object.\\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\\n- When using in a browser, or you've called \`startAutoRefresh()\` in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using \`getClaims()\` or your own JWT verification library to securely establish the user's identity and access. You can also use \`getUser()\` to fetch the user object directly from the Auth server for this purpose.\\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed.", - "examples": [ - { - "id": "get-the-session-data", - "name": "Get the session data", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.getSession()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.getUser": { - "name": "@supabase/auth-js.GoTrueClient.getUser", - "params": [ - { - "name": "jwt", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Gets the current user details if there is an existing session. This method\\nperforms a network request to the Supabase Auth server, so the returned\\nvalue is authentic and can be used to base authorization rules on.", - "text": "- This method fetches the user object from the database instead of local session.\\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\\n- Should always be used when checking for user authorization on the server. On the client, you can instead use \`getSession().session.user\` for faster results. \`getSession\` is insecure on the server.", - "examples": [ - { - "id": "get-the-logged-in-user-with-the-current-existing-session", - "name": "Get the logged in user with the current existing session", - "code": "\`\`\`js\\nconst { data: { user } } = await supabase.auth.getUser()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "get-the-logged-in-user-with-a-custom-access-token-jwt", - "name": "Get the logged in user with a custom access token jwt", - "code": "\`\`\`js\\nconst { data: { user } } = await supabase.auth.getUser(jwt)\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.getUserIdentities": { - "name": "@supabase/auth-js.GoTrueClient.getUserIdentities", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Gets all the identities linked to a user.", - "text": "- The user needs to be signed in to call \`getUserIdentities()\`.", - "examples": [ - { - "id": "returns-a-list-of-identities-linked-to-the-user", - "name": "Returns a list of identities linked to the user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.getUserIdentities()\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"2024-01-01T00:00:00Z\\",\\n \\"user_id\\": \\"2024-01-01T00:00:00Z\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ]\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.initialize": { - "name": "@supabase/auth-js.GoTrueClient.initialize", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "name": "InitializeResult", - "type": "object", - "properties": [ - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "AuthError" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Initializes the client session either from the url or from storage.\\nThis method is automatically called when instantiating the client, but should also be called\\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - } - }, - "@supabase/auth-js.GoTrueClient.isThrowOnErrorEnabled": { - "name": "@supabase/auth-js.GoTrueClient.isThrowOnErrorEnabled", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Returns whether error throwing mode is enabled for this client." - } - }, - "@supabase/auth-js.GoTrueClient.linkIdentity": { - "name": "@supabase/auth-js.GoTrueClient.linkIdentity", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithOAuthCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "queryParams", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "An object of query params" - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - } - }, - { - "name": "scopes", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." - } - }, - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - } - ] - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - }, - "comment": { - "shortText": "One of the providers supported by GoTrue." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - } - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - } - }, - { - "name": "url", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Links an oauth identity to an existing user.\\nThis method supports the PKCE flow.", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\\n- The user needs to be signed in to call \`linkIdentity()\`.\\n- If the candidate identity is already linked to the existing user or another user, \`linkIdentity()\` will fail.\\n- If \`linkIdentity\` is run in the browser, the user is automatically redirected to the returned URL. On the server, you should handle the redirect.", - "examples": [ - { - "id": "link-an-identity-to-a-user", - "name": "Link an identity to a user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.linkIdentity({\\n provider: 'github'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n provider: 'github',\\n url: \\n },\\n error: null\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithIdTokenCredentials", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "If the ID token contains an \`at_hash\` claim, then the hash of this value is compared to the value in the ID token." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "If the ID token contains a \`nonce\` claim, then the hash of this value is compared to the value in the ID token." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - null, - null - ] - }, - "comment": { - "shortText": "Provider name or OIDC \`iss\` value identifying which provider should be used to verify the provided token. Supported names: \`google\`, \`apple\`, \`azure\`, \`facebook\`, \`kakao\`. Use the \`custom:\` prefix for custom OIDC providers (e.g. \`custom:my-oidc-provider\`)." - } - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OIDC ID token issued by the specified provider. The \`iss\` claim in the ID token must match the supplied provider. Some ID tokens contain an \`at_hash\` which require that you provide an \`access_token\` value to be accepted properly. If the token contains a \`nonce\` claim you must supply the nonce used to obtain the ID token." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthTokenResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Links an OIDC identity to an existing user." - } - } - ] - }, - "@supabase/auth-js.GoTrueClient.onAuthStateChange": { - "name": "@supabase/auth-js.GoTrueClient.onAuthStateChange", - "params": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED", - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "A callback function to be invoked when an auth event happens." - } - } - ], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "subscription", - "type": { - "type": "object", - "name": "Subscription", - "properties": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED", - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - } - }, - { - "name": "id", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - "comment": { - "shortText": "A unique identifier for this subscription, set by the client.\\nThis is an internal identifier used for managing callbacks and should not be\\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - }, - { - "name": "unsubscribe", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Call this to remove the listener." - } - } - ] - } - } - ] - } - } - ] - } - }, - "comment": { - "shortText": "Receive a notification every time an auth event happens.\\nSafe to use without an async function as callback.", - "text": "- Subscribes to important events occurring on the user's session.\\n- Use on the frontend/client. It is less useful on the server.\\n- Events are emitted across tabs to keep your application's UI up-to-date. Some events can fire very frequently, based on the number of tabs open. Use a quick and efficient callback function, and defer or debounce as many operations as you can to be performed outside of the callback.\\n- Callbacks can be \`async\` and can safely call other Supabase auth methods (\`getUser\`, \`setSession\`, etc.) from inside the callback.\\n- Keep callbacks quick. Events are awaited in order, so a slow callback delays subsequent events to subscribers in this tab.\\n- Emitted events:\\n - \`INITIAL_SESSION\`\\n - Emitted right after the Supabase client is constructed and the initial session from storage is loaded.\\n - \`SIGNED_IN\`\\n - Emitted each time a user session is confirmed or re-established, including on user sign in and when refocusing a tab.\\n - Avoid making assumptions as to when this event is fired, this may occur even when the user is already signed in. Instead, check the user object attached to the event to see if a new user has signed in and update your application's UI.\\n - This event can fire very frequently depending on the number of tabs open in your application.\\n - \`SIGNED_OUT\`\\n - Emitted when the user signs out. This can be after:\\n - A call to \`supabase.auth.signOut()\`.\\n - After the user's session has expired for any reason:\\n - User has signed out on another device.\\n - The session has reached its timebox limit or inactivity timeout.\\n - User has signed in on another device with single session per user enabled.\\n - Check the [User Sessions](/docs/guides/auth/sessions) docs for more information.\\n - Use this to clean up any local storage your application has associated with the user.\\n - \`TOKEN_REFRESHED\`\\n - Emitted each time a new access and refresh token are fetched for the signed in user.\\n - It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application.\\n - Avoid frequent calls to \`supabase.auth.getSession()\` for the same purpose.\\n - There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event.\\n - The frequency of this event is related to the JWT expiry limit configured on your project.\\n - \`USER_UPDATED\`\\n - Emitted each time the \`supabase.auth.updateUser()\` method finishes successfully. Listen to it to update your application's UI based on new profile information.\\n - \`PASSWORD_RECOVERY\`\\n - Emitted instead of the \`SIGNED_IN\` event when the user lands on a page that includes a password recovery link in the URL.\\n - Use it to show a UI to the user where they can [reset their password](/docs/guides/auth/passwords#resetting-a-users-password-forgot-password).", - "examples": [ - { - "id": "listen-to-auth-changes", - "name": "Listen to auth changes", - "code": "\`\`\`js\\nconst { data } = supabase.auth.onAuthStateChange((event, session) => {\\n console.log(event, session)\\n\\n if (event === 'INITIAL_SESSION') {\\n // handle initial session\\n } else if (event === 'SIGNED_IN') {\\n // handle sign in event\\n } else if (event === 'SIGNED_OUT') {\\n // handle sign out event\\n } else if (event === 'PASSWORD_RECOVERY') {\\n // handle password recovery event\\n } else if (event === 'TOKEN_REFRESHED') {\\n // handle token refreshed event\\n } else if (event === 'USER_UPDATED') {\\n // handle user updated event\\n }\\n})\\n\\n// call unsubscribe to remove the callback\\ndata.subscription.unsubscribe()\\n\`\`\`" - }, - { - "id": "listen-to-sign-out", - "name": "Listen to sign out", - "code": "\`\`\`js\\nsupabase.auth.onAuthStateChange((event, session) => {\\n if (event === 'SIGNED_OUT') {\\n console.log('SIGNED_OUT', session)\\n\\n // clear local and session storage\\n [\\n window.localStorage,\\n window.sessionStorage,\\n ].forEach((storage) => {\\n Object.entries(storage)\\n .forEach(([key]) => {\\n storage.removeItem(key)\\n })\\n })\\n }\\n})\\n\`\`\`", - "description": "Make sure you clear out any local data, such as local and session storage, after the client library has detected the user's sign out." - }, - { - "id": "store-oauth-provider-tokens-on-sign-in", - "name": "Store OAuth provider tokens on sign in", - "code": "\`\`\`js\\n// Register this immediately after calling createClient!\\n// Because signInWithOAuth causes a redirect, you need to fetch the\\n// provider tokens from the callback.\\nsupabase.auth.onAuthStateChange((event, session) => {\\n if (session && session.provider_token) {\\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\\n }\\n\\n if (session && session.provider_refresh_token) {\\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\\n }\\n\\n if (event === 'SIGNED_OUT') {\\n window.localStorage.removeItem('oauth_provider_token')\\n window.localStorage.removeItem('oauth_provider_refresh_token')\\n }\\n})\\n\`\`\`", - "description": "When using [OAuth (Social Login)](/docs/guides/auth/social-login) you sometimes wish to get access to the provider's access token and refresh token, in order to call provider APIs in the name of the user.\\n\\nFor example, if you are using [Sign in with Google](/docs/guides/auth/social-login/auth-google) you may want to use the provider token to call Google APIs on behalf of the user. Supabase Auth does not keep track of the provider access and refresh token, but does return them for you once, immediately after sign in. You can use the \`onAuthStateChange\` method to listen for the presence of the provider tokens and store them in local storage. You can further send them to your server's APIs for use on the backend.\\n\\nFinally, make sure you remove them from local storage on the \`SIGNED_OUT\` event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - }, - { - "id": "use-react-context-for-the-user-s-session", - "name": "Use React Context for the User's session", - "code": "\`\`\`js\\nconst SessionContext = React.createContext(null)\\n\\nfunction main() {\\n const [session, setSession] = React.useState(null)\\n\\n React.useEffect(() => {\\n const {data: { subscription }} = supabase.auth.onAuthStateChange(\\n (event, session) => {\\n if (event === 'SIGNED_OUT') {\\n setSession(null)\\n } else if (session) {\\n setSession(session)\\n }\\n })\\n\\n return () => {\\n subscription.unsubscribe()\\n }\\n }, [])\\n\\n return (\\n \\n \\n \\n )\\n}\\n\`\`\`", - "description": "Instead of relying on \`supabase.auth.getSession()\` within your React components, you can use a [React Context](https://react.dev/reference/react/createContext) to store the latest session information from the \`onAuthStateChange\` callback and access it that way." - }, - { - "id": "listen-to-password-recovery-events", - "name": "Listen to password recovery events", - "code": "\`\`\`js\\nsupabase.auth.onAuthStateChange((event, session) => {\\n if (event === 'PASSWORD_RECOVERY') {\\n console.log('PASSWORD_RECOVERY', session)\\n // show screen to update user's password\\n showPasswordResetScreen(true)\\n }\\n})\\n\`\`\`" - }, - { - "id": "listen-to-sign-in", - "name": "Listen to sign in", - "code": "\`\`\`js\\nsupabase.auth.onAuthStateChange((event, session) => {\\n if (event === 'SIGNED_IN') console.log('SIGNED_IN', session)\\n})\\n\`\`\`" - }, - { - "id": "listen-to-token-refresh", - "name": "Listen to token refresh", - "code": "\`\`\`js\\nsupabase.auth.onAuthStateChange((event, session) => {\\n if (event === 'TOKEN_REFRESHED') console.log('TOKEN_REFRESHED', session)\\n})\\n\`\`\`" - }, - { - "id": "listen-to-user-updates", - "name": "Listen to user updates", - "code": "\`\`\`js\\nsupabase.auth.onAuthStateChange((event, session) => {\\n if (event === 'USER_UPDATED') console.log('USER_UPDATED', session)\\n})\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED", - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - } - }, - "comment": { - "shortText": "A callback function to be invoked when an auth event happens." - } - } - ], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "subscription", - "type": { - "type": "object", - "name": "Subscription", - "properties": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "union", - "name": "AuthChangeEvent", - "subTypes": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED", - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - } - }, - { - "name": "id", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - "comment": { - "shortText": "A unique identifier for this subscription, set by the client.\\nThis is an internal identifier used for managing callbacks and should not be\\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - }, - { - "name": "unsubscribe", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Call this to remove the listener." - } - } - ] - } - } - ] - } - } - ] - } - }, - "comment": { - "shortText": "Receive a notification every time an auth event happens. Common reentry\\npatterns (\`getUser\`, \`setSession\`, reading the session from inside a\\nhandler) complete normally. One hazard remains: calling \`refreshSession\`\\n(or anything that routes through \`_callRefreshToken\`) from inside a\\n\`TOKEN_REFRESHED\` handler. \`refreshingDeferred\` resolves only after\\n\`_notifyAllSubscribers\` returns, so the inner refresh dedupes onto the\\nouter's unresolved promise and the two wait on each other." - } - } - ] - }, - "@supabase/auth-js.GoTrueClient.reauthenticate": { - "name": "@supabase/auth-js.GoTrueClient.reauthenticate", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sends a reauthentication OTP to the user's email or phone number.\\nRequires the user to be signed-in.", - "text": "- This method is used together with \`updateUser()\` when a user's password needs to be updated.\\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\\n- After receiving the OTP, include it as the \`nonce\` in your \`updateUser()\` call to finalize the password change.", - "examples": [ - { - "id": "send-reauthentication-nonce", - "name": "Send reauthentication nonce", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.reauthenticate()\\n\`\`\`", - "description": "Sends a reauthentication nonce to the user's email or phone number." - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.refreshSession": { - "name": "@supabase/auth-js.GoTrueClient.refreshSession", - "params": [ - { - "name": "currentSession", - "type": { - "type": "object", - "properties": [ - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The current session. If passed in, it must contain a refresh token." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Returns a new session, regardless of expiry status.\\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\\nIf the current session's refresh token is invalid, an error will be thrown.", - "text": "- This method will refresh and return a new session whether the current one is expired or not.", - "examples": [ - { - "id": "refresh-session-using-the-current-session", - "name": "Refresh session using the current session", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.refreshSession()\\nconst { session, user } = data\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "refresh-session-using-a-refresh-token", - "name": "Refresh session using a refresh token", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\\nconst { session, user } = data\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.registerPasskey": { - "name": "@supabase/auth-js.GoTrueClient.registerPasskey", - "params": [ - { - "name": "credentials", - "type": { - "name": "RegisterPasskeyCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyRegistrationVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "name": "PasskeyMetadata", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Register a passkey for the current authenticated user. Handles the full WebAuthn ceremony:\\n1. Fetches registration challenge from server\\n2. Prompts user via navigator.credentials.create()\\n3. Verifies credential with server\\n\\nRequires an active session. Requires \`auth.experimental.passkey: true\`." - } - }, - "@supabase/auth-js.GoTrueClient.resend": { - "name": "@supabase/auth-js.GoTrueClient.resend", - "params": [ - { - "name": "credentials", - "type": { - "type": "union", - "name": "ResendParams", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "emailRedirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they have signed-in." - } - } - ] - }, - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOtpResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "messageId", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true - }, - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "messageId", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP.", - "text": "- Resends a signup confirmation, email change or phone change email to the user.\\n- Passwordless sign-ins can be resent by calling the \`signInWithOtp()\` method again.\\n- Password recovery emails can be resent by calling the \`resetPasswordForEmail()\` method again.\\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use \`signInWithOtp()\` again to resend the OTP).\\n- You can specify a redirect url when you resend an email link using the \`emailRedirectTo\` option.", - "examples": [ - { - "id": "resend-an-email-signup-confirmation", - "name": "Resend an email signup confirmation", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.resend({\\n type: 'signup',\\n email: 'email@example.com',\\n options: {\\n emailRedirectTo: 'https://example.com/welcome'\\n }\\n})\\n\`\`\`", - "description": "Resends the email signup confirmation to the user" - }, - { - "id": "resend-a-phone-signup-confirmation", - "name": "Resend a phone signup confirmation", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.resend({\\n type: 'sms',\\n phone: '1234567890'\\n})\\n\`\`\`", - "description": "Resends the phone signup confirmation email to the user" - }, - { - "id": "resend-email-change-email", - "name": "Resend email change email", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.resend({\\n type: 'email_change',\\n email: 'email@example.com'\\n})\\n\`\`\`", - "description": "Resends the email change email to the user" - }, - { - "id": "resend-phone-change-otp", - "name": "Resend phone change OTP", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.resend({\\n type: 'phone_change',\\n phone: '1234567890'\\n})\\n\`\`\`", - "description": "Resends the phone change OTP to the user" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.resetPasswordForEmail": { - "name": "@supabase/auth-js.GoTrueClient.resetPasswordForEmail", - "params": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The email address of the user." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The URL to send the user to after they click the password reset link." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sends a password reset request to an email address. This method supports the PKCE flow.", - "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\\n- The \`resetPasswordForEmail()\` only sends a password reset link to the user's email.\\nTo update the user's password, see [\`updateUser()\`](/docs/reference/javascript/auth-updateuser).\\n- A \`PASSWORD_RECOVERY\` event will be emitted when the password recovery link is clicked.\\nYou can use [\`onAuthStateChange()\`](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\\n- When the user clicks the reset link in the email they are redirected back to your application.\\nYou can configure the URL that the user is redirected to with the \`redirectTo\` parameter.\\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\\n- After the user has been redirected successfully, prompt them for a new password and call \`updateUser()\`:\\n\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n password: new_password\\n})\\n\`\`\`", - "examples": [ - { - "id": "reset-password", - "name": "Reset password", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\\n redirectTo: 'https://example.com/update-password',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {}\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "reset-password-react", - "name": "Reset password (React)", - "code": "\`\`\`js\\n/**\\n * Step 1: Send the user an email to get a password reset token.\\n * This email contains a link which sends the user back to your application.\\n */\\nconst { data, error } = await supabase.auth\\n .resetPasswordForEmail('user@email.com')\\n\\n/**\\n * Step 2: Once the user is redirected back to your application,\\n * ask the user to reset their password.\\n */\\n useEffect(() => {\\n supabase.auth.onAuthStateChange(async (event, session) => {\\n if (event == \\"PASSWORD_RECOVERY\\") {\\n const newPassword = prompt(\\"What would you like your new password to be?\\");\\n const { data, error } = await supabase.auth\\n .updateUser({ password: newPassword })\\n\\n if (data) alert(\\"Password updated successfully!\\")\\n if (error) alert(\\"There was an error updating your password.\\")\\n }\\n })\\n }, [])\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.setSession": { - "name": "@supabase/auth-js.GoTrueClient.setSession", - "params": [ - { - "name": "currentSession", - "type": { - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "comment": { - "shortText": "The current session that minimally contains an access token and refresh token." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\\nIf the refresh token or access token in the current session is invalid, an error will be thrown.", - "text": "- This method sets the session using an \`access_token\` and \`refresh_token\`.\\n- If successful, a \`SIGNED_IN\` event is emitted.", - "examples": [ - { - "id": "set-the-session", - "name": "Set the session", - "code": "\`\`\`js\\n const { data, error } = await supabase.auth.setSession({\\n access_token,\\n refresh_token\\n })\\n\`\`\`", - "description": "Sets the session data from an access_token and refresh_token, then returns an auth response or error.", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"2024-01-01T00:00:00Z\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n },\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3500,\\n \\"expires_at\\": 1700000000\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signInAnonymously": { - "name": "@supabase/auth-js.GoTrueClient.signInAnonymously", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInAnonymouslyCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new anonymous user.", - "text": "- Returns an anonymous user\\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the \`options\` param.", - "examples": [ - { - "id": "create-an-anonymous-user", - "name": "Create an anonymous user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInAnonymously({\\n options: {\\n captchaToken\\n }\\n});\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {},\\n \\"user_metadata\\": {},\\n \\"identities\\": [],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": true\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {},\\n \\"user_metadata\\": {},\\n \\"identities\\": [],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": true\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "create-an-anonymous-user-with-custom-user-metadata", - "name": "Create an anonymous user with custom user metadata", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInAnonymously({\\n options: {\\n data\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signInWithIdToken": { - "name": "@supabase/auth-js.GoTrueClient.signInWithIdToken", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithIdTokenCredentials", - "type": "object", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "If the ID token contains an \`at_hash\` claim, then the hash of this value is compared to the value in the ID token." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "If the ID token contains a \`nonce\` claim, then the hash of this value is compared to the value in the ID token." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - null, - null - ] - }, - "comment": { - "shortText": "Provider name or OIDC \`iss\` value identifying which provider should be used to verify the provided token. Supported names: \`google\`, \`apple\`, \`azure\`, \`facebook\`, \`kakao\`. Use the \`custom:\` prefix for custom OIDC providers (e.g. \`custom:my-oidc-provider\`)." - } - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "OIDC ID token issued by the specified provider. The \`iss\` claim in the ID token must match the supplied provider. Some ID tokens contain an \`at_hash\` which require that you provide an \`access_token\` value to be accepted properly. If the token contains a \`nonce\` claim you must supply the nonce used to obtain the ID token." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthTokenResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Allows signing in with an OIDC ID token. The authentication provider used\\nshould be enabled and configured.", - "text": "- Use an ID token to sign in.\\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API.", - "examples": [ - { - "id": "sign-in-using-id-token", - "name": "Sign In using ID Token", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithIdToken({\\n provider: 'google',\\n token: 'your-id-token'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n ...\\n },\\n \\"user_metadata\\": {\\n ...\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"provider\\": \\"google\\",\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n ...\\n },\\n \\"user_metadata\\": {\\n ...\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"provider\\": \\"google\\",\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signInWithOAuth": { - "name": "@supabase/auth-js.GoTrueClient.signInWithOAuth", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithOAuthCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "queryParams", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "An object of query params" - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - } - }, - { - "name": "scopes", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." - } - }, - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - } - ] - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - }, - "comment": { - "shortText": "One of the providers supported by GoTrue." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "OAuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - } - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "provider", - "type": { - "type": "union", - "name": "Provider", - "subTypes": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - null - ] - } - }, - { - "name": "url", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in an existing user via a third-party provider.\\nThis method supports the PKCE flow.", - "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app.", - "examples": [ - { - "id": "sign-in-using-a-third-party-provider", - "name": "Sign in using a third-party provider", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOAuth({\\n provider: 'github'\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n data: {\\n provider: 'github',\\n url: \\n },\\n error: null\\n}\\n\`\`\`" - }, - { - "id": "sign-in-using-a-third-party-provider-with-redirect", - "name": "Sign in using a third-party provider with redirect", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOAuth({\\n provider: 'github',\\n options: {\\n redirectTo: 'https://example.com/welcome'\\n }\\n})\\n\`\`\`", - "description": "- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the \`redirectTo\` parameter. This parameter defaults to the [\`SITE_URL\`](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - }, - { - "id": "sign-in-with-scopes-and-access-provider-tokens", - "name": "Sign in with scopes and access provider tokens", - "code": "\`\`\`js\\n// Register this immediately after calling createClient!\\n// Because signInWithOAuth causes a redirect, you need to fetch the\\n// provider tokens from the callback.\\nsupabase.auth.onAuthStateChange((event, session) => {\\n if (session && session.provider_token) {\\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\\n }\\n\\n if (session && session.provider_refresh_token) {\\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\\n }\\n\\n if (event === 'SIGNED_OUT') {\\n window.localStorage.removeItem('oauth_provider_token')\\n window.localStorage.removeItem('oauth_provider_refresh_token')\\n }\\n})\\n\\n// Call this on your Sign in with GitHub button to initiate OAuth\\n// with GitHub with the requested elevated scopes.\\nawait supabase.auth.signInWithOAuth({\\n provider: 'github',\\n options: {\\n scopes: 'repo gist notifications'\\n }\\n})\\n\`\`\`", - "description": "If you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the \`scopes\` option takes in **a space-separated list** of scopes.\\n\\nBecause OAuth sign-in often includes redirects, you should register an \`onAuthStateChange\` callback immediately after you create the Supabase client. This callback will listen for the presence of \`provider_token\` and \`provider_refresh_token\` properties on the \`session\` object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\\n\\nFinally, make sure you remove them from local storage on the \`SIGNED_OUT\` event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signInWithOtp": { - "name": "@supabase/auth-js.GoTrueClient.signInWithOtp", - "params": [ - { - "name": "credentials", - "type": { - "type": "union", - "name": "SignInWithPasswordlessCredentials", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email address." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - }, - { - "name": "emailRedirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The redirect url embedded in the email link" - } - }, - { - "name": "shouldCreateUser", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - } - } - ] - }, - "isOptional": true - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "channel", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Messaging channel to use (e.g. whatsapp or sms)" - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - }, - { - "name": "shouldCreateUser", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - } - } - ] - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's phone number." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthOtpResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "messageId", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true - }, - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "messageId", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).\\n\\nIf 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.", - "text": "- Requires either an email or phone number.\\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\\n- If the user doesn't exist, \`signInWithOtp()\` will signup the user instead. To restrict this behavior, you can set \`shouldCreateUser\` in \`SignInWithPasswordlessCredentials.options\` to \`false\`.\\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\\n- If you're using phone, you can configure whether you want the user to receive a OTP.\\n- The magic link's destination URL is determined by the [\`SITE_URL\`](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include \`{{ .Token }}\` instead of \`{{ .ConfirmationURL }}\`.\\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in.", - "examples": [ - { - "id": "sign-in-with-email", - "name": "Sign in with email", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOtp({\\n email: 'example@email.com',\\n options: {\\n emailRedirectTo: 'https://example.com/welcome'\\n }\\n})\\n\`\`\`", - "description": "The user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds.", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": null,\\n \\"session\\": null\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "sign-in-with-sms-otp", - "name": "Sign in with SMS OTP", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOtp({\\n phone: '+13334445555',\\n})\\n\`\`\`", - "description": "The user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." - }, - { - "id": "sign-in-with-whatsapp-otp", - "name": "Sign in with WhatsApp OTP", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithOtp({\\n phone: '+13334445555',\\n options: {\\n channel:'whatsapp',\\n }\\n})\\n\`\`\`", - "description": "The user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signInWithPasskey": { - "name": "@supabase/auth-js.GoTrueClient.signInWithPasskey", - "params": [ - { - "name": "credentials", - "type": { - "name": "SignInWithPasskeyCredentials", - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthPasskeyAuthenticationVerifyResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sign in with a passkey. Handles the full WebAuthn ceremony:\\n1. Fetches authentication challenge from server\\n2. Prompts user via navigator.credentials.get()\\n3. Verifies credential with server and creates session\\n\\nRequires \`auth.experimental.passkey: true\`." - } - }, - "@supabase/auth-js.GoTrueClient.signInWithPassword": { - "name": "@supabase/auth-js.GoTrueClient.signInWithPassword", - "params": [ - { - "name": "credentials", - "type": { - "type": "nameOnly", - "name": "SignInWithPasswordCredentials" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthTokenResponsePassword", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - }, - { - "name": "weakPassword", - "type": { - "name": "WeakPassword", - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "reasons", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "WeakPasswordReasons" - } - } - } - ] - }, - "isOptional": true - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "weakPassword", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in an existing user with an email and password or phone and password.\\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\\nemail/phone and password combination is wrong or that the account can only\\nbe accessed via social login.", - "text": "- Requires either an email and password or a phone number and password.", - "examples": [ - { - "id": "sign-in-with-email-and-password", - "name": "Sign in with email and password", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n email: 'example@email.com',\\n password: 'example-password',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "sign-in-with-phone-and-password", - "name": "Sign in with phone and password", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n phone: '+13334445555',\\n password: 'some-password',\\n})\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signInWithPassword({\\n email: 'example@email.com',\\n password: 'example-password',\\n})\\nif (error) {\\n console.error(error)\\n return\\n}\\n\`\`\`", - "description": "Log the full \`error\` object so fields like \`code\`, \`status\`, and \`name\` aren't hidden. The \`error.code\` (e.g. \`'invalid_credentials'\`, \`'email_not_confirmed'\`) is often more useful for branching than \`error.message\`, and the full object surfaces both." - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signInWithSSO": { - "name": "@supabase/auth-js.GoTrueClient.signInWithSSO", - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "SignInWithSSO", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they have signed-in." - } - }, - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to true, the redirect will not happen on the client side.\\nThis parameter is used when you wish to handle the redirect yourself.\\nDefaults to false." - } - } - ] - }, - "isOptional": true - }, - { - "name": "providerId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "UUID of the SSO provider to invoke single-sign on to." - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "domain", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Domain name of the organization for which to invoke single-sign on." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they have signed-in." - } - }, - { - "name": "skipBrowserRedirect", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If set to true, the redirect will not happen on the client side.\\nThis parameter is used when you wish to handle the redirect yourself.\\nDefaults to false." - } - } - ] - }, - "isOptional": true - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "SSOResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL to open in a browser which will complete the sign-in flow by\\ntaking the user to the identity provider's authentication flow.\\n\\nOn browsers you can set the URL to \`window.location.href\` to take\\nthe user to the authentication flow." - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error" - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Attempts a single-sign on using an enterprise Identity Provider. A\\nsuccessful SSO attempt will redirect the current page to the identity\\nprovider authorization page. The redirect URL is implementation and SSO\\nprotocol specific.\\n\\nYou can use it by providing a SSO domain. Typically you can extract this\\ndomain by asking users for their email address. If this domain is\\nregistered on the Auth instance the redirect will use that organization's\\ncurrently active SSO Identity Provider for the login.\\n\\nIf you have built an organization-specific login page, you can use the\\norganization's SSO Identity Provider UUID directly instead.", - "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\\n- If you've associated an email domain to the identity provider, you can use the \`domain\` property to start a sign-in flow.\\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the \`providerId\` property. For example:\\n - Mapping specific user email addresses with an identity provider.\\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information.", - "examples": [ - { - "id": "sign-in-with-email-domain", - "name": "Sign in with email domain", - "code": "\`\`\`js\\n // You can extract the user's email domain and use it to trigger the\\n // authentication flow with the correct identity provider.\\n\\n const { data, error } = await supabase.auth.signInWithSSO({\\n domain: 'company.com'\\n })\\n\\n if (data?.url) {\\n // redirect the user to the identity provider's authentication flow\\n window.location.href = data.url\\n }\\n\`\`\`" - }, - { - "id": "sign-in-with-provider-uuid", - "name": "Sign in with provider UUID", - "code": "\`\`\`js\\n // Useful when you need to map a user's sign in request according\\n // to different rules that can't use email domains.\\n\\n const { data, error } = await supabase.auth.signInWithSSO({\\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\\n })\\n\\n if (data?.url) {\\n // redirect the user to the identity provider's authentication flow\\n window.location.href = data.url\\n }\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signInWithWeb3": { - "name": "@supabase/auth-js.GoTrueClient.signInWithWeb3", - "params": [ - { - "name": "credentials", - "type": { - "type": "union", - "name": "Web3Credentials", - "subTypes": [ - { - "type": "union", - "name": "SolanaWeb3Credentials", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "chain", - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "signInWithSolana", - "type": { - "type": "nameOnly", - "name": "Partial" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - } - ] - }, - "isOptional": true - }, - { - "name": "statement", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - }, - { - "name": "wallet", - "type": { - "name": "SolanaWallet", - "type": "object", - "properties": [ - { - "name": "publicKey", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "toBase58", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - }, - "isOptional": true - }, - { - "name": "signIn", - "type": { - "type": "function", - "params": [ - { - "name": "inputs", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "SolanaSignInInput" - } - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "SolanaSignInOutput" - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "SolanaSignInOutput" - } - } - ] - } - } - } - }, - "isOptional": true - }, - { - "name": "signMessage", - "type": { - "type": "function", - "params": [ - { - "name": "message", - "type": { - "type": "nameOnly", - "name": "Uint8Array" - } - }, - { - "name": "encoding", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "utf8" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Uint8Array" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } - } - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Wallet interface to use. If not specified will default to \`window.solana\`." - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "chain", - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Sign in with Solana compatible message. Must include \`Issued At\`, \`URI\` and \`Version\`." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "signature", - "type": { - "type": "nameOnly", - "name": "Uint8Array" - }, - "comment": { - "shortText": "Ed25519 signature of the message." - } - } - ] - } - ] - }, - { - "type": "union", - "name": "EthereumWeb3Credentials", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "chain", - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "signInWithEthereum", - "type": { - "type": "nameOnly", - "name": "Partial" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - } - ] - }, - "isOptional": true - }, - { - "name": "statement", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - }, - { - "name": "wallet", - "type": { - "type": "nameOnly", - "name": "EthereumWallet" - }, - "isOptional": true, - "comment": { - "shortText": "Wallet interface to use. If not specified will default to \`window.ethereum\`." - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "chain", - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Sign in with Ethereum compatible message. Must include \`Issued At\`, \`URI\` and \`Version\`." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - } - ] - }, - "isOptional": true - }, - { - "name": "signature", - "type": { - "type": "nameOnly", - "name": "Hex" - }, - "comment": { - "shortText": "Ethereum curve (secp256k1) signature of the message." - } - } - ] - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Signs in a user by verifying a message signed by the user's private key.\\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\\nboth of which derive from the EIP-4361 standard\\nWith slight variation on Solana's side.", - "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it.", - "examples": [ - { - "id": "sign-in-with-solana-or-ethereum-window-api", - "name": "Sign in with Solana or Ethereum (Window API)", - "code": "\`\`\`js\\n // uses window.ethereum for the wallet\\n const { data, error } = await supabase.auth.signInWithWeb3({\\n chain: 'ethereum',\\n statement: 'I accept the Terms of Service at https://example.com/tos'\\n })\\n\\n // uses window.solana for the wallet\\n const { data, error } = await supabase.auth.signInWithWeb3({\\n chain: 'solana',\\n statement: 'I accept the Terms of Service at https://example.com/tos'\\n })\\n\`\`\`" - }, - { - "id": "sign-in-with-ethereum-message-and-signature", - "name": "Sign in with Ethereum (Message and Signature)", - "code": "\`\`\`js\\n const { data, error } = await supabase.auth.signInWithWeb3({\\n chain: 'ethereum',\\n message: '',\\n signature: '',\\n })\\n\`\`\`" - }, - { - "id": "sign-in-with-solana-brave", - "name": "Sign in with Solana (Brave)", - "code": "\`\`\`js\\n const { data, error } = await supabase.auth.signInWithWeb3({\\n chain: 'solana',\\n statement: 'I accept the Terms of Service at https://example.com/tos',\\n wallet: window.braveSolana\\n })\\n\`\`\`" - }, - { - "id": "sign-in-with-solana-wallet-adapter", - "name": "Sign in with Solana (Wallet Adapter)", - "code": "\`\`\`jsx\\n function SignInButton() {\\n const wallet = useWallet()\\n\\n return (\\n <>\\n {wallet.connected ? (\\n {\\n supabase.auth.signInWithWeb3({\\n chain: 'solana',\\n statement: 'I accept the Terms of Service at https://example.com/tos',\\n wallet,\\n })\\n }}\\n >\\n Sign in with Solana\\n \\n ) : (\\n \\n )}\\n \\n )\\n}\\n\\nfunction App() {\\n const endpoint = clusterApiUrl('devnet')\\n const wallets = useMemo(() => [], [])\\n\\n return (\\n \\n \\n \\n \\n \\n \\n \\n )\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signOut": { - "name": "@supabase/auth-js.GoTrueClient.signOut", - "params": [ - { - "name": "options", - "type": { - "name": "SignOut", - "type": "object", - "properties": [ - { - "name": "scope", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Determines which sessions should be\\nlogged out. Global means all\\nsessions by this account. Local\\nmeans only this session. Others\\nmeans all other sessions except the\\ncurrent one. When using others,\\nthere is no sign-out event fired on\\nthe current session!" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "object", - "properties": [ - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "nameOnly", - "name": "AuthError" - } - ] - } - } - ] - } - } - }, - "comment": { - "shortText": "Inside a browser context, \`signOut()\` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a \`\\"SIGNED_OUT\\"\` event.\\n\\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to \`auth.api.signOut(JWT: string)\`.\\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\\n\\nIf using \`others\` scope, no \`SIGNED_OUT\` event is fired!\\n\\n**Warning:** the default \`scope\` is \`'global'\`. This signs the user out of\\n**every device they are currently signed in on**, not just the current\\ntab/session. If you only want to sign the user out of the current session\\n(the behavior most other auth libraries default to), pass\\n\`{ scope: 'local' }\` explicitly.", - "text": "- In order to use the \`signOut()\` method, the user needs to be signed in first.\\n- By default, \`signOut()\` uses the **global** scope, which signs out the user\\n on every device they are signed in on (not just the current one). Pass\\n \`{ scope: 'local' }\` to only sign out the current session. This is\\n usually what apps want on a \\"Sign out\\" button, especially when users\\n sign in from multiple devices and do not expect signing out of one to\\n terminate the others.\\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires.", - "examples": [ - { - "id": "sign-out-of-every-device-global-default", - "name": "Sign out of every device (global – default)", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.signOut()\\n\`\`\`" - }, - { - "id": "sign-out-only-the-current-session-recommended-for-most-apps", - "name": "Sign out only the current session (recommended for most apps)", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\\n\`\`\`" - }, - { - "id": "sign-out-of-all-other-sessions-keep-the-current-one", - "name": "Sign out of all other sessions, keep the current one", - "code": "\`\`\`js\\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.signUp": { - "name": "@supabase/auth-js.GoTrueClient.signUp", - "params": [ - { - "name": "credentials", - "type": { - "type": "nameOnly", - "name": "SignUpWithPasswordCredentials" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new user.\\n\\nBe aware that if a user account exists in the system you may get back an\\nerror message that attempts to hide this information from the user.\\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled.", - "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\\n- **Confirm email** determines if users need to confirm their email address after signing up.\\n - If **Confirm email** is enabled, a \`user\` is returned but \`session\` is null.\\n - If **Confirm email** is disabled, both a \`user\` and a \`session\` are returned.\\n- When the user confirms their email address, they are redirected to the [\`SITE_URL\`](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your \`SITE_URL\` or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\\n- If signUp() is called for an existing confirmed user:\\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, \`User already registered\` is returned.\\n- To fetch the currently logged-in user, refer to [\`getUser()\`](/docs/reference/javascript/auth-getuser).", - "examples": [ - { - "id": "sign-up-with-an-email-and-password", - "name": "Sign up with an email and password", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp({\\n email: 'example@email.com',\\n password: 'example-password',\\n})\\n\`\`\`", - "response": "\`\`\`json\\n// Some fields may be null if \\"confirm email\\" is enabled.\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {},\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "sign-up-with-a-phone-number-and-password-sms", - "name": "Sign up with a phone number and password (SMS)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp({\\n phone: '123456789',\\n password: 'example-password',\\n options: {\\n channel: 'sms'\\n }\\n})\\n\`\`\`" - }, - { - "id": "sign-up-with-a-phone-number-and-password-whatsapp", - "name": "Sign up with a phone number and password (whatsapp)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp({\\n phone: '123456789',\\n password: 'example-password',\\n options: {\\n channel: 'whatsapp'\\n }\\n})\\n\`\`\`", - "description": "The user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - }, - { - "id": "sign-up-with-additional-user-metadata", - "name": "Sign up with additional user metadata", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp(\\n {\\n email: 'example@email.com',\\n password: 'example-password',\\n options: {\\n data: {\\n first_name: 'John',\\n age: 27,\\n }\\n }\\n }\\n)\\n\`\`\`" - }, - { - "id": "sign-up-with-a-redirect-url", - "name": "Sign up with a redirect URL", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.signUp(\\n {\\n email: 'example@email.com',\\n password: 'example-password',\\n options: {\\n emailRedirectTo: 'https://example.com/welcome'\\n }\\n }\\n)\\n\`\`\`", - "description": "- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.startAutoRefresh": { - "name": "@supabase/auth-js.GoTrueClient.startAutoRefresh", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Starts an auto-refresh process in the background. The session is checked\\nevery few seconds. Close to the time of expiration a process is started to\\nrefresh the session. If refreshing fails it will be retried for as long as\\nnecessary.\\n\\nIf you set the GoTrueClientOptions#autoRefreshToken you don't need\\nto call this function, it will be called for you.\\n\\nOn browsers the refresh process works only when the tab/window is in the\\nforeground to conserve resources as well as prevent race conditions and\\nflooding auth with requests. If you call this method any managed\\nvisibility change callback will be removed and you must manage visibility\\nchanges on your own.\\n\\nOn non-browser platforms the refresh process works *continuously* in the\\nbackground, which may not be desirable. You should hook into your\\nplatform's foreground indication mechanism and call these methods\\nappropriately to conserve resources.\\n\\n#stopAutoRefresh", - "text": "- Only useful in non-browser environments such as React Native or Electron.\\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\\n- To give this hint to the application, you should be calling this method when the app is in focus and calling \`supabase.auth.stopAutoRefresh()\` when it's out of focus.", - "examples": [ - { - "id": "start-and-stop-auto-refresh-in-react-native", - "name": "Start and stop auto refresh in React Native", - "code": "\`\`\`js\\nimport { AppState } from 'react-native'\\n\\n// make sure you register this only once!\\nAppState.addEventListener('change', (state) => {\\n if (state === 'active') {\\n supabase.auth.startAutoRefresh()\\n } else {\\n supabase.auth.stopAutoRefresh()\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.stopAutoRefresh": { - "name": "@supabase/auth-js.GoTrueClient.stopAutoRefresh", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Stops an active auto refresh process running in the background (if any).\\n\\nIf you call this method any managed visibility change callback will be\\nremoved and you must manage visibility changes on your own.\\n\\nSee #startAutoRefresh for more details.", - "text": "- Only useful in non-browser environments such as React Native or Electron.\\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session.", - "examples": [ - { - "id": "start-and-stop-auto-refresh-in-react-native", - "name": "Start and stop auto refresh in React Native", - "code": "\`\`\`js\\nimport { AppState } from 'react-native'\\n\\n// make sure you register this only once!\\nAppState.addEventListener('change', (state) => {\\n if (state === 'active') {\\n supabase.auth.startAutoRefresh()\\n } else {\\n supabase.auth.stopAutoRefresh()\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.unlinkIdentity": { - "name": "@supabase/auth-js.GoTrueClient.unlinkIdentity", - "params": [ - { - "name": "identity", - "type": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked.", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\\n- The user needs to be signed in to call \`unlinkIdentity()\`.\\n- The user must have at least 2 identities in order to unlink an identity.\\n- The identity to be unlinked must belong to the user.", - "examples": [ - { - "id": "unlink-an-identity", - "name": "Unlink an identity", - "code": "\`\`\`js\\n// retrieve all identities linked to a user\\nconst identities = await supabase.auth.getUserIdentities()\\n\\n// find the google identity\\nconst googleIdentity = identities.find(\\n identity => identity.provider === 'google'\\n)\\n\\n// unlink the google identity\\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.updateUser": { - "name": "@supabase/auth-js.GoTrueClient.updateUser", - "params": [ - { - "name": "attributes", - "type": { - "type": "object", - "name": "UserAttributes", - "properties": [ - { - "name": "current_password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's current password\\n\\nThis is only ever present when the user is resetting\\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "object" - }, - "isOptional": true, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column.\\n\\nThe \`data\` should be a JSON object that includes user-specific info, such as their first and last name." - } - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's email." - } - }, - { - "name": "nonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The nonce sent for reauthentication if the user's password is to be updated.\\n\\nCall reauthenticate() to obtain the nonce first." - } - }, - { - "name": "password", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's password." - } - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The user's phone." - } - } - ] - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "emailRedirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "UserResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates user data for a logged in user.", - "text": "- In order to use the \`updateUser()\` method, the user needs to be signed in first.\\n- By default, email updates sends a confirmation link to both the user's current and new email.\\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers).", - "examples": [ - { - "id": "update-the-email-for-an-authenticated-user", - "name": "Update the email for an authenticated user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n email: 'new@email.com'\\n})\\n\`\`\`", - "description": "Sends a \\"Confirm Email Change\\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email).", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"new_email\\": \\"new@email.com\\",\\n \\"email_change_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "update-the-phone-number-for-an-authenticated-user", - "name": "Update the phone number for an authenticated user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n phone: '123456789'\\n})\\n\`\`\`", - "description": "Sends a one-time password (OTP) to the new phone number." - }, - { - "id": "update-the-password-for-an-authenticated-user", - "name": "Update the password for an authenticated user", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n password: 'new password'\\n})\\n\`\`\`" - }, - { - "id": "update-the-user-s-metadata", - "name": "Update the user's metadata", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n data: { hello: 'world' }\\n})\\n\`\`\`", - "description": "Updates the user's custom metadata.\\n\\n**Note**: The \`data\` field maps to the \`auth.users.raw_user_meta_data\` column in your Supabase database. When calling \`getUser()\`, the data will be available as \`user.user_metadata\`." - }, - { - "id": "update-the-user-s-password-with-a-nonce", - "name": "Update the user's password with a nonce", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.updateUser({\\n password: 'new password',\\n nonce: '123456'\\n})\\n\`\`\`", - "description": "If **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." - } - ] - } - }, - "@supabase/auth-js.GoTrueClient.verifyOtp": { - "name": "@supabase/auth-js.GoTrueClient.verifyOtp", - "params": [ - { - "name": "params", - "type": { - "type": "union", - "name": "VerifyOtpParams", - "subTypes": [ - { - "type": "object", - "name": "VerifyMobileOtpParams", - "properties": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - } - } - ] - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's phone number." - } - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The otp sent to the user's phone number." - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "MobileOtpType", - "subTypes": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - }, - null - ] - }, - "comment": { - "shortText": "The user's verification type." - } - } - ] - }, - { - "type": "object", - "name": "VerifyEmailOtpParams", - "properties": [ - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The user's email address." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "captchaToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - } - }, - { - "name": "redirectTo", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - } - } - ] - }, - "isOptional": true - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The otp sent to the user's email address." - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "EmailOtpType", - "subTypes": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - null - ] - }, - "comment": { - "shortText": "The user's verification type." - } - } - ] - }, - { - "type": "object", - "name": "VerifyTokenHashParams", - "properties": [ - { - "name": "token_hash", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The token hash used in an email link" - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "EmailOtpType", - "subTypes": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - null - ] - }, - "comment": { - "shortText": "The user's verification type." - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "AuthResponse", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "Session", - "properties": [ - { - "name": "access_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - }, - { - "name": "expires_at", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - }, - { - "name": "expires_in", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - }, - { - "name": "provider_refresh_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - }, - { - "name": "provider_token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - }, - { - "name": "refresh_token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A one-time used refresh token that never expires." - } - }, - { - "name": "token_type", - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "name": "user", - "type": { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - "comment": { - "shortText": "When using a separate user storage, accessing properties of this object will throw an error." - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "name": "user", - "type": { - "type": "union", - "subTypes": [ - { - "type": "object", - "name": "User", - "properties": [ - { - "name": "action_link", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "app_metadata", - "type": { - "type": "object", - "name": "UserAppMetadata", - "properties": [ - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The first provider that the user used to sign up with." - } - }, - { - "name": "providers", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "A list of all providers that the user has linked to their account." - } - } - ] - } - }, - { - "name": "aud", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "banned_until", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmation_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "deleted_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_change_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "email_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "factors", - "type": { - "type": "array", - "elemType": { - "type": "union", - "subTypes": [ - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "name": "Factor", - "type": "object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "factor_type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version" - } - }, - { - "name": "friendly_name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ID of the factor." - } - }, - { - "name": "last_challenged_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - "comment": { - "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ] - } - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identities", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "UserIdentity", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "identity_data", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "identity_id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "provider", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_id", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "isOptional": true - }, - { - "name": "invited_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "is_anonymous", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "is_sso_user", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "last_sign_in_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_email", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "new_phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "phone_confirmed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "recovery_sent_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "role", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "user_metadata", - "type": { - "type": "object", - "name": "UserMetadata", - "properties": [] - } - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "session", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "user", - "type": { - "type": "literal", - "value": null - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "AuthError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Log in a user given a User supplied OTP or TokenHash received through mobile or email.", - "text": "- The \`verifyOtp\` method takes in different verification types.\\n- If a phone number is used, the type can either be:\\n 1. \`sms\` – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\\n 2. \`phone_change\` – Used when verifying an OTP sent to a new phone number during a phone number update process.\\n- If an email address is used, the type can be one of the following (note: \`signup\` and \`magiclink\` types are deprecated):\\n 1. \`email\` – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\\n 2. \`recovery\` – Used when verifying an OTP sent for account recovery, typically after a password reset request.\\n 3. \`invite\` – Used when verifying an OTP sent as part of an invitation to join a project or organization.\\n 4. \`email_change\` – Used when verifying an OTP sent to a new email address during an email update process.\\n- The verification type used should be determined based on the corresponding auth method called before \`verifyOtp\` to sign up / sign-in a user.\\n- The \`TokenHash\` is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details.", - "examples": [ - { - "id": "verify-signup-one-time-password-otp", - "name": "Verify Signup One-Time Password (OTP)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"recovery_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n },\\n \\"session\\": {\\n \\"access_token\\": \\"\\",\\n \\"token_type\\": \\"bearer\\",\\n \\"expires_in\\": 3600,\\n \\"expires_at\\": 1700000000,\\n \\"refresh_token\\": \\"\\",\\n \\"user\\": {\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"aud\\": \\"authenticated\\",\\n \\"role\\": \\"authenticated\\",\\n \\"email\\": \\"example@email.com\\",\\n \\"email_confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"phone\\": \\"\\",\\n \\"confirmed_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"recovery_sent_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"app_metadata\\": {\\n \\"provider\\": \\"email\\",\\n \\"providers\\": [\\n \\"email\\"\\n ]\\n },\\n \\"user_metadata\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"identities\\": [\\n {\\n \\"identity_id\\": \\"22222222-2222-2222-2222-222222222222\\",\\n \\"id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"user_id\\": \\"11111111-1111-1111-1111-111111111111\\",\\n \\"identity_data\\": {\\n \\"email\\": \\"example@email.com\\",\\n \\"email_verified\\": false,\\n \\"phone_verified\\": false,\\n \\"sub\\": \\"11111111-1111-1111-1111-111111111111\\"\\n },\\n \\"provider\\": \\"email\\",\\n \\"last_sign_in_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"email\\": \\"example@email.com\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"updated_at\\": \\"2024-01-01T00:00:00Z\\",\\n \\"is_anonymous\\": false\\n }\\n }\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "verify-sms-one-time-password-otp", - "name": "Verify SMS One-Time Password (OTP)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\\n\`\`\`" - }, - { - "id": "verify-email-auth-token-hash", - "name": "Verify Email Auth (Token Hash)", - "code": "\`\`\`js\\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\\n\`\`\`" - } - ] - } - }, - "@supabase/auth-js.NavigatorLockAcquireTimeoutError.constructor": { - "name": "@supabase/auth-js.NavigatorLockAcquireTimeoutError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "NavigatorLockAcquireTimeoutError" - } - } - } - }, - "variables": {} - }, - { - "name": "@supabase/postgrest-js", - "methods": { - "@supabase/postgrest-js.PostgrestBuilder.constructor": { - "name": "@supabase/postgrest-js.PostgrestBuilder.constructor", - "params": [ - { - "name": "builder", - "type": { - "type": "object", - "properties": [ - { - "name": "body", - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "URL" - }, - { - "type": "nameOnly", - "name": "RequestInfo" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - } - }, - { - "name": "isMaybeSingle", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "method", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "shouldStripNulls", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "shouldThrowOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Creates a builder configured for a specific PostgREST request.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('users').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\\n\\nconst builder = new PostgrestQueryBuilder(\\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestBuilder.overrideTypes": { - "name": "@supabase/postgrest-js.PostgrestBuilder.overrideTypes", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`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\`\`\`" - }, - { - "id": "complete-override-type-of-successful-response", - "name": "Complete Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes, { merge: false }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "complete-override-type-of-object-response", - "name": "Complete Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType | null\\n\`\`\`" - }, - { - "id": "partial-override-type-of-successful-response", - "name": "Partial Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // Array\\n\`\`\`" - }, - { - "id": "partial-override-type-of-object-response", - "name": "Partial Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes<{ status: \\"A\\" | \\"B\\" }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // CountryRowProperties & { status: \\"A\\" | \\"B\\" } | null\\n\`\`\`" - }, - { - "id": "merge-vs-replace-existing-types", - "name": "Merge vs replace existing types", - "code": "\`\`\`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.retry": { - "name": "@supabase/postgrest-js.PostgrestBuilder.retry", - "params": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "Whether to enable retries for this request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\n// Disable retries for a specific query\\nconst { data, error } = await supabase\\n .from('users')\\n .select()\\n .retry(false)\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestBuilder.returns": { - "name": "@supabase/postgrest-js.PostgrestBuilder.returns", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\`." - } - }, - "@supabase/postgrest-js.PostgrestBuilder.setHeader": { - "name": "@supabase/postgrest-js.PostgrestBuilder.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request." - } - }, - "@supabase/postgrest-js.PostgrestBuilder.stripNulls": { - "name": "@supabase/postgrest-js.PostgrestBuilder.stripNulls", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Strip null values from the response data. Properties with \`null\` values\\nwill be omitted from the returned JSON objects.\\n\\nRequires PostgREST 11.2.0+.\\n\\nhttps://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .stripNulls()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text, bio text);\\n\\ninsert into\\n characters (id, name, bio)\\nvalues\\n (1, 'Luke', null),\\n (2, 'Leia', 'Princess of Alderaan');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\",\\n \\"bio\\": \\"Princess of Alderaan\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestBuilder.then": { - "name": "@supabase/postgrest-js.PostgrestBuilder.then", - "params": [ - { - "name": "onfulfilled", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "value" - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is resolved." - } - }, - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult2" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PromiseLike" - } - }, - "comment": { - "shortText": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - }, - "@supabase/postgrest-js.PostgrestBuilder.throwOnError": { - "name": "@supabase/postgrest-js.PostgrestBuilder.throwOnError", - "params": [], - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" - } - }, - "@supabase/postgrest-js.PostgrestClient.constructor": { - "name": "@supabase/postgrest-js.PostgrestClient.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "URL of the PostgREST endpoint" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "URL" - }, - { - "type": "nameOnly", - "name": "RequestInfo" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true, - "comment": { - "shortText": "Custom fetch" - } - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - }, - "isOptional": true, - "comment": { - "shortText": "Custom headers" - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Enable or disable automatic retries for transient errors.\\n When enabled, idempotent requests (GET, HEAD, OPTIONS) that fail with network\\n errors or HTTP 503/520 responses will be automatically retried up to 3 times\\n with exponential backoff (1s, 2s, 4s). Defaults to \`true\`." - } - }, - { - "name": "schema", - "type": { - "type": "nameOnly", - "name": "@supabase/postgrest-js.default.SchemaName" - }, - "isOptional": true, - "comment": { - "shortText": "Postgres schema to switch to" - } - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Optional timeout in milliseconds for all requests. When set, requests will automatically abort after this duration to prevent indefinite hangs." - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Maximum URL length in characters before warnings/errors are triggered. Defaults to 8000." - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestClient" - } - }, - "comment": { - "shortText": "Creates a PostgREST client.", - "text": "- A \`timeout\` option (in milliseconds) can be set to automatically abort requests that take too long.\\n- A \`urlLengthLimit\` option (default: 8000) can be set to control when URL length warnings are included in error messages for aborted requests.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('profiles').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestClient } from '@supabase/postgrest-js'\\n\\nconst postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {\\n headers: { apikey: 'your-publishable-key' },\\n schema: 'public',\\n timeout: 30000, // 30 second timeout\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestClient.from": { - "name": "@supabase/postgrest-js.PostgrestClient.from", - "params": [ - { - "name": "relation", - "type": { - "type": "nameOnly", - "name": "TableName" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestQueryBuilder" - } - }, - "comment": { - "shortText": "Perform a query on a table or a view." - }, - "altSignatures": [ - { - "params": [ - { - "name": "relation", - "type": { - "type": "nameOnly", - "name": "ViewName" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestQueryBuilder" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestClient.rpc": { - "name": "@supabase/postgrest-js.PostgrestClient.rpc", - "params": [ - { - "name": "fn", - "type": { - "type": "nameOnly", - "name": "FnName" - }, - "comment": { - "shortText": "The function name to call" - } - }, - { - "name": "args", - "type": { - "type": "nameOnly", - "name": "Args" - }, - "comment": { - "shortText": "The arguments to pass to the function call" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - null, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count rows returned by the\\nfunction. Only applicable for [set-returning\\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - }, - { - "name": "get", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When set to \`true\`, the function will be called with\\nread-only access mode." - } - }, - { - "name": "head", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When set to \`true\`, \`data\` will not be returned.\\nUseful if you only need the count." - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a function call.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\n// For cross-schema functions where type inference fails, use overrideTypes:\\nconst { data } = await supabase\\n .schema('schema_b')\\n .rpc('function_a', {})\\n .overrideTypes<{ id: string; user_id: string }[]>()\\n\`\`\`" - }, - { - "id": "call-a-postgres-function-without-arguments", - "name": "Call a Postgres function without arguments", - "code": "\`\`\`ts\\nconst { data, error } = await supabase.rpc('hello_world')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate function hello_world() returns text as $$\\n select 'Hello world';\\n$$ language sql;\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": \\"Hello world\\",\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "call-a-postgres-function-with-arguments", - "name": "Call a Postgres function with arguments", - "code": "\`\`\`ts\\nconst { data, error } = await supabase.rpc('echo', { say: '👋' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate function echo(say text) returns text as $$\\n select say;\\n$$ language sql;\\n\`\`\`" - }, - "response": "\`\`\`json\\n {\\n \\"data\\": \\"👋\\",\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n }\\n\\n\`\`\`" - }, - { - "id": "bulk-processing", - "name": "Bulk processing", - "code": "\`\`\`ts\\nconst { data, error } = await supabase.rpc('add_one_each', { arr: [1, 2, 3] })\\n\`\`\`", - "description": "You can process large payloads by passing in an array as an argument.", - "data": { - "sql": "\`\`\`sql\\ncreate function add_one_each(arr int[]) returns int[] as $$\\n select array_agg(n + 1) from unnest(arr) as n;\\n$$ language sql;\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n 2,\\n 3,\\n 4\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "call-a-postgres-function-with-filters", - "name": "Call a Postgres function with filters", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .rpc('list_stored_countries')\\n .eq('id', 1)\\n .single()\\n\`\`\`", - "description": "Postgres functions that return tables can also be combined with [Filters](/docs/reference/javascript/using-filters) and [Modifiers](/docs/reference/javascript/using-modifiers).", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'Rohan'),\\n (2, 'The Shire');\\n\\ncreate function list_stored_countries() returns setof countries as $$\\n select * from countries;\\n$$ language sql;\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"Rohan\\"\\n },\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "call-a-read-only-postgres-function", - "name": "Call a read-only Postgres function", - "code": "\`\`\`ts\\nconst { data, error } = await supabase.rpc('hello_world', undefined, { get: true })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate function hello_world() returns text as $$\\n select 'Hello world';\\n$$ language sql;\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": \\"Hello world\\",\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestClient.schema": { - "name": "@supabase/postgrest-js.PostgrestClient.schema", - "params": [ - { - "name": "schema", - "type": { - "type": "nameOnly", - "name": "DynamicSchema" - }, - "comment": { - "shortText": "The schema to query" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestClient" - } - }, - "comment": { - "shortText": "Select a schema to query or perform an function (rpc) call.\\n\\nThe schema needs to be on the list of exposed schemas inside Supabase." - } - }, - "@supabase/postgrest-js.PostgrestError.constructor": { - "name": "@supabase/postgrest-js.PostgrestError.constructor", - "params": [ - { - "name": "context", - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "details", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "hint", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestError" - } - }, - "comment": { - "shortText": "", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\nimport PostgrestError from '@supabase/postgrest-js'\\n\\nthrow new PostgrestError({\\n message: 'Row level security prevented the request',\\n details: 'RLS denied the insert',\\n hint: 'Check your policies',\\n code: 'PGRST301',\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestError.toJSON": { - "name": "@supabase/postgrest-js.PostgrestError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "details", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "hint", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.constructor": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.constructor", - "params": [ - { - "name": "builder", - "type": { - "type": "object", - "properties": [ - { - "name": "body", - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "URL" - }, - { - "type": "nameOnly", - "name": "RequestInfo" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - } - }, - { - "name": "isMaybeSingle", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "method", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "shouldStripNulls", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "shouldThrowOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Creates a builder configured for a specific PostgREST request.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('users').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\\n\\nconst builder = new PostgrestQueryBuilder(\\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.abortSignal": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.abortSignal", - "params": [ - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "comment": { - "shortText": "The AbortSignal to use for the fetch request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set the AbortSignal for the fetch request.", - "text": "You can use this to set a timeout for the request.", - "examples": [ - { - "id": "aborting-requests-in-flight", - "name": "Aborting requests in-flight", - "code": "\`\`\`ts\\nconst ac = new AbortController()\\n\\nconst { data, error } = await supabase\\n .from('very_big_table')\\n .select()\\n .abortSignal(ac.signal)\\n\\n// Abort the request after 100 ms\\nsetTimeout(() => ac.abort(), 100)\\n\`\`\`", - "description": "You can use an [\`AbortController\`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\\nNote that \`status\` and \`statusText\` don't mean anything for aborted requests as the request wasn't fulfilled.", - "response": "\`\`\`json\\n {\\n \\"error\\": {\\n \\"message\\": \\"AbortError: The user aborted a request.\\",\\n \\"details\\": \\"\\",\\n \\"hint\\": \\"The request was aborted locally via the provided AbortSignal.\\",\\n \\"code\\": \\"\\"\\n },\\n \\"status\\": 0,\\n \\"statusText\\": \\"\\"\\n }\\n\\n\`\`\`" - }, - { - "id": "set-a-timeout", - "name": "Set a timeout", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('very_big_table')\\n .select()\\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\\n\`\`\`", - "response": "\`\`\`json\\n {\\n \\"error\\": {\\n \\"message\\": \\"FetchError: The user aborted a request.\\",\\n \\"details\\": \\"\\",\\n \\"hint\\": \\"\\",\\n \\"code\\": \\"\\"\\n },\\n \\"status\\": 400,\\n \\"statusText\\": \\"Bad Request\\"\\n }\\n\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.containedBy": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.containedBy", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\\nevery element appearing in \`column\` is contained by \`value\`.", - "examples": [ - { - "id": "on-array-columns", - "name": "On array columns", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('classes')\\n .select('name')\\n .containedBy('days', ['monday', 'tuesday', 'wednesday', 'friday'])\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n classes (\\n id int8 primary key,\\n name text,\\n days text[]\\n );\\n\\ninsert into\\n classes (id, name, days)\\nvalues\\n (1, 'Chemistry', array['monday', 'friday']),\\n (2, 'History', array['monday', 'wednesday', 'thursday']);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Chemistry\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-range-columns", - "name": "On range columns", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('reservations')\\n .select()\\n .containedBy('during', '[2000-01-01 00:00, 2000-01-01 23:59)')\\n\`\`\`", - "description": "Postgres supports a number of [range\\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\\ncan filter on range columns using the string representation of range\\nvalues.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n reservations (\\n id int8 primary key,\\n room_name text,\\n during tsrange\\n );\\n\\ninsert into\\n reservations (id, room_name, during)\\nvalues\\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"room_name\\": \\"Emerald\\",\\n \\"during\\": \\"[\\\\\\"2000-01-01 13:00:00\\\\\\",\\\\\\"2000-01-01 15:00:00\\\\\\")\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-jsonb-columns", - "name": "On \`jsonb\` columns", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .select('name')\\n .containedBy('address', {})\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text,\\n address jsonb\\n );\\n\\ninsert into\\n users (id, name, address)\\nvalues\\n (1, 'Michael', '{ \\"postcode\\": 90210, \\"street\\": \\"Melrose Place\\" }'),\\n (2, 'Jane', '{}');\\n\`\`\`" - }, - "response": "\`\`\`json\\n {\\n \\"data\\": [\\n {\\n \\"name\\": \\"Jane\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n }\\n\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.contains": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.contains", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\\n\`column\` contains every element appearing in \`value\`.", - "examples": [ - { - "id": "on-array-columns", - "name": "On array columns", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('issues')\\n .select()\\n .contains('tags', ['is:open', 'priority:low'])\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n issues (\\n id int8 primary key,\\n title text,\\n tags text[]\\n );\\n\\ninsert into\\n issues (id, title, tags)\\nvalues\\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"title\\": \\"Cache invalidation is not working\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-range-columns", - "name": "On range columns", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('reservations')\\n .select()\\n .contains('during', '[2000-01-01 13:00, 2000-01-01 13:30)')\\n\`\`\`", - "description": "Postgres supports a number of [range\\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\\ncan filter on range columns using the string representation of range\\nvalues.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n reservations (\\n id int8 primary key,\\n room_name text,\\n during tsrange\\n );\\n\\ninsert into\\n reservations (id, room_name, during)\\nvalues\\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"room_name\\": \\"Emerald\\",\\n \\"during\\": \\"[\\\\\\"2000-01-01 13:00:00\\\\\\",\\\\\\"2000-01-01 15:00:00\\\\\\")\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-jsonb-columns", - "name": "On \`jsonb\` columns", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .select('name')\\n .contains('address', { postcode: 90210 })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text,\\n address jsonb\\n );\\n\\ninsert into\\n users (id, name, address)\\nvalues\\n (1, 'Michael', '{ \\"postcode\\": 90210, \\"street\\": \\"Melrose Place\\" }'),\\n (2, 'Jane', '{}');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Michael\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.csv": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.csv", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a string in CSV format.", - "examples": [ - { - "id": "return-data-as-csv", - "name": "Return data as CSV", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .csv()\\n\`\`\`", - "description": "By default, the data is returned in JSON format, but can also be returned as Comma Separated Values.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": \\"id,name\\\\n1,Luke\\\\n2,Leia\\\\n3,Han\\",\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.eq": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.eq", - "params": [ - { - "name": "column", - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "value", - "comment": { - "shortText": "The value to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is equal to \`value\`.\\n\\nTo check if the value of \`column\` is NULL, you should use \`.is()\` instead.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .eq('name', 'Leia')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.explain": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.explain", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "analyze", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, the query will be executed and the\\nactual run time will be returned" - } - }, - { - "name": "buffers", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on buffer usage" - } - }, - { - "name": "format", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The format of the output, can be \`\\"text\\"\` (default)\\nor \`\\"json\\"\`" - } - }, - { - "name": "settings", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on configuration\\nparameters that affect query planning" - } - }, - { - "name": "verbose", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, the query identifier will be returned\\nand \`data\` will include the output columns of the query" - } - }, - { - "name": "wal", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on WAL record generation" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "PostgrestBuilder" - }, - { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - ] - } - }, - "comment": { - "shortText": "Return \`data\` as the EXPLAIN plan for the query.\\n\\nYou need to enable the\\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\\nsetting before using this method.", - "examples": [ - { - "id": "get-the-execution-plan", - "name": "Get the execution plan", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .explain()\\n\`\`\`", - "description": "By default, the data is returned in TEXT format, but can also be returned as JSON by using the \`format\` parameter.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`js\\nAggregate (cost=33.34..33.36 rows=1 width=112)\\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\\n\`\`\`" - }, - { - "id": "get-the-execution-plan-with-analyze-and-verbose", - "name": "Get the execution plan with analyze and verbose", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .explain({analyze:true,verbose:true})\\n\`\`\`", - "description": "By default, the data is returned in TEXT format, but can also be returned as JSON by using the \`format\` parameter.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`js\\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\\n Output: characters.id, characters.name\\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\\n Output: characters.id, characters.name\\nQuery Identifier: -4730654291623321173\\nPlanning Time: 0.407 ms\\nExecution Time: 0.119 ms\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.filter": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.filter", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "operator", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "FilterOperator" - }, - { - "type": "literal", - "value": "not.match" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.isdistinct" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - }, - { - "type": "literal", - "value": "not.imatch" - } - ] - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\\nshould use the specific filter methods wherever possible.\\n\\nUnlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized.", - "text": "filter() expects you to use the raw PostgREST syntax for the filter values.\\n\\n\`\`\`ts\\n.filter('id', 'in', '(5,6,7)') // Use \`()\` for \`in\` filter\\n.filter('arraycol', 'cs', '{\\"a\\",\\"b\\"}') // Use \`cs\` for \`contains()\`, \`{}\` for array values\\n\`\`\`", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .filter('name', 'in', '(\\"Han\\",\\"Yoda\\")')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-a-referenced-table", - "name": "On a referenced table", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments!inner (\\n name\\n )\\n \`)\\n .filter('instruments.name', 'eq', 'flute')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"woodwinds\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"flute\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "operator", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.geojson": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.geojson", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as an object in [GeoJSON](https://geojson.org) format." - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.gt": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.gt", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is greater than \`value\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .gt('id', 2)\\n\`\`\`", - "description": "When using [reserved words](https://www.postgresql.org/docs/current/sql-keywords-appendix.html) for column names you need\\nto add double quotes e.g. \`.gt('\\"order\\"', 2)\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.gte": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.gte", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is greater than or equal to \`value\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .gte('id', 2)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.ilike": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.ilike", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` matches \`pattern\` case-insensitively.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .ilike('name', '%lu%')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.ilikeAllOf": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.ilikeAllOf", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` matches all of \`patterns\` case-insensitively." - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.ilikeAnyOf": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.ilikeAnyOf", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` matches any of \`patterns\` case-insensitively." - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.in": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.in", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "values", - "type": { - "type": "array" - }, - "comment": { - "shortText": "The values array to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is included in the \`values\` array.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .in('name', ['Leia', 'Han'])\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.is": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.is", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value" - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` IS \`value\`.\\n\\nFor non-boolean columns, this is only relevant for checking if the value of\\n\`column\` is NULL by setting \`value\` to \`null\`.\\n\\nFor boolean columns, you can also set \`value\` to \`true\` or \`false\` and it\\nwill behave the same way as \`.eq()\`.", - "examples": [ - { - "id": "checking-for-nullness-true-or-false", - "name": "Checking for nullness, true or false", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('countries')\\n .select()\\n .is('name', null)\\n\`\`\`", - "description": "Using the \`eq()\` filter doesn't work when filtering for \`null\`.\\n\\nInstead, you need to use \`is()\`.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'null'),\\n (2, null);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"null\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.isDistinct": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.isDistinct", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "value", - "comment": { - "shortText": "The value to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` IS DISTINCT FROM \`value\`.\\n\\nUnlike \`.neq()\`, this treats \`NULL\` as a comparable value. Two \`NULL\` values\\nare considered equal (not distinct), and comparing \`NULL\` with any non-NULL\\nvalue returns true (distinct)." - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.like": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.like", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` matches \`pattern\` case-sensitively.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .like('name', '%Lu%')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.likeAllOf": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.likeAllOf", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` matches all of \`patterns\` case-sensitively." - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.likeAnyOf": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.likeAnyOf", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` matches any of \`patterns\` case-sensitively." - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "patterns", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.limit": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.limit", - "params": [ - { - "name": "count", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The maximum number of rows to return" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to limit rows of referenced\\ntables instead of the parent table" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Limit the query result by \`count\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .limit(1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-a-referenced-table", - "name": "On a referenced table", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments (\\n name\\n )\\n \`)\\n .limit(1, { referencedTable: 'instruments' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 1, 'harp'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.lt": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.lt", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is less than \`value\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .lt('id', 2)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.lte": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.lte", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is less than or equal to \`value\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .lte('id', 2)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.match": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.match", - "params": [ - { - "name": "query", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "nameOnly", - "name": "ColumnName" - }, - "valueType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where each column in \`query\` keys is equal to its\\nassociated value. Shorthand for multiple \`.eq()\`s.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .match({ id: 2, name: 'Leia' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Leia\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "query", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.maxAffected": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.maxAffected", - "params": [ - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The maximum number of rows that can be affected" - } - } - ], - "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.maybeSingle": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.maybeSingle", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be zero or one row (e.g. using \`.limit(1)\`), otherwise\\nthis returns an error.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .eq('name', 'Katniss')\\n .maybeSingle()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.neq": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.neq", - "params": [ - { - "name": "column", - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "value", - "comment": { - "shortText": "The value to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is not equal to \`value\`.\\n\\nThis filter does not include rows where \`column\` is \`NULL\`. To match null\\nvalues, use \`.is(column, null)\` instead.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .neq('name', 'Leia')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.not": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.not", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "operator", - "type": { - "type": "literal", - "value": "is" - } - }, - { - "name": "value", - "type": { - "type": "literal", - "value": null - } - } - ], - "comment": { - "shortText": "Match only rows which doesn't satisfy the filter.\\n\\nUnlike most filters, \`opearator\` and \`value\` are used as-is and need to\\nfollow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure they are properly sanitized.", - "text": "not() expects you to use the raw PostgREST syntax for the filter values.\\n\\n\`\`\`ts\\n.not('id', 'in', '(5,6,7)') // Use \`()\` for \`in\` filter\\n.not('arraycol', 'cs', '{\\"a\\",\\"b\\"}') // Use \`cs\` for \`contains()\`, \`{}\` for array values\\n\`\`\`", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('countries')\\n .select()\\n .not('name', 'is', null)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'null'),\\n (2, null);\\n\`\`\`" - }, - "response": "\`\`\`json\\n {\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"null\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n }\\n\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "operator", - "type": { - "type": "nameOnly", - "name": "FilterOperator" - } - }, - { - "name": "value", - "type": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "operator", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.notIn": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.notIn", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - }, - "comment": { - "shortText": "The column to filter on" - } - }, - { - "name": "values", - "type": { - "type": "array" - }, - "comment": { - "shortText": "The values array to filter with" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` is NOT included in the \`values\` array." - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.or": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.or", - "params": [ - { - "name": "filters", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The filters to use, following PostgREST syntax" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`referencedTable\` instead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to filter on referenced tables\\ninstead of the parent table" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows which satisfy at least one of the filters.\\n\\nUnlike most filters, \`filters\` is used as-is and needs to follow [PostgREST\\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\\nto make sure it's properly sanitized.\\n\\nIt's currently not possible to do an \`.or()\` filter across multiple tables.", - "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\\n\\n\`\`\`ts\\n.or('id.in.(5,6,7), arraycol.cs.{\\"a\\",\\"b\\"}') // Use \`()\` for \`in\` filter, \`{}\` for array values and \`cs\` for \`contains()\`.\\n.or('id.in.(5,6,7), arraycol.cd.{\\"a\\",\\"b\\"}') // Use \`cd\` for \`containedBy()\`\\n\`\`\`", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .or('id.eq.2,name.eq.Han')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Leia\\"\\n },\\n {\\n \\"name\\": \\"Han\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "use-or-with-and", - "name": "Use \`or\` with \`and\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "use-or-on-referenced-tables", - "name": "Use \`or\` on referenced tables", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments!inner (\\n name\\n )\\n \`)\\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.order": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.order", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Order the query result by \`column\`.\\n\\nYou 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.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('id, name')\\n .order('id', { ascending: false })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\"\\n },\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-a-referenced-table", - "name": "On a referenced table", - "code": "\`\`\`ts\\n const { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments (\\n name\\n )\\n \`)\\n .order('name', { referencedTable: 'instruments', ascending: false })\\n\\n\`\`\`", - "description": "Ordering with \`referencedTable\` doesn't affect the ordering of the\\nparent table.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 1, 'harp'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n },\\n {\\n \\"name\\": \\"harp\\"\\n }\\n ]\\n },\\n {\\n \\"name\\": \\"woodwinds\\",\\n \\"instruments\\": []\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "order-parent-table-by-a-referenced-table", - "name": "Order parent table by a referenced table", - "code": "\`\`\`ts\\n const { data, error } = await supabase\\n .from('instruments')\\n .select(\`\\n name,\\n section:orchestral_sections (\\n name\\n )\\n \`)\\n .order('section(name)', { ascending: true })\\n\\n\`\`\`", - "description": "Ordering with \`referenced_table(col)\` affects the ordering of the\\nparent table.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"violin\\",\\n \\"orchestral_sections\\": {\\"name\\": \\"strings\\"}\\n },\\n {\\n \\"name\\": \\"flute\\",\\n \\"orchestral_sections\\": {\\"name\\": \\"woodwinds\\"}\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "" - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "" - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.overlaps": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.overlaps", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Row['ColumnName']" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for array and range columns. Match only rows where\\n\`column\` and \`value\` have an element in common.", - "examples": [ - { - "id": "on-array-columns", - "name": "On array columns", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('issues')\\n .select('title')\\n .overlaps('tags', ['is:closed', 'severity:high'])\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n issues (\\n id int8 primary key,\\n title text,\\n tags text[]\\n );\\n\\ninsert into\\n issues (id, title, tags)\\nvalues\\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"title\\": \\"Cache invalidation is not working\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-range-columns", - "name": "On range columns", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('reservations')\\n .select()\\n .overlaps('during', '[2000-01-01 12:45, 2000-01-01 13:15)')\\n\`\`\`", - "description": "Postgres supports a number of [range\\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\\ncan filter on range columns using the string representation of range\\nvalues.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n reservations (\\n id int8 primary key,\\n room_name text,\\n during tsrange\\n );\\n\\ninsert into\\n reservations (id, room_name, during)\\nvalues\\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"room_name\\": \\"Emerald\\",\\n \\"during\\": \\"[\\\\\\"2000-01-01 13:00:00\\\\\\",\\\\\\"2000-01-01 15:00:00\\\\\\")\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.overrideTypes": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.overrideTypes", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`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\`\`\`" - }, - { - "id": "complete-override-type-of-successful-response", - "name": "Complete Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes, { merge: false }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "complete-override-type-of-object-response", - "name": "Complete Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType | null\\n\`\`\`" - }, - { - "id": "partial-override-type-of-successful-response", - "name": "Partial Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // Array\\n\`\`\`" - }, - { - "id": "partial-override-type-of-object-response", - "name": "Partial Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes<{ status: \\"A\\" | \\"B\\" }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // CountryRowProperties & { status: \\"A\\" | \\"B\\" } | null\\n\`\`\`" - }, - { - "id": "merge-vs-replace-existing-types", - "name": "Merge vs replace existing types", - "code": "\`\`\`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": [ - { - "name": "from", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The starting index from which to limit the result" - } - }, - { - "name": "to", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The last index to which to limit the result" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to limit rows of referenced\\ntables instead of the parent table" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "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.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .range(0, 1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"name\\": \\"Leia\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.rangeAdjacent": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeAdjacent", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where \`column\` is\\nmutually exclusive to \`range\` and there can be no element between the two\\nranges.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('reservations')\\n .select()\\n .rangeAdjacent('during', '[2000-01-01 12:00, 2000-01-01 13:00)')\\n\`\`\`", - "description": "Postgres supports a number of [range\\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\\ncan filter on range columns using the string representation of range\\nvalues.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n reservations (\\n id int8 primary key,\\n room_name text,\\n during tsrange\\n );\\n\\ninsert into\\n reservations (id, room_name, during)\\nvalues\\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"room_name\\": \\"Emerald\\",\\n \\"during\\": \\"[\\\\\\"2000-01-01 13:00:00\\\\\\",\\\\\\"2000-01-01 15:00:00\\\\\\")\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.rangeGt": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeGt", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\\n\`column\` is greater than any element in \`range\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('reservations')\\n .select()\\n .rangeGt('during', '[2000-01-02 08:00, 2000-01-02 09:00)')\\n\`\`\`", - "description": "Postgres supports a number of [range\\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\\ncan filter on range columns using the string representation of range\\nvalues.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n reservations (\\n id int8 primary key,\\n room_name text,\\n during tsrange\\n );\\n\\ninsert into\\n reservations (id, room_name, during)\\nvalues\\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\\n\`\`\`" - }, - "response": "\`\`\`json\\n {\\n \\"data\\": [\\n {\\n \\"id\\": 2,\\n \\"room_name\\": \\"Topaz\\",\\n \\"during\\": \\"[\\\\\\"2000-01-02 09:00:00\\\\\\",\\\\\\"2000-01-02 10:00:00\\\\\\")\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n }\\n\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.rangeGte": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeGte", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\\n\`column\` is either contained in \`range\` or greater than any element in\\n\`range\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('reservations')\\n .select()\\n .rangeGte('during', '[2000-01-02 08:30, 2000-01-02 09:30)')\\n\`\`\`", - "description": "Postgres supports a number of [range\\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\\ncan filter on range columns using the string representation of range\\nvalues.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n reservations (\\n id int8 primary key,\\n room_name text,\\n during tsrange\\n );\\n\\ninsert into\\n reservations (id, room_name, during)\\nvalues\\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\\n\`\`\`" - }, - "response": "\`\`\`json\\n {\\n \\"data\\": [\\n {\\n \\"id\\": 2,\\n \\"room_name\\": \\"Topaz\\",\\n \\"during\\": \\"[\\\\\\"2000-01-02 09:00:00\\\\\\",\\\\\\"2000-01-02 10:00:00\\\\\\")\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n }\\n\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.rangeLt": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeLt", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\\n\`column\` is less than any element in \`range\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('reservations')\\n .select()\\n .rangeLt('during', '[2000-01-01 15:00, 2000-01-01 16:00)')\\n\`\`\`", - "description": "Postgres supports a number of [range\\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\\ncan filter on range columns using the string representation of range\\nvalues.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n reservations (\\n id int8 primary key,\\n room_name text,\\n during tsrange\\n );\\n\\ninsert into\\n reservations (id, room_name, during)\\nvalues\\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"room_name\\": \\"Emerald\\",\\n \\"during\\": \\"[\\\\\\"2000-01-01 13:00:00\\\\\\",\\\\\\"2000-01-01 15:00:00\\\\\\")\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.rangeLte": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeLte", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for range columns. Match only rows where every element in\\n\`column\` is either contained in \`range\` or less than any element in\\n\`range\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('reservations')\\n .select()\\n .rangeLte('during', '[2000-01-01 14:00, 2000-01-01 16:00)')\\n\`\`\`", - "description": "Postgres supports a number of [range\\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\\ncan filter on range columns using the string representation of range\\nvalues.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n reservations (\\n id int8 primary key,\\n room_name text,\\n during tsrange\\n );\\n\\ninsert into\\n reservations (id, room_name, during)\\nvalues\\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\\n\`\`\`" - }, - "response": "\`\`\`json\\n {\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"room_name\\": \\"Emerald\\",\\n \\"during\\": \\"[\\\\\\"2000-01-01 13:00:00\\\\\\",\\\\\\"2000-01-01 15:00:00\\\\\\")\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n }\\n\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "range", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.regexIMatch": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.regexIMatch", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` matches the PostgreSQL regex \`pattern\`\\ncase-insensitively (using the \`~*\` operator)." - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.regexMatch": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.regexMatch", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Match only rows where \`column\` matches the PostgreSQL regex \`pattern\`\\ncase-sensitively (using the \`~\` operator)." - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "pattern", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.retry": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.retry", - "params": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "Whether to enable retries for this request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\n// Disable retries for a specific query\\nconst { data, error } = await supabase\\n .from('users')\\n .select()\\n .retry(false)\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.returns": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.returns", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestTransformBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\`.", - "text": "- Deprecated: use overrideTypes method instead", - "examples": [ - { - "id": "override-type-of-successful-response", - "name": "Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .returns>()\\n\`\`\`", - "response": "\`\`\`js\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "override-type-of-object-response", - "name": "Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .returns()\\n\`\`\`", - "response": "\`\`\`js\\nlet x: typeof data // MyType | null\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.rollback": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.rollback", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Rollback the query.\\n\\n\`data\` will still be returned, but the query is not committed." - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.select": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.select", - "params": [ - { - "name": "columns", - "type": { - "type": "nameOnly", - "name": "Query" - }, - "isOptional": true, - "comment": { - "shortText": "The columns to retrieve, separated by commas" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a SELECT on the query result.\\n\\nBy default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`.", - "examples": [ - { - "id": "with-upsert", - "name": "With \`upsert()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .upsert({ id: 1, name: 'Han Solo' })\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Han Solo\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.setHeader": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request." - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.single": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.single", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be one row (e.g. using \`.limit(1)\`), otherwise this\\nreturns an error.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .limit(1)\\n .single()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"name\\": \\"Luke\\"\\n },\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.stripNulls": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.stripNulls", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Strip null values from the response data. Properties with \`null\` values\\nwill be omitted from the returned JSON objects.\\n\\nRequires PostgREST 11.2.0+.\\n\\nhttps://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .stripNulls()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text, bio text);\\n\\ninsert into\\n characters (id, name, bio)\\nvalues\\n (1, 'Luke', null),\\n (2, 'Leia', 'Princess of Alderaan');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\",\\n \\"bio\\": \\"Princess of Alderaan\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.textSearch": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.textSearch", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "query", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Only relevant for text and tsvector columns. Match only rows where\\n\`column\` matches the query string in \`query\`.", - "text": "- For more information, see [Postgres full text search](/docs/guides/database/full-text-search).", - "examples": [ - { - "id": "text-search", - "name": "Text search", - "code": "\`\`\`ts\\nconst result = await supabase\\n .from(\\"texts\\")\\n .select(\\"content\\")\\n .textSearch(\\"content\\", \`'eggs' & 'ham'\`, {\\n config: \\"english\\",\\n });\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table texts (\\n id bigint\\n primary key\\n generated always as identity,\\n content text\\n);\\n\\ninsert into texts (content) values\\n ('Four score and seven years ago'),\\n ('The road goes ever on and on'),\\n ('Green eggs and ham')\\n;\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"content\\": \\"Green eggs and ham\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "basic-normalization", - "name": "Basic normalization", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('quotes')\\n .select('catchphrase')\\n .textSearch('catchphrase', \`'fat' & 'cat'\`, {\\n type: 'plain',\\n config: 'english'\\n })\\n\`\`\`", - "description": "Uses PostgreSQL's \`plainto_tsquery\` function." - }, - { - "id": "full-normalization", - "name": "Full normalization", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('quotes')\\n .select('catchphrase')\\n .textSearch('catchphrase', \`'fat' & 'cat'\`, {\\n type: 'phrase',\\n config: 'english'\\n })\\n\`\`\`", - "description": "Uses PostgreSQL's \`phraseto_tsquery\` function." - }, - { - "id": "websearch", - "name": "Websearch", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('quotes')\\n .select('catchphrase')\\n .textSearch('catchphrase', \`'fat or cat'\`, {\\n type: 'websearch',\\n config: 'english'\\n })\\n\`\`\`", - "description": "Uses PostgreSQL's \`websearch_to_tsquery\` function.\\nThis function will never raise syntax errors, which makes it possible to use raw user-supplied input for search, and can be used\\nwith advanced operators.\\n\\n- \`unquoted text\`: text not inside quote marks will be converted to terms separated by & operators, as if processed by plainto_tsquery.\\n- \`\\"quoted text\\"\`: text inside quote marks will be converted to terms separated by \`<->\` operators, as if processed by phraseto_tsquery.\\n- \`OR\`: the word “or” will be converted to the | operator.\\n- \`-\`: a dash will be converted to the ! operator." - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "query", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - } - ] - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.then": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.then", - "params": [ - { - "name": "onfulfilled", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "value", - "type": { - "type": "union", - "name": "PostgrestSingleResponse", - "subTypes": [ - { - "type": "object", - "name": "PostgrestResponseSuccess", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "@supabase/postgrest-js.default.Result" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusText", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "success", - "type": { - "type": "literal", - "value": true - } - } - ] - }, - { - "type": "object", - "name": "PostgrestResponseFailure", - "properties": [ - { - "name": "count", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "PostgrestError" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusText", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "success", - "type": { - "type": "literal", - "value": false - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is resolved." - } - }, - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult2" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PromiseLike" - } - }, - "comment": { - "shortText": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - }, - "@supabase/postgrest-js.PostgrestFilterBuilder.throwOnError": { - "name": "@supabase/postgrest-js.PostgrestFilterBuilder.throwOnError", - "params": [], - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" - } - }, - "@supabase/postgrest-js.PostgrestQueryBuilder.constructor": { - "name": "@supabase/postgrest-js.PostgrestQueryBuilder.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - }, - "comment": { - "shortText": "The URL for the query" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "URL" - }, - { - "type": "nameOnly", - "name": "RequestInfo" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true, - "comment": { - "shortText": "Custom fetch implementation" - } - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - }, - "isOptional": true, - "comment": { - "shortText": "Custom headers" - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Enable automatic retries for transient errors (default: true)" - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Postgres schema to use" - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Maximum URL length before warning" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestQueryBuilder" - } - }, - "comment": { - "shortText": "Creates a query builder scoped to a Postgres table or view.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('users').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\\n\\nconst query = new PostgrestQueryBuilder(\\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\\n { headers: { apikey: 'your-publishable-key' }, retry: true }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestQueryBuilder.delete": { - "name": "@supabase/postgrest-js.PostgrestQueryBuilder.delete", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - null, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count deleted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a DELETE on the table or view.\\n\\nBy default, deleted rows are not returned. To return it, chain the call\\nwith \`.select()\` after filters.", - "text": "- \`delete()\` should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\\n- If you use \`delete()\` with filters and you have\\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\\n rows visible through \`SELECT\` policies are deleted. Note that by default\\n no rows are visible, so you need at least one \`SELECT\`/\`ALL\` policy that\\n makes the rows visible.\\n- When using \`delete().in()\`, specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal.", - "examples": [ - { - "id": "delete-a-single-record", - "name": "Delete a single record", - "code": "\`\`\`ts\\nconst response = await supabase\\n .from('countries')\\n .delete()\\n .eq('id', 1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'Mordor');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\\nif (error) console.error(error)\\n\`\`\`", - "description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`." - }, - { - "id": "delete-a-record-and-return-it", - "name": "Delete a record and return it", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('countries')\\n .delete()\\n .eq('id', 1)\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'Mordor');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Mordor\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "delete-multiple-records", - "name": "Delete multiple records", - "code": "\`\`\`ts\\nconst response = await supabase\\n .from('countries')\\n .delete()\\n .in('id', [1, 2, 3])\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\\ninsert into\\n countries (id, name)\\nvalues\\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestQueryBuilder.insert": { - "name": "@supabase/postgrest-js.PostgrestQueryBuilder.insert", - "params": [ - { - "name": "values", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RejectExcessProperties" - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "RejectExcessProperties" - } - } - ] - }, - "comment": { - "shortText": "The values to insert. Pass an object to insert a single row\\nor an array to insert multiple rows." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - null, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count inserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - }, - { - "name": "defaultToNull", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Make missing fields default to \`null\`.\\nOtherwise, use the default value for the column. Only applies for bulk\\ninserts." - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform an INSERT into the table or view.\\n\\nBy default, inserted rows are not returned. To return it, chain the call\\nwith \`.select()\`.", - "examples": [ - { - "id": "create-a-record", - "name": "Create a record", - "code": "\`\`\`ts\\nconst { error } = await supabase\\n .from('countries')\\n .insert({ id: 1, name: 'Mordor' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\\nif (error) console.error(error)\\n\`\`\`", - "description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`." - }, - { - "id": "create-a-record-and-return-it", - "name": "Create a record and return it", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('countries')\\n .insert({ id: 1, name: 'Mordor' })\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Mordor\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - }, - { - "id": "bulk-create", - "name": "Bulk create", - "code": "\`\`\`ts\\nconst { error } = await supabase\\n .from('countries')\\n .insert([\\n { id: 1, name: 'Mordor' },\\n { id: 1, name: 'The Shire' },\\n ])\\n\`\`\`", - "description": "A bulk create operation is handled in a single transaction.\\nIf any of the inserts fail, none of the rows are inserted.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n countries (id int8 primary key, name text);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"error\\": {\\n \\"code\\": \\"23505\\",\\n \\"details\\": \\"Key (id)=(1) already exists.\\",\\n \\"hint\\": null,\\n \\"message\\": \\"duplicate key value violates unique constraint \\\\\\"countries_pkey\\\\\\"\\"\\n },\\n \\"status\\": 409,\\n \\"statusText\\": \\"Conflict\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestQueryBuilder.select": { - "name": "@supabase/postgrest-js.PostgrestQueryBuilder.select", - "params": [ - { - "name": "columns", - "type": { - "type": "nameOnly", - "name": "Query" - }, - "isOptional": true, - "comment": { - "shortText": "The columns to retrieve, separated by commas. Columns can be renamed when returned with \`customName:columnName\`" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - null, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count rows in the table or view.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - }, - { - "name": "head", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When set to \`true\`, \`data\` will not be returned.\\nUseful if you only need the count." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a SELECT query on the table or view.", - "text": "When using \`count\` with \`.range()\` or \`.limit()\`, the returned \`count\` is the total number of rows\\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\\n\\n- By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use \`range()\` queries to paginate through your data.\\n- \`select()\` can be combined with [Filters](/docs/reference/javascript/using-filters)\\n- \`select()\` can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\\n- \`apikey\` is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *", - "examples": [ - { - "id": "getting-your-data", - "name": "Getting your data", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Harry'),\\n (2, 'Frodo'),\\n (3, 'Katniss');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Harry\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Frodo\\"\\n },\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Katniss\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { data, error } = await supabase.from('characters').select()\\nif (error) {\\n // Logs the full error: message, code, details, and hint.\\n console.error(error)\\n return\\n}\\n\`\`\`", - "description": "The most useful field on a Postgres error is usually \`hint\` — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (\`code: '42501'\`) arrives with a \`hint\` like \`\\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\\"\`. Log the full \`error\` object so the hint isn't hidden behind \`error.message\`.", - "response": "\`\`\`json\\n{\\n \\"error\\": {\\n \\"code\\": \\"42501\\",\\n \\"details\\": null,\\n \\"hint\\": \\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\\",\\n \\"message\\": \\"permission denied for table characters\\"\\n },\\n \\"status\\": 401,\\n \\"statusText\\": \\"Unauthorized\\"\\n}\\n\`\`\`" - }, - { - "id": "selecting-specific-columns", - "name": "Selecting specific columns", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Frodo'),\\n (2, 'Harry'),\\n (3, 'Katniss');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Frodo\\"\\n },\\n {\\n \\"name\\": \\"Harry\\"\\n },\\n {\\n \\"name\\": \\"Katniss\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "query-referenced-tables", - "name": "Query referenced tables", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments (\\n name\\n )\\n \`)\\n\`\`\`", - "description": "If your database has foreign key relationships, you can query related tables too.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n },\\n {\\n \\"name\\": \\"woodwinds\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"flute\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "query-referenced-tables-with-spaces-in-their-names", - "name": "Query referenced tables with spaces in their names", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .from('orchestral sections')\\n .select(\`\\n name,\\n \\"musical instruments\\" (\\n name\\n )\\n \`)\\n\`\`\`", - "description": "If your table name contains spaces, you must use double quotes in the \`select\` statement to reference the table.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n \\"orchestral sections\\" (id int8 primary key, name text);\\ncreate table\\n \\"musical instruments\\" (\\n id int8 primary key,\\n section_id int8 not null references \\"orchestral sections\\",\\n name text\\n );\\n\\ninsert into\\n \\"orchestral sections\\" (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n \\"musical instruments\\" (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"musical instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n },\\n {\\n \\"name\\": \\"woodwinds\\",\\n \\"musical instruments\\": [\\n {\\n \\"name\\": \\"flute\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "query-referenced-tables-through-a-join-table", - "name": "Query referenced tables through a join table", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .select(\`\\n name,\\n teams (\\n name\\n )\\n \`)\\n \\n\`\`\`", - "description": "If you're in a situation where your tables are **NOT** directly\\nrelated, but instead are joined by a _join table_, you can still use\\nthe \`select()\` method to query the related data. The join table needs\\nto have the foreign keys as part of its composite primary key.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text\\n );\\ncreate table\\n teams (\\n id int8 primary key,\\n name text\\n );\\n-- join table\\ncreate table\\n users_teams (\\n user_id int8 not null references users,\\n team_id int8 not null references teams,\\n -- both foreign keys must be part of a composite primary key\\n primary key (user_id, team_id)\\n );\\n\\ninsert into\\n users (id, name)\\nvalues\\n (1, 'Kiran'),\\n (2, 'Evan');\\ninsert into\\n teams (id, name)\\nvalues\\n (1, 'Green'),\\n (2, 'Blue');\\ninsert into\\n users_teams (user_id, team_id)\\nvalues\\n (1, 1),\\n (1, 2),\\n (2, 2);\\n\`\`\`" - }, - "response": "\`\`\`json\\n {\\n \\"data\\": [\\n {\\n \\"name\\": \\"Kiran\\",\\n \\"teams\\": [\\n {\\n \\"name\\": \\"Green\\"\\n },\\n {\\n \\"name\\": \\"Blue\\"\\n }\\n ]\\n },\\n {\\n \\"name\\": \\"Evan\\",\\n \\"teams\\": [\\n {\\n \\"name\\": \\"Blue\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n }\\n \\n\`\`\`" - }, - { - "id": "query-the-same-referenced-table-multiple-times", - "name": "Query the same referenced table multiple times", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('messages')\\n .select(\`\\n content,\\n from:sender_id(name),\\n to:receiver_id(name)\\n \`)\\n\\n// To infer types, use the name of the table (in this case \`users\`) and\\n// the name of the foreign key constraint.\\nconst { data, error } = await supabase\\n .from('messages')\\n .select(\`\\n content,\\n from:users!messages_sender_id_fkey(name),\\n to:users!messages_receiver_id_fkey(name)\\n \`)\\n\`\`\`", - "description": "If you need to query the same referenced table twice, use the name of the\\njoined column to identify which join to use. You can also give each\\ncolumn an alias.", - "data": { - "sql": "\`\`\`sql\\n create table\\n users (id int8 primary key, name text);\\n\\n create table\\n messages (\\n sender_id int8 not null references users,\\n receiver_id int8 not null references users,\\n content text\\n );\\n\\n insert into\\n users (id, name)\\n values\\n (1, 'Kiran'),\\n (2, 'Evan');\\n\\n insert into\\n messages (sender_id, receiver_id, content)\\n values\\n (1, 2, '👋');\\n \`\`\`\\n\`\`\`\\n\\n@exampleResponse Query the same referenced table multiple times\\n\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"content\\": \\"👋\\",\\n \\"from\\": {\\n \\"name\\": \\"Kiran\\"\\n },\\n \\"to\\": {\\n \\"name\\": \\"Evan\\"\\n }\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`\\n\\n@exampleDescription Query nested foreign tables through a join table\\nYou can use the result of a joined table to gather data in\\nanother foreign table. With multiple references to the same foreign\\ntable you must specify the column on which to conduct the join.\\n\\n@example Query nested foreign tables through a join table\\n\`\`\`ts\\n const { data, error } = await supabase\\n .from('games')\\n .select(\`\\n game_id:id,\\n away_team:teams!games_away_team_fkey (\\n users (\\n id,\\n name\\n )\\n )\\n \`)\\n \\n\`\`\`\\n\\n@exampleSql Query nested foreign tables through a join table\\n\`\`\`sql\\n\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text\\n );\\ncreate table\\n teams (\\n id int8 primary key,\\n name text\\n );\\n-- join table\\ncreate table\\n users_teams (\\n user_id int8 not null references users,\\n team_id int8 not null references teams,\\n\\n primary key (user_id, team_id)\\n );\\ncreate table\\n games (\\n id int8 primary key,\\n home_team int8 not null references teams,\\n away_team int8 not null references teams,\\n name text\\n );\\n\\ninsert into users (id, name)\\nvalues\\n (1, 'Kiran'),\\n (2, 'Evan');\\ninsert into\\n teams (id, name)\\nvalues\\n (1, 'Green'),\\n (2, 'Blue');\\ninsert into\\n users_teams (user_id, team_id)\\nvalues\\n (1, 1),\\n (1, 2),\\n (2, 2);\\ninsert into\\n games (id, home_team, away_team, name)\\nvalues\\n (1, 1, 2, 'Green vs Blue'),\\n (2, 2, 1, 'Blue vs Green');\\n\`\`\`" - } - }, - { - "id": "filtering-through-referenced-tables", - "name": "Filtering through referenced tables", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .select('name, orchestral_sections(*)')\\n .eq('orchestral_sections.name', 'percussion')\\n\`\`\`", - "description": "If the filter on a referenced table's column is not satisfied, the referenced\\ntable returns \`[]\` or \`null\` but the parent table is not filtered out.\\nIf you want to filter out the parent table rows, use the \`!inner\` hint", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"flute\\",\\n \\"orchestral_sections\\": null\\n },\\n {\\n \\"name\\": \\"violin\\",\\n \\"orchestral_sections\\": null\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "querying-referenced-table-with-count", - "name": "Querying referenced table with count", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`*, instruments(count)\`)\\n\`\`\`", - "description": "You can get the number of rows in a related table by using the\\n**count** property.", - "data": { - "sql": "\`\`\`sql\\ncreate table orchestral_sections (\\n \\"id\\" \\"uuid\\" primary key default \\"extensions\\".\\"uuid_generate_v4\\"() not null,\\n \\"name\\" text\\n);\\n\\ncreate table characters (\\n \\"id\\" \\"uuid\\" primary key default \\"extensions\\".\\"uuid_generate_v4\\"() not null,\\n \\"name\\" text,\\n \\"section_id\\" \\"uuid\\" references public.orchestral_sections on delete cascade\\n);\\n\\nwith section as (\\n insert into orchestral_sections (name)\\n values ('strings') returning id\\n)\\ninsert into instruments (name, section_id) values\\n('violin', (select id from section)),\\n('viola', (select id from section)),\\n('cello', (select id from section)),\\n('double bass', (select id from section));\\n\`\`\`" - }, - "response": "\`\`\`json\\n[\\n {\\n \\"id\\": \\"693694e7-d993-4360-a6d7-6294e325d9b6\\",\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"count\\": 4\\n }\\n ]\\n }\\n]\\n\`\`\`" - }, - { - "id": "querying-with-count-option", - "name": "Querying with count option", - "code": "\`\`\`ts\\nconst { count, error } = await supabase\\n .from('characters')\\n .select('*', { count: 'exact', head: true })\\n\`\`\`", - "description": "You can get the number of rows by using the\\n[count](/docs/reference/javascript/select#parameters) option.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"count\\": 3,\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "querying-json-data", - "name": "Querying JSON data", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .select(\`\\n id, name,\\n address->city\\n \`)\\n\`\`\`", - "description": "You can select and filter data inside of\\n[JSON](/docs/guides/database/json) columns. Postgres offers some\\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\\nquerying JSON data.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text,\\n address jsonb\\n );\\n\\ninsert into\\n users (id, name, address)\\nvalues\\n (1, 'Frodo', '{\\"city\\":\\"Hobbiton\\"}');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Frodo\\",\\n \\"city\\": \\"Hobbiton\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "querying-referenced-table-with-inner-join", - "name": "Querying referenced table with inner join", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .select('name, orchestral_sections!inner(name)')\\n .eq('orchestral_sections.name', 'woodwinds')\\n .limit(1)\\n\`\`\`", - "description": "If you don't want to return the referenced table contents, you can leave the parenthesis empty.\\nLike \`.select('name, orchestral_sections!inner()')\`.", - "data": { - "sql": "\`\`\`sql\\ncreate table orchestral_sections (\\n \\"id\\" \\"uuid\\" primary key default \\"extensions\\".\\"uuid_generate_v4\\"() not null,\\n \\"name\\" text\\n);\\n\\ncreate table instruments (\\n \\"id\\" \\"uuid\\" primary key default \\"extensions\\".\\"uuid_generate_v4\\"() not null,\\n \\"name\\" text,\\n \\"section_id\\" \\"uuid\\" references public.orchestral_sections on delete cascade\\n);\\n\\nwith section as (\\n insert into orchestral_sections (name)\\n values ('woodwinds') returning id\\n)\\ninsert into instruments (name, section_id) values\\n('flute', (select id from section)),\\n('clarinet', (select id from section)),\\n('bassoon', (select id from section)),\\n('piccolo', (select id from section));\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"flute\\",\\n \\"orchestral_sections\\": {\\"name\\": \\"woodwinds\\"}\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "switching-schemas-per-query", - "name": "Switching schemas per query", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .schema('myschema')\\n .from('mytable')\\n .select()\\n\`\`\`", - "description": "In addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas).", - "data": { - "sql": "\`\`\`sql\\ncreate schema myschema;\\n\\ncreate table myschema.mytable (\\n id uuid primary key default gen_random_uuid(),\\n data text\\n);\\n\\ninsert into myschema.mytable (data) values ('mydata');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": \\"4162e008-27b0-4c0f-82dc-ccaeee9a624d\\",\\n \\"data\\": \\"mydata\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestQueryBuilder.update": { - "name": "@supabase/postgrest-js.PostgrestQueryBuilder.update", - "params": [ - { - "name": "values", - "type": { - "type": "nameOnly", - "name": "RejectExcessProperties" - }, - "comment": { - "shortText": "The values to update with" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - null, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count updated rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform an UPDATE on the table or view.\\n\\nBy default, updated rows are not returned. To return it, chain the call\\nwith \`.select()\` after filters.", - "text": "- \`update()\` should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update.", - "examples": [ - { - "id": "updating-your-data", - "name": "Updating your data", - "code": "\`\`\`ts\\nconst { error } = await supabase\\n .from('instruments')\\n .update({ name: 'piano' })\\n .eq('id', 1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n instruments (id int8 primary key, name text);\\n\\ninsert into\\n instruments (id, name)\\nvalues\\n (1, 'harpsichord');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 204,\\n \\"statusText\\": \\"No Content\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\\nif (error) console.error(error)\\n\`\`\`", - "description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`." - }, - { - "id": "update-a-record-and-return-it", - "name": "Update a record and return it", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .update({ name: 'piano' })\\n .eq('id', 1)\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n instruments (id int8 primary key, name text);\\n\\ninsert into\\n instruments (id, name)\\nvalues\\n (1, 'harpsichord');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"piano\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "updating-json-data", - "name": "Updating JSON data", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .update({\\n address: {\\n street: 'Melrose Place',\\n postcode: 90210\\n }\\n })\\n .eq('address->postcode', 90210)\\n .select()\\n\`\`\`", - "description": "Postgres offers some\\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\\nworking with JSON data. Currently, it is only possible to update the entire JSON document.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 primary key,\\n name text,\\n address jsonb\\n );\\n\\ninsert into\\n users (id, name, address)\\nvalues\\n (1, 'Michael', '{ \\"postcode\\": 90210 }');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Michael\\",\\n \\"address\\": {\\n \\"street\\": \\"Melrose Place\\",\\n \\"postcode\\": 90210\\n }\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestQueryBuilder.upsert": { - "name": "@supabase/postgrest-js.PostgrestQueryBuilder.upsert", - "params": [ - { - "name": "values", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RejectExcessProperties" - }, - { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "RejectExcessProperties" - } - } - ] - }, - "comment": { - "shortText": "The values to upsert with. Pass an object to upsert a\\nsingle row or an array to upsert multiple rows." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - null, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Count algorithm to use to count upserted rows.\\n\\n\`\\"exact\\"\`: Exact but slow count algorithm. Performs a \`COUNT(*)\` under the\\nhood.\\n\\n\`\\"planned\\"\`: Approximated but fast count algorithm. Uses the Postgres\\nstatistics under the hood.\\n\\n\`\\"estimated\\"\`: Uses exact count for low numbers and planned count for high\\nnumbers." - } - }, - { - "name": "defaultToNull", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Make missing fields default to \`null\`.\\nOtherwise, use the default value for the column. This only applies when\\ninserting new rows, not when merging with existing rows under\\n\`ignoreDuplicates: false\`. This also only applies when doing bulk upserts." - } - }, - { - "name": "ignoreDuplicates", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, duplicate rows are ignored. If\\n\`false\`, duplicate rows are merged with existing rows." - } - }, - { - "name": "onConflict", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Comma-separated UNIQUE column(s) to specify how\\nduplicate rows are determined. Two rows are duplicates if all the\\n\`onConflict\` columns are equal." - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\\nto \`onConflict\`, \`.upsert()\` allows you to perform the equivalent of\\n\`.insert()\` if a row with the corresponding \`onConflict\` columns doesn't\\nexist, or if it does exist, perform an alternative action depending on\\n\`ignoreDuplicates\`.\\n\\nBy default, upserted rows are not returned. To return it, chain the call\\nwith \`.select()\`.", - "text": "- Primary keys must be included in \`values\` to use upsert.", - "examples": [ - { - "id": "upsert-a-single-row-using-a-unique-key", - "name": "Upsert a single row using a unique key", - "code": "\`\`\`ts\\n// Upserting a single row, overwriting based on the 'username' unique column\\nconst { data, error } = await supabase\\n .from('users')\\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\\n\\n// Example response:\\n// {\\n// data: [\\n// { id: 4, message: 'bar', username: 'supabot' }\\n// ],\\n// error: null\\n// }\\n\`\`\`" - }, - { - "id": "upsert-with-conflict-resolution-and-exact-row-counting", - "name": "Upsert with conflict resolution and exact row counting", - "code": "\`\`\`ts\\n// Upserting and returning exact count\\nconst { data, error, count } = await supabase\\n .from('users')\\n .upsert(\\n {\\n id: 3,\\n message: 'foo',\\n username: 'supabot'\\n },\\n {\\n onConflict: 'username',\\n count: 'exact'\\n }\\n )\\n\\n// Example response:\\n// {\\n// data: [\\n// {\\n// id: 42,\\n// handle: \\"saoirse\\",\\n// display_name: \\"Saoirse\\"\\n// }\\n// ],\\n// count: 1,\\n// error: null\\n// }\\n\`\`\`" - }, - { - "id": "upsert-your-data", - "name": "Upsert your data", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .upsert({ id: 1, name: 'piano' })\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n instruments (id int8 primary key, name text);\\n\\ninsert into\\n instruments (id, name)\\nvalues\\n (1, 'harpsichord');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"piano\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\\nif (error) console.error(error)\\n\`\`\`", - "description": "\`error.hint\` from Postgres often contains the actionable fix (e.g. \`\\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\\"\` for a \`42501\` permission-denied error). Log the full \`error\` object so it isn't hidden behind \`error.message\`." - }, - { - "id": "bulk-upsert-your-data", - "name": "Bulk Upsert your data", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('instruments')\\n .upsert([\\n { id: 1, name: 'piano' },\\n { id: 2, name: 'harp' },\\n ])\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n instruments (id int8 primary key, name text);\\n\\ninsert into\\n instruments (id, name)\\nvalues\\n (1, 'harpsichord');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"piano\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"harp\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - }, - { - "id": "upserting-into-tables-with-constraints", - "name": "Upserting into tables with constraints", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('users')\\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\\n .select()\\n\`\`\`", - "description": "In the following query, \`upsert()\` implicitly uses the \`id\`\\n(primary key) column to determine conflicts. If there is no existing\\nrow with the same \`id\`, \`upsert()\` inserts a new row, which\\nwill fail in this case as there is already a row with \`handle\` \`\\"saoirse\\"\`.\\nUsing the \`onConflict\` option, you can instruct \`upsert()\` to use\\nanother column with a unique constraint to determine conflicts.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n users (\\n id int8 generated by default as identity primary key,\\n handle text not null unique,\\n display_name text\\n );\\n\\ninsert into\\n users (id, handle, display_name)\\nvalues\\n (1, 'saoirse', null);\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"error\\": {\\n \\"code\\": \\"23505\\",\\n \\"details\\": \\"Key (handle)=(saoirse) already exists.\\",\\n \\"hint\\": null,\\n \\"message\\": \\"duplicate key value violates unique constraint \\\\\\"users_handle_key\\\\\\"\\"\\n },\\n \\"status\\": 409,\\n \\"statusText\\": \\"Conflict\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.constructor": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.constructor", - "params": [ - { - "name": "builder", - "type": { - "type": "object", - "properties": [ - { - "name": "body", - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "URL" - }, - { - "type": "nameOnly", - "name": "RequestInfo" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "nameOnly", - "name": "HeadersInit" - } - }, - { - "name": "isMaybeSingle", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "method", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "name": "retry", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "shouldStripNulls", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "shouldThrowOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true - }, - { - "name": "url", - "type": { - "type": "nameOnly", - "name": "URL" - } - }, - { - "name": "urlLengthLimit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestTransformBuilder" - } - }, - "comment": { - "shortText": "Creates a builder configured for a specific PostgREST request.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.from('users').select('*')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\\n\\nconst builder = new PostgrestQueryBuilder(\\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\\n)\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.abortSignal": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.abortSignal", - "params": [ - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "comment": { - "shortText": "The AbortSignal to use for the fetch request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set the AbortSignal for the fetch request.", - "text": "You can use this to set a timeout for the request.", - "examples": [ - { - "id": "aborting-requests-in-flight", - "name": "Aborting requests in-flight", - "code": "\`\`\`ts\\nconst ac = new AbortController()\\n\\nconst { data, error } = await supabase\\n .from('very_big_table')\\n .select()\\n .abortSignal(ac.signal)\\n\\n// Abort the request after 100 ms\\nsetTimeout(() => ac.abort(), 100)\\n\`\`\`", - "description": "You can use an [\`AbortController\`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\\nNote that \`status\` and \`statusText\` don't mean anything for aborted requests as the request wasn't fulfilled.", - "response": "\`\`\`json\\n {\\n \\"error\\": {\\n \\"message\\": \\"AbortError: The user aborted a request.\\",\\n \\"details\\": \\"\\",\\n \\"hint\\": \\"The request was aborted locally via the provided AbortSignal.\\",\\n \\"code\\": \\"\\"\\n },\\n \\"status\\": 0,\\n \\"statusText\\": \\"\\"\\n }\\n\\n\`\`\`" - }, - { - "id": "set-a-timeout", - "name": "Set a timeout", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('very_big_table')\\n .select()\\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\\n\`\`\`", - "response": "\`\`\`json\\n {\\n \\"error\\": {\\n \\"message\\": \\"FetchError: The user aborted a request.\\",\\n \\"details\\": \\"\\",\\n \\"hint\\": \\"\\",\\n \\"code\\": \\"\\"\\n },\\n \\"status\\": 400,\\n \\"statusText\\": \\"Bad Request\\"\\n }\\n\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.csv": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.csv", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a string in CSV format.", - "examples": [ - { - "id": "return-data-as-csv", - "name": "Return data as CSV", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .csv()\\n\`\`\`", - "description": "By default, the data is returned in JSON format, but can also be returned as Comma Separated Values.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": \\"id,name\\\\n1,Luke\\\\n2,Leia\\\\n3,Han\\",\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.explain": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.explain", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "analyze", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, the query will be executed and the\\nactual run time will be returned" - } - }, - { - "name": "buffers", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on buffer usage" - } - }, - { - "name": "format", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The format of the output, can be \`\\"text\\"\` (default)\\nor \`\\"json\\"\`" - } - }, - { - "name": "settings", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on configuration\\nparameters that affect query planning" - } - }, - { - "name": "verbose", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, the query identifier will be returned\\nand \`data\` will include the output columns of the query" - } - }, - { - "name": "wal", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "If \`true\`, include information on WAL record generation" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "PostgrestBuilder" - }, - { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - ] - } - }, - "comment": { - "shortText": "Return \`data\` as the EXPLAIN plan for the query.\\n\\nYou need to enable the\\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\\nsetting before using this method.", - "examples": [ - { - "id": "get-the-execution-plan", - "name": "Get the execution plan", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .explain()\\n\`\`\`", - "description": "By default, the data is returned in TEXT format, but can also be returned as JSON by using the \`format\` parameter.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`js\\nAggregate (cost=33.34..33.36 rows=1 width=112)\\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\\n\`\`\`" - }, - { - "id": "get-the-execution-plan-with-analyze-and-verbose", - "name": "Get the execution plan with analyze and verbose", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .explain({analyze:true,verbose:true})\\n\`\`\`", - "description": "By default, the data is returned in TEXT format, but can also be returned as JSON by using the \`format\` parameter.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`js\\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\\n Output: characters.id, characters.name\\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\\n Output: characters.id, characters.name\\nQuery Identifier: -4730654291623321173\\nPlanning Time: 0.407 ms\\nExecution Time: 0.119 ms\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.geojson": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.geojson", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as an object in [GeoJSON](https://geojson.org) format." - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.limit": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.limit", - "params": [ - { - "name": "count", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The maximum number of rows to return" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to limit rows of referenced\\ntables instead of the parent table" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Limit the query result by \`count\`.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .limit(1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-a-referenced-table", - "name": "On a referenced table", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments (\\n name\\n )\\n \`)\\n .limit(1, { referencedTable: 'instruments' })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 1, 'harp'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n }\\n ]\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.maxAffected": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.maxAffected", - "params": [ - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The maximum number of rows that can be affected" - } - } - ], - "comment": { - "shortText": "Set the maximum number of rows that can be affected by the query.\\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.maybeSingle": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.maybeSingle", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be zero or one row (e.g. using \`.limit(1)\`), otherwise\\nthis returns an error.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .eq('name', 'Katniss')\\n .maybeSingle()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.order": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.order", - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Order the query result by \`column\`.\\n\\nYou 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.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('id, name')\\n .order('id', { ascending: false })\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 3,\\n \\"name\\": \\"Han\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\"\\n },\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "on-a-referenced-table", - "name": "On a referenced table", - "code": "\`\`\`ts\\n const { data, error } = await supabase\\n .from('orchestral_sections')\\n .select(\`\\n name,\\n instruments (\\n name\\n )\\n \`)\\n .order('name', { referencedTable: 'instruments', ascending: false })\\n\\n\`\`\`", - "description": "Ordering with \`referencedTable\` doesn't affect the ordering of the\\nparent table.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 1, 'harp'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"strings\\",\\n \\"instruments\\": [\\n {\\n \\"name\\": \\"violin\\"\\n },\\n {\\n \\"name\\": \\"harp\\"\\n }\\n ]\\n },\\n {\\n \\"name\\": \\"woodwinds\\",\\n \\"instruments\\": []\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - }, - { - "id": "order-parent-table-by-a-referenced-table", - "name": "Order parent table by a referenced table", - "code": "\`\`\`ts\\n const { data, error } = await supabase\\n .from('instruments')\\n .select(\`\\n name,\\n section:orchestral_sections (\\n name\\n )\\n \`)\\n .order('section(name)', { ascending: true })\\n\\n\`\`\`", - "description": "Ordering with \`referenced_table(col)\` affects the ordering of the\\nparent table.", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n orchestral_sections (id int8 primary key, name text);\\ncreate table\\n instruments (\\n id int8 primary key,\\n section_id int8 not null references orchestral_sections,\\n name text\\n );\\n\\ninsert into\\n orchestral_sections (id, name)\\nvalues\\n (1, 'strings'),\\n (2, 'woodwinds');\\ninsert into\\n instruments (id, section_id, name)\\nvalues\\n (1, 2, 'flute'),\\n (2, 1, 'violin');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"violin\\",\\n \\"orchestral_sections\\": {\\"name\\": \\"strings\\"}\\n },\\n {\\n \\"name\\": \\"flute\\",\\n \\"orchestral_sections\\": {\\"name\\": \\"woodwinds\\"}\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "nameOnly", - "name": "ColumnName" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "" - } - }, - { - "params": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "ascending", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "nullsFirst", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "" - } - } - ] - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.overrideTypes": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.overrideTypes", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\` field in the response.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`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\`\`\`" - }, - { - "id": "complete-override-type-of-successful-response", - "name": "Complete Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes, { merge: false }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "complete-override-type-of-object-response", - "name": "Complete Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // MyType | null\\n\`\`\`" - }, - { - "id": "partial-override-type-of-successful-response", - "name": "Partial Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .overrideTypes>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // Array\\n\`\`\`" - }, - { - "id": "partial-override-type-of-object-response", - "name": "Partial Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .overrideTypes<{ status: \\"A\\" | \\"B\\" }>()\\n\`\`\`", - "response": "\`\`\`ts\\nlet x: typeof data // CountryRowProperties & { status: \\"A\\" | \\"B\\" } | null\\n\`\`\`" - }, - { - "id": "merge-vs-replace-existing-types", - "name": "Merge vs replace existing types", - "code": "\`\`\`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": [ - { - "name": "from", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The starting index from which to limit the result" - } - }, - { - "name": "to", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The last index to which to limit the result" - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "foreignTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Deprecated, use \`options.referencedTable\`\\ninstead" - } - }, - { - "name": "referencedTable", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Set this to limit rows of referenced\\ntables instead of the parent table" - } - } - ] - }, - "comment": { - "shortText": "Named parameters" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "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.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .range(0, 1)\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"name\\": \\"Leia\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.retry": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.retry", - "params": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "Whether to enable retries for this request" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\n// Disable retries for a specific query\\nconst { data, error } = await supabase\\n .from('users')\\n .select()\\n .retry(false)\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.returns": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.returns", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestTransformBuilder" - } - }, - "comment": { - "shortText": "Override the type of the returned \`data\`.", - "text": "- Deprecated: use overrideTypes method instead", - "examples": [ - { - "id": "override-type-of-successful-response", - "name": "Override type of successful response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .returns>()\\n\`\`\`", - "response": "\`\`\`js\\nlet x: typeof data // MyType[]\\n\`\`\`" - }, - { - "id": "override-type-of-object-response", - "name": "Override type of object response", - "code": "\`\`\`ts\\nconst { data } = await supabase\\n .from('countries')\\n .select()\\n .maybeSingle()\\n .returns()\\n\`\`\`", - "response": "\`\`\`js\\nlet x: typeof data // MyType | null\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.rollback": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.rollback", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Rollback the query.\\n\\n\`data\` will still be returned, but the query is not committed." - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.select": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.select", - "params": [ - { - "name": "columns", - "type": { - "type": "nameOnly", - "name": "Query" - }, - "isOptional": true, - "comment": { - "shortText": "The columns to retrieve, separated by commas" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestFilterBuilder" - } - }, - "comment": { - "shortText": "Perform a SELECT on the query result.\\n\\nBy default, \`.insert()\`, \`.update()\`, \`.upsert()\`, and \`.delete()\` do not\\nreturn modified rows. By calling this method, modified rows are returned in\\n\`data\`.", - "examples": [ - { - "id": "with-upsert", - "name": "With \`upsert()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .upsert({ id: 1, name: 'Han Solo' })\\n .select()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Han Solo\\"\\n }\\n ],\\n \\"status\\": 201,\\n \\"statusText\\": \\"Created\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.setHeader": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request." - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.single": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.single", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "PostgrestBuilder" - } - }, - "comment": { - "shortText": "Return \`data\` as a single object instead of an array of objects.\\n\\nQuery result must be one row (e.g. using \`.limit(1)\`), otherwise this\\nreturns an error.", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select('name')\\n .limit(1)\\n .single()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text);\\n\\ninsert into\\n characters (id, name)\\nvalues\\n (1, 'Luke'),\\n (2, 'Leia'),\\n (3, 'Han');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"name\\": \\"Luke\\"\\n },\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.stripNulls": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.stripNulls", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Strip null values from the response data. Properties with \`null\` values\\nwill be omitted from the returned JSON objects.\\n\\nRequires PostgREST 11.2.0+.\\n\\nhttps://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "examples": [ - { - "id": "with-select", - "name": "With \`select()\`", - "code": "\`\`\`ts\\nconst { data, error } = await supabase\\n .from('characters')\\n .select()\\n .stripNulls()\\n\`\`\`", - "data": { - "sql": "\`\`\`sql\\ncreate table\\n characters (id int8 primary key, name text, bio text);\\n\\ninsert into\\n characters (id, name, bio)\\nvalues\\n (1, 'Luke', null),\\n (2, 'Leia', 'Princess of Alderaan');\\n\`\`\`" - }, - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"Luke\\"\\n },\\n {\\n \\"id\\": 2,\\n \\"name\\": \\"Leia\\",\\n \\"bio\\": \\"Princess of Alderaan\\"\\n }\\n ],\\n \\"status\\": 200,\\n \\"statusText\\": \\"OK\\"\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.then": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.then", - "params": [ - { - "name": "onfulfilled", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "value", - "type": { - "type": "union", - "name": "PostgrestSingleResponse", - "subTypes": [ - { - "type": "object", - "name": "PostgrestResponseSuccess", - "properties": [ - { - "name": "count", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "@supabase/postgrest-js.default.Result" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusText", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "success", - "type": { - "type": "literal", - "value": true - } - } - ] - }, - { - "type": "object", - "name": "PostgrestResponseFailure", - "properties": [ - { - "name": "count", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "PostgrestError" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusText", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "success", - "type": { - "type": "literal", - "value": false - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is resolved." - } - }, - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult2" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "PromiseLike" - } - }, - "comment": { - "shortText": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - }, - "@supabase/postgrest-js.PostgrestTransformBuilder.throwOnError": { - "name": "@supabase/postgrest-js.PostgrestTransformBuilder.throwOnError", - "params": [], - "comment": { - "shortText": "If there's an error with the query, throwOnError will reject the promise by\\nthrowing the error instead of returning it as part of a successful response.\\n\\nhttps://github.com/supabase/supabase-js/issues/92" - } - } - }, - "variables": {} - }, - { - "name": "@supabase/realtime-js", - "methods": { - "@supabase/realtime-js.RealtimeChannel.constructor": { - "name": "@supabase/realtime-js.RealtimeChannel.constructor", - "params": [ - { - "name": "topic", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Topic name can be any string." - } - }, - { - "name": "params", - "type": { - "name": "RealtimeChannelOptions", - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "object", - "properties": [ - { - "name": "broadcast", - "type": { - "type": "object", - "properties": [ - { - "name": "ack", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "replay", - "type": { - "type": "nameOnly", - "name": "ReplayOption" - }, - "isOptional": true - }, - { - "name": "self", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "self option enables client to receive message it broadcast\\nack option instructs server to acknowledge that broadcast message was received\\nreplay option instructs server to replay broadcast messages" - } - }, - { - "name": "presence", - "type": { - "type": "object", - "properties": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "key option is used to track presence payload across clients" - } - }, - { - "name": "private", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - } - } - ] - } - } - ] - } - }, - { - "name": "socket", - "type": { - "type": "nameOnly", - "name": "RealtimeClient" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\\n\\nThe topic determines which realtime stream you are subscribing to. Config options let you\\nenable acknowledgement for broadcasts, presence tracking, or private channels.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst channel = supabase.channel('room1')\\nchannel\\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\\n .subscribe()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport RealtimeClient from '@supabase/realtime-js'\\n\\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\\n params: { apikey: 'your-publishable-key' },\\n})\\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\\n\`\`\`" - } - ] - } - }, - "@supabase/realtime-js.RealtimePresence.constructor": { - "name": "@supabase/realtime-js.RealtimePresence.constructor", - "params": [ - { - "name": "channel", - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - }, - "comment": { - "shortText": "The realtime channel to bind to." - } - }, - { - "name": "opts", - "type": { - "type": "nameOnly", - "name": "RealtimePresenceOptions" - }, - "isOptional": true, - "comment": { - "shortText": "Optional custom event names, e.g. \`{ events: { state: 'state', diff: 'diff' } }\`." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimePresence" - } - }, - "comment": { - "shortText": "Creates a Presence helper that keeps the local presence state in sync with the server.", - "examples": [ - { - "id": "example-for-a-presence-channel", - "name": "Example for a presence channel", - "code": "\`\`\`ts\\nconst presence = new RealtimePresence(channel)\\n\\nchannel.on('presence', ({ event, key }) => {\\n console.log(\`Presence \${event} on \${key}\`)\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/realtime-js.RealtimeClient.constructor": { - "name": "@supabase/realtime-js.RealtimeClient.constructor", - "params": [ - { - "name": "endPoint", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The string WebSocket endpoint, ie, \\"ws://example.com/socket\\", \\"wss://example.com\\", \\"/socket\\" (inherited host & protocol)" - } - }, - { - "name": "options", - "type": { - "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": { - "type": "nameOnly", - "name": "Decode" - }, - "isOptional": true - }, - { - "name": "disconnectOnEmptyChannelsAfterMs", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "encode", - "type": { - "type": "nameOnly", - "name": "Encode" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "nameOnly", - "name": "Fetch" - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "heartbeatCallback", - "type": { - "type": "function", - "params": [ - { - "name": "status", - "type": { - "type": "nameOnly", - "name": "HeartbeatStatus" - } - }, - { - "name": "latency", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "isOptional": true - }, - { - "name": "heartbeatIntervalMs", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "log_level", - "type": { - "type": "nameOnly", - "name": "LogLevel" - }, - "isOptional": true - }, - { - "name": "logger", - "type": { - "type": "function", - "params": [ - { - "name": "kind", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "msg", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "isOptional": true - }, - { - "name": "logLevel", - "type": { - "type": "nameOnly", - "name": "LogLevel" - }, - "isOptional": true - }, - { - "name": "params", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true - }, - { - "name": "reconnectAfterMs", - "type": { - "type": "function", - "params": [ - { - "name": "tries", - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - "isOptional": true - }, - { - "name": "sessionStorage", - "type": { - "type": "nameOnly", - "name": "Storage" - }, - "isOptional": true, - "comment": { - "shortText": "Storage compatible object used by the underlying socket for longpoll fallback history.\\nProvide a custom implementation in environments where reading \`globalThis.sessionStorage\`\\nthrows (sandboxed iframes, in-app webviews, \\"block third-party storage\\" privacy modes).\\nDefaults to \`globalThis.sessionStorage\` when accessible, otherwise an in-memory store." - } - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "transport", - "type": { - "type": "object", - "name": "WebSocketLikeConstructor", - "properties": [] - }, - "isOptional": true - }, - { - "name": "vsn", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "worker", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "workerUrl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeClient" - } - }, - "comment": { - "shortText": "Initializes the Socket.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst channel = supabase.channel('room1')\\nchannel\\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\\n .subscribe()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport RealtimeClient from '@supabase/realtime-js'\\n\\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\\n params: { apikey: 'your-publishable-key' },\\n})\\nclient.connect()\\n\`\`\`" - } - ] - } - }, - "@supabase/realtime-js.RealtimeClient.channel": { - "name": "@supabase/realtime-js.RealtimeClient.channel", - "params": [ - { - "name": "topic", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "params", - "type": { - "name": "RealtimeChannelOptions", - "type": "object", - "properties": [ - { - "name": "config", - "type": { - "type": "object", - "properties": [ - { - "name": "broadcast", - "type": { - "type": "object", - "properties": [ - { - "name": "ack", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "replay", - "type": { - "type": "nameOnly", - "name": "ReplayOption" - }, - "isOptional": true - }, - { - "name": "self", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "self option enables client to receive message it broadcast\\nack option instructs server to acknowledge that broadcast message was received\\nreplay option instructs server to replay broadcast messages" - } - }, - { - "name": "presence", - "type": { - "type": "object", - "properties": [ - { - "name": "enabled", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "key option is used to track presence payload across clients" - } - }, - { - "name": "private", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "defines if the channel is private or not and if RLS policies will be used to check data" - } - } - ] - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates (or reuses) a RealtimeChannel for the provided topic.\\n\\nTopics are automatically prefixed with \`realtime:\` to match the Realtime service.\\nIf a channel with the same topic already exists it will be returned instead of creating\\na duplicate connection." - } - }, - "@supabase/realtime-js.RealtimeClient.connect": { - "name": "@supabase/realtime-js.RealtimeClient.connect", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Connects the socket, unless already connected." - } - }, - "@supabase/realtime-js.RealtimeClient.connectionState": { - "name": "@supabase/realtime-js.RealtimeClient.connectionState", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "ConnectionState" - } - }, - "comment": { - "shortText": "Returns the current state of the socket." - } - }, - "@supabase/realtime-js.RealtimeClient.disconnect": { - "name": "@supabase/realtime-js.RealtimeClient.disconnect", - "params": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "A numeric status code to send on disconnect." - } - }, - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "A custom reason for the disconnect." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timeout" - } - ] - } - } - }, - "comment": { - "shortText": "Disconnects the socket." - } - }, - "@supabase/realtime-js.RealtimeClient.endpointURL": { - "name": "@supabase/realtime-js.RealtimeClient.endpointURL", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "Returns the URL of the websocket." - } - }, - "@supabase/realtime-js.RealtimeClient.getChannels": { - "name": "@supabase/realtime-js.RealtimeClient.getChannels", - "params": [], - "ret": { - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - } - }, - "comment": { - "shortText": "Returns all created channels" - } - }, - "@supabase/realtime-js.RealtimeClient.isConnected": { - "name": "@supabase/realtime-js.RealtimeClient.isConnected", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Returns \`true\` is the connection is open." - } - }, - "@supabase/realtime-js.RealtimeClient.isConnecting": { - "name": "@supabase/realtime-js.RealtimeClient.isConnecting", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Returns \`true\` if the connection is currently connecting." - } - }, - "@supabase/realtime-js.RealtimeClient.isDisconnecting": { - "name": "@supabase/realtime-js.RealtimeClient.isDisconnecting", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Returns \`true\` if the connection is currently disconnecting." - } - }, - "@supabase/realtime-js.RealtimeClient.log": { - "name": "@supabase/realtime-js.RealtimeClient.log", - "params": [ - { - "name": "kind", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "msg", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Logs the message.\\n\\nFor customized logging, \`this.logger\` can be overridden in Client constructor." - } - }, - "@supabase/realtime-js.RealtimeClient.onHeartbeat": { - "name": "@supabase/realtime-js.RealtimeClient.onHeartbeat", - "params": [ - { - "name": "callback", - "type": { - "type": "nameOnly", - "name": "HeartbeatCallback" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Sets a callback that receives lifecycle events for internal heartbeat messages.\\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)." - } - }, - "@supabase/realtime-js.RealtimeClient.push": { - "name": "@supabase/realtime-js.RealtimeClient.push", - "params": [ - { - "name": "data", - "type": { - "name": "RealtimeMessage", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "join_ref", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "payload", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ref", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "topic", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "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": { - "name": "@supabase/realtime-js.RealtimeClient.removeAllChannels", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "array", - "elemType": { - "type": "union", - "name": "RealtimeRemoveChannelResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - } - }, - "comment": { - "shortText": "Unsubscribes, removes and tears down all channels" - } - }, - "@supabase/realtime-js.RealtimeClient.removeChannel": { - "name": "@supabase/realtime-js.RealtimeClient.removeChannel", - "params": [ - { - "name": "channel", - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - }, - "comment": { - "shortText": "A RealtimeChannel instance" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeRemoveChannelResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Unsubscribes, removes and tears down a single channel" - } - }, - "@supabase/realtime-js.RealtimeClient.sendHeartbeat": { - "name": "@supabase/realtime-js.RealtimeClient.sendHeartbeat", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "shortText": "Sends a heartbeat message if the socket is connected." - } - }, - "@supabase/realtime-js.RealtimeClient.setAuth": { - "name": "@supabase/realtime-js.RealtimeClient.setAuth", - "params": [ - { - "name": "token", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "A JWT string to override the token set on the client." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "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.\\n\\nWhen a token is explicitly provided, it will be preserved across channel operations\\n(including removeChannel and resubscribe). The \`accessToken\` callback will not be\\ninvoked until \`setAuth()\` is called without arguments.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\nSetting the authorization header\\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\\nclient.realtime.setAuth('my-custom-jwt')\\n\\n// Switch back to using the accessToken callback\\nclient.realtime.setAuth()\\n\`\`\`" - } - ] - } - }, - "@supabase/realtime-js.RealtimeChannel.copyBindings": { - "name": "@supabase/realtime-js.RealtimeChannel.copyBindings", - "params": [ - { - "name": "other", - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "@supabase/realtime-js.RealtimeChannel.httpSend": { - "name": "@supabase/realtime-js.RealtimeChannel.httpSend", - "params": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The name of the broadcast event" - } - }, - { - "name": "payload", - "type": { - "type": "intrinsic", - "name": "any" - }, - "comment": { - "shortText": "Payload to be sent (required)" - } - }, - { - "name": "opts", - "type": { - "type": "object", - "properties": [ - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - } - ] - }, - "comment": { - "shortText": "Options including timeout" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "success", - "type": { - "type": "literal", - "value": true - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "error", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "success", - "type": { - "type": "literal", - "value": false - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Sends a broadcast message explicitly via REST API.\\n\\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\\n\\nPayloads that are \`ArrayBuffer\` or \`ArrayBufferView\` (e.g. \`Uint8Array\`) are sent as\\n\`application/octet-stream\`; all other payloads are JSON-encoded." - } - }, - "@supabase/realtime-js.RealtimeChannel.on": { - "name": "@supabase/realtime-js.RealtimeChannel.on", - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "sync" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes.", - "text": "- By default, Broadcast and Presence are enabled for all projects.\\n- By default, listening to database changes is disabled for new projects due to database performance and security concerns. You can turn it on by managing Realtime's [replication](/docs/guides/api#realtime-api-overview).\\n- You can receive the \\"previous\\" data for updates and deletes by setting the table's \`REPLICA IDENTITY\` to \`FULL\` (e.g., \`ALTER TABLE your_table REPLICA IDENTITY FULL;\`).\\n- Row level security is not applied to delete statements. When RLS is enabled and replica identity is set to full, only the primary key is sent to clients.", - "examples": [ - { - "id": "listen-to-broadcast-messages", - "name": "Listen to broadcast messages", - "code": "\`\`\`js\\nconst channel = supabase.channel(\\"room1\\")\\n\\nchannel.on(\\"broadcast\\", { event: \\"cursor-pos\\" }, (payload) => {\\n console.log(\\"Cursor position received!\\", payload);\\n}).subscribe((status) => {\\n if (status === \\"SUBSCRIBED\\") {\\n channel.send({\\n type: \\"broadcast\\",\\n event: \\"cursor-pos\\",\\n payload: { x: Math.random(), y: Math.random() },\\n });\\n }\\n});\\n\`\`\`" - }, - { - "id": "listen-to-presence-sync", - "name": "Listen to presence sync", - "code": "\`\`\`js\\nconst channel = supabase.channel('room1')\\nchannel\\n .on('presence', { event: 'sync' }, () => {\\n console.log('Synced presence state: ', channel.presenceState())\\n })\\n .subscribe(async (status) => {\\n if (status === 'SUBSCRIBED') {\\n await channel.track({ online_at: new Date().toISOString() })\\n }\\n })\\n\`\`\`" - }, - { - "id": "listen-to-presence-join", - "name": "Listen to presence join", - "code": "\`\`\`js\\nconst channel = supabase.channel('room1')\\nchannel\\n .on('presence', { event: 'join' }, ({ newPresences }) => {\\n console.log('Newly joined presences: ', newPresences)\\n })\\n .subscribe(async (status) => {\\n if (status === 'SUBSCRIBED') {\\n await channel.track({ online_at: new Date().toISOString() })\\n }\\n })\\n\`\`\`" - }, - { - "id": "listen-to-presence-leave", - "name": "Listen to presence leave", - "code": "\`\`\`js\\nconst channel = supabase.channel('room1')\\nchannel\\n .on('presence', { event: 'leave' }, ({ leftPresences }) => {\\n console.log('Newly left presences: ', leftPresences)\\n })\\n .subscribe(async (status) => {\\n if (status === 'SUBSCRIBED') {\\n await channel.track({ online_at: new Date().toISOString() })\\n await channel.untrack()\\n }\\n })\\n\`\`\`" - }, - { - "id": "listen-to-all-database-changes", - "name": "Listen to all database changes", - "code": "\`\`\`js\\nsupabase\\n .channel('room1')\\n .on('postgres_changes', { event: '*', schema: '*' }, payload => {\\n console.log('Change received!', payload)\\n })\\n .subscribe()\\n\`\`\`" - }, - { - "id": "listen-to-a-specific-table", - "name": "Listen to a specific table", - "code": "\`\`\`js\\nsupabase\\n .channel('room1')\\n .on('postgres_changes', { event: '*', schema: 'public', table: 'countries' }, payload => {\\n console.log('Change received!', payload)\\n })\\n .subscribe()\\n\`\`\`" - }, - { - "id": "listen-to-inserts", - "name": "Listen to inserts", - "code": "\`\`\`js\\nsupabase\\n .channel('room1')\\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, payload => {\\n console.log('Change received!', payload)\\n })\\n .subscribe()\\n\`\`\`" - }, - { - "id": "listen-to-updates", - "name": "Listen to updates", - "code": "\`\`\`js\\nsupabase\\n .channel('room1')\\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries' }, payload => {\\n console.log('Change received!', payload)\\n })\\n .subscribe()\\n\`\`\`", - "description": "By default, Supabase will send only the updated record. If you want to receive the previous values as well you can\\nenable full replication for the table you are listening to:\\n\\n\`\`\`sql\\nalter table \\"your_table\\" replica identity full;\\n\`\`\`" - }, - { - "id": "listen-to-deletes", - "name": "Listen to deletes", - "code": "\`\`\`js\\nsupabase\\n .channel('room1')\\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, payload => {\\n console.log('Change received!', payload)\\n })\\n .subscribe()\\n\`\`\`", - "description": "By default, Supabase does not send deleted records. If you want to receive the deleted record you can\\nenable full replication for the table you are listening to:\\n\\n\`\`\`sql\\nalter table \\"your_table\\" replica identity full;\\n\`\`\`" - }, - { - "id": "listen-to-multiple-events", - "name": "Listen to multiple events", - "code": "\`\`\`js\\nsupabase\\n .channel('room1')\\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, handleRecordInserted)\\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, handleRecordDeleted)\\n .subscribe()\\n\`\`\`", - "description": "You can chain listeners if you want to listen to multiple events for each table." - }, - { - "id": "listen-to-row-level-changes", - "name": "Listen to row level changes", - "code": "\`\`\`js\\nsupabase\\n .channel('room1')\\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries', filter: 'id=eq.200' }, handleRecordUpdated)\\n .subscribe()\\n\`\`\`", - "description": "You can listen to individual rows using the format \`{table}:{col}=eq.{val}\` - where \`{col}\` is the column name, and \`{val}\` is the value which you want to match." - } - ] - }, - "altSignatures": [ - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "join" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "name": "RealtimePresenceJoinPayload", - "type": "object", - "properties": [ - { - "name": "currentPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - }, - { - "name": "event" - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "newPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "leave" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "name": "RealtimePresenceLeavePayload", - "type": "object", - "properties": [ - { - "name": "currentPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - }, - { - "name": "event" - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "leftPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "*" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "union", - "subTypes": [ - { - "name": "RealtimePresenceJoinPayload", - "type": "object", - "properties": [ - { - "name": "currentPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - }, - { - "name": "event" - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "newPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - ] - }, - { - "name": "RealtimePresenceLeavePayload", - "type": "object", - "properties": [ - { - "name": "currentPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - }, - { - "name": "event" - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "leftPresences", - "type": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - ] - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "*" - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "union", - "name": "RealtimePostgresChangesPayload", - "subTypes": [ - { - "type": "nameOnly", - "name": "RealtimePostgresInsertPayload" - }, - { - "type": "nameOnly", - "name": "RealtimePostgresUpdatePayload" - }, - { - "type": "nameOnly", - "name": "RealtimePostgresDeletePayload" - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "INSERT" - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimePostgresInsertPayload" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "UPDATE" - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "DELETE" - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimePostgresDeletePayload" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "name": "filter", - "type": { - "name": "RealtimePostgresChangesFilter", - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "INSERT" - }, - { - "type": "literal", - "value": "UPDATE" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "*" - } - ] - }, - "comment": { - "shortText": "The type of database change to listen to." - } - }, - { - "name": "filter", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Receive database changes when filter is matched." - } - }, - { - "name": "schema", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The database schema to listen to." - } - }, - { - "name": "table", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The database table to listen to." - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "union", - "name": "RealtimePostgresChangesPayload", - "subTypes": [ - { - "type": "nameOnly", - "name": "RealtimePostgresInsertPayload" - }, - { - "type": "nameOnly", - "name": "RealtimePostgresUpdatePayload" - }, - { - "type": "nameOnly", - "name": "RealtimePostgresDeletePayload" - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - }, - "comment": { - "shortText": "One of \\"broadcast\\", \\"presence\\", or \\"postgres_changes\\"." - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "comment": { - "shortText": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "meta", - "type": { - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "replayed", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "comment": { - "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." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "meta", - "type": { - "type": "object", - "properties": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "replayed", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "T" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "*", - "name": "ALL" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "*", - "name": "ALL" - } - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimeBroadcastPayload" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "INSERT", - "name": "INSERT" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "INSERT", - "name": "INSERT" - } - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimeBroadcastInsertPayload" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "UPDATE", - "name": "UPDATE" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "UPDATE", - "name": "UPDATE" - } - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimeBroadcastUpdatePayload" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "name": "filter", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "DELETE", - "name": "DELETE" - } - } - ] - } - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "literal", - "value": "DELETE", - "name": "DELETE" - } - }, - { - "name": "payload", - "type": { - "type": "nameOnly", - "name": "RealtimeBroadcastDeletePayload" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "broadcast" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - }, - { - "params": [ - { - "name": "type", - "type": { - "type": "literal", - "value": "system" - } - }, - { - "name": "filter" - }, - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "payload", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Creates an event handler that listens to changes." - } - } - ] - }, - "@supabase/realtime-js.RealtimeChannel.presenceState": { - "name": "@supabase/realtime-js.RealtimeChannel.presenceState", - "params": [], - "ret": { - "type": { - "name": "RealtimePresenceState", - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "array", - "elemType": { - "type": "nameOnly", - "name": "Presence" - } - } - } - }, - "comment": { - "shortText": "Returns the current presence state for this channel.\\n\\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\\ntracked metadata for that user." - } - }, - "@supabase/realtime-js.RealtimeChannel.send": { - "name": "@supabase/realtime-js.RealtimeChannel.send", - "params": [ - { - "name": "args", - "type": { - "type": "object", - "properties": [ - { - "name": "event", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The name of the event being sent" - } - }, - { - "name": "payload", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true, - "comment": { - "shortText": "Payload to be sent" - } - }, - { - "name": "type", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - }, - "comment": { - "shortText": "The type of event to send" - } - } - ] - }, - "comment": { - "shortText": "Arguments to send to channel" - } - }, - { - "name": "opts", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "comment": { - "shortText": "Options to be used during the send process" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeChannelSendResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Sends a message into the channel.", - "text": "- When using REST you don't need to subscribe to the channel\\n- REST calls are only available from 2.37.0 onwards\\n- If you create a channel only to send a REST broadcast, remove it from\\n the client when the send completes", - "examples": [ - { - "id": "send-a-message-via-websocket", - "name": "Send a message via websocket", - "code": "\`\`\`js\\nconst channel = supabase.channel('room1')\\n\\nchannel.subscribe((status) => {\\n if (status === 'SUBSCRIBED') {\\n channel.send({\\n type: 'broadcast',\\n event: 'cursor-pos',\\n payload: { x: Math.random(), y: Math.random() },\\n })\\n }\\n})\\n\`\`\`", - "response": "\`\`\`js\\nok | timed out | error\\n\`\`\`" - }, - { - "id": "send-a-message-via-rest", - "name": "Send a message via REST", - "code": "\`\`\`js\\nconst channel = supabase.channel('room1')\\n\\ntry {\\n await channel.httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\\n} finally {\\n await supabase.removeChannel(channel)\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/realtime-js.RealtimeChannel.subscribe": { - "name": "@supabase/realtime-js.RealtimeChannel.subscribe", - "params": [ - { - "name": "callback", - "type": { - "type": "function", - "params": [ - { - "name": "status", - "type": { - "type": "nameOnly", - "name": "REALTIME_SUBSCRIBE_STATES" - } - }, - { - "name": "err", - "type": { - "type": "nameOnly", - "name": "Error" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - "isOptional": true - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "RealtimeChannel" - } - }, - "comment": { - "shortText": "Subscribe registers your client with the server.\\n\\nThe optional \`callback\` receives a \`status\` and, on failure, an \`err\` argument.\\nLog the full \`err\` so its \`cause\`, \`name\`, and any structured fields aren't hidden\\nbehind \`err.message\`.", - "examples": [ - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nsupabase.channel('room1').subscribe((status, err) => {\\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\\n // Log the full error: its \`cause\` often holds the underlying reason.\\n console.error(status, err)\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/realtime-js.RealtimeChannel.teardown": { - "name": "@supabase/realtime-js.RealtimeChannel.teardown", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Destroys and stops related timers." - } - }, - "@supabase/realtime-js.RealtimeChannel.track": { - "name": "@supabase/realtime-js.RealtimeChannel.track", - "params": [ - { - "name": "payload", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "name": "opts", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeChannelSendResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Sends the supplied payload to the presence tracker so other subscribers can see that this\\nclient is online. Use \`untrack\` to stop broadcasting presence for the same key." - } - }, - "@supabase/realtime-js.RealtimeChannel.unsubscribe": { - "name": "@supabase/realtime-js.RealtimeChannel.unsubscribe", - "params": [ - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeChannelSendResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "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": { - "name": "@supabase/realtime-js.RealtimeChannel.untrack", - "params": [ - { - "name": "opts", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "RealtimeChannelSendResponse", - "subTypes": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - null - ] - } - } - }, - "comment": { - "shortText": "Removes the current presence state for this client." - } - }, - "@supabase/realtime-js.RealtimeChannel.updateJoinPayload": { - "name": "@supabase/realtime-js.RealtimeChannel.updateJoinPayload", - "params": [ - { - "name": "payload", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Updates the payload that will be sent the next time the channel joins (reconnects).\\nUseful for rotating access tokens or updating config without re-creating the channel." - } - }, - "@supabase/realtime-js.WebSocketFactory.getWebSocketConstructor": { - "name": "@supabase/realtime-js.WebSocketFactory.getWebSocketConstructor", - "params": [], - "ret": { - "type": { - "type": "function", - "params": [ - { - "name": "url", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "protocols", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "WebSocket" - } - } - } - }, - "comment": { - "shortText": "Returns the best available WebSocket constructor for the current runtime.", - "examples": [ - { - "id": "example-with-error-handling", - "name": "Example with error handling", - "code": "\`\`\`ts\\ntry {\\n const WS = WebSocketFactory.getWebSocketConstructor()\\n const socket = new WS('wss://example.com/socket')\\n} catch (error) {\\n console.error('WebSocket not available in this environment.', error)\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/realtime-js.WebSocketFactory.isWebSocketSupported": { - "name": "@supabase/realtime-js.WebSocketFactory.isWebSocketSupported", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - "comment": { - "shortText": "Detects whether the runtime can establish WebSocket connections.", - "examples": [ - { - "id": "example-in-a-node-js-script", - "name": "Example in a Node.js script", - "code": "\`\`\`ts\\nif (!WebSocketFactory.isWebSocketSupported()) {\\n console.error('WebSockets are required for this script.')\\n process.exitCode = 1\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/realtime-js.WebSocketLike.addEventListener": { - "name": "@supabase/realtime-js.WebSocketLike.addEventListener", - "params": [ - { - "name": "type", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "listener", - "type": { - "type": "nameOnly", - "name": "EventListener" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Registers an event listener on the socket (compatible with browser WebSocket API)." - } - }, - "@supabase/realtime-js.WebSocketLike.close": { - "name": "@supabase/realtime-js.WebSocketLike.close", - "params": [ - { - "name": "code", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Closes the socket, optionally providing a close code and reason." - } - }, - "@supabase/realtime-js.WebSocketLike.removeEventListener": { - "name": "@supabase/realtime-js.WebSocketLike.removeEventListener", - "params": [ - { - "name": "type", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "listener", - "type": { - "type": "nameOnly", - "name": "EventListener" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Removes a previously registered event listener." - } - }, - "@supabase/realtime-js.WebSocketLike.send": { - "name": "@supabase/realtime-js.WebSocketLike.send", - "params": [ - { - "name": "data", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "nameOnly", - "name": "ArrayBufferLike" - }, - { - "type": "nameOnly", - "name": "Blob" - }, - { - "type": "nameOnly", - "name": "ArrayBufferView" - } - ] - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Sends data through the socket using the underlying implementation." - } - }, - "@supabase/realtime-js.WebSocketLikeConstructor.constructor": { - "name": "@supabase/realtime-js.WebSocketLikeConstructor.constructor", - "params": [ - { - "name": "address", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "subprotocols", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "object", - "name": "WebSocketLike", - "properties": [ - { - "name": "binaryType", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "bufferedAmount", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "CLOSED", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "CLOSING", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "CONNECTING", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "dispatchEvent", - "type": { - "type": "function", - "params": [ - { - "name": "event", - "type": { - "type": "nameOnly", - "name": "Event" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - }, - "isOptional": true - }, - { - "name": "extensions", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "onclose", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "this", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ev", - "type": { - "type": "nameOnly", - "name": "CloseEvent" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - } - }, - { - "name": "onerror", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "this", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ev", - "type": { - "type": "nameOnly", - "name": "Event" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - } - }, - { - "name": "onmessage", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "this", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ev", - "type": { - "type": "nameOnly", - "name": "MessageEvent" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - } - }, - { - "name": "onopen", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "this", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "ev", - "type": { - "type": "nameOnly", - "name": "Event" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - } - }, - { - "name": "OPEN", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "protocol", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "readyState", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - }, - "variables": {} - }, - { - "name": "@supabase/storage-js", - "methods": { - "@supabase/storage-js.StorageApiError.constructor": { - "name": "@supabase/storage-js.StorageApiError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusCode", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "namespace", - "type": { - "type": "union", - "name": "ErrorNamespace", - "subTypes": [ - { - "type": "literal", - "value": "storage" - }, - { - "type": "literal", - "value": "vectors" - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageApiError" - } - } - }, - "@supabase/storage-js.StorageApiError.toJSON": { - "name": "@supabase/storage-js.StorageApiError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "statusCode", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - } - }, - "@supabase/storage-js.StorageClient.constructor": { - "name": "@supabase/storage-js.StorageClient.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "opts", - "type": { - "type": "object", - "name": "StorageClientOptions", - "properties": [ - { - "name": "useNewHostname", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageClient" - } - }, - "comment": { - "shortText": "Creates a client for Storage buckets, files, analytics, and vectors.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst avatars = supabase.storage.from('avatars')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { StorageClient } from '@supabase/storage-js'\\n\\nconst storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {\\n apikey: 'your-publishable-key',\\n})\\nconst avatars = storage.from('avatars')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.StorageClient.createBucket": { - "name": "@supabase/storage-js.StorageClient.createBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A unique identifier for the bucket you are creating." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "allowedMimeTypes", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\\nThe default value is null, which allows files with all mime types to be uploaded.\\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - }, - { - "name": "fileSizeLimit", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\\nThe global file size limit takes precedence over this value.\\nThe default value is null, which doesn't set a per bucket file size limit." - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "BucketType", - "subTypes": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - null - ] - }, - "isOptional": true, - "comment": { - "shortText": "(private-beta) specifies the bucket type. see \`BucketType\` for more details.\\n - default bucket type is \`STANDARD\`" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new Storage bucket", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`insert\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "create-bucket", - "name": "Create bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .createBucket('avatars', {\\n public: false,\\n allowedMimeTypes: ['image/png'],\\n fileSizeLimit: 1024\\n })\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"name\\": \\"avatars\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.StorageClient.deleteBucket": { - "name": "@supabase/storage-js.StorageClient.deleteBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\\nYou must first \`empty()\` the bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\` and \`delete\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "delete-bucket", - "name": "Delete bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .deleteBucket('avatars')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"message\\": \\"Successfully deleted\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.StorageClient.emptyBucket": { - "name": "@supabase/storage-js.StorageClient.emptyBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique identifier of the bucket you would like to empty." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Removes all objects inside a single bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\`\\n - \`objects\` table permissions: \`select\` and \`delete\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "empty-bucket", - "name": "Empty bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .emptyBucket('avatars')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"message\\": \\"Successfully emptied\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.StorageClient.from": { - "name": "@supabase/storage-js.StorageClient.from", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The bucket id to operate on." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "default" - } - }, - "comment": { - "shortText": "Perform file operation in a bucket.", - "examples": [ - { - "id": "accessing-a-bucket", - "name": "Accessing a bucket", - "code": "\`\`\`typescript\\nconst avatars = supabase.storage.from('avatars')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.StorageClient.getBucket": { - "name": "@supabase/storage-js.StorageClient.getBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "Bucket", - "properties": [ - { - "name": "allowed_mime_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "file_size_limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "owner", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "BucketType", - "subTypes": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - null - ] - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves the details of an existing Storage bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "get-bucket", - "name": "Get bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .getBucket('avatars')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"id\\": \\"avatars\\",\\n \\"name\\": \\"avatars\\",\\n \\"owner\\": \\"\\",\\n \\"public\\": false,\\n \\"file_size_limit\\": 1024,\\n \\"allowed_mime_types\\": [\\n \\"image/png\\"\\n ],\\n \\"created_at\\": \\"2024-05-22T22:26:05.100Z\\",\\n \\"updated_at\\": \\"2024-05-22T22:26:05.100Z\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.StorageClient.listBuckets": { - "name": "@supabase/storage-js.StorageClient.listBuckets", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "name": "ListBucketOptions", - "properties": [ - { - "name": "limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "offset", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "search", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "sortColumn", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "id" - }, - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - }, - "isOptional": true - }, - { - "name": "sortOrder", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Query parameters for listing buckets" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "Bucket", - "properties": [ - { - "name": "allowed_mime_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "file_size_limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "owner", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "BucketType", - "subTypes": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - null - ] - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "list-buckets", - "name": "List buckets", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .listBuckets()\\n\`\`\`" - }, - { - "id": "list-buckets-with-options", - "name": "List buckets with options", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .listBuckets({\\n limit: 10,\\n offset: 0,\\n sortColumn: 'created_at',\\n sortOrder: 'desc',\\n search: 'prod'\\n })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.StorageClient.setHeader": { - "name": "@supabase/storage-js.StorageClient.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header name" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header value" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request.\\nCreates a shallow copy of headers to avoid mutating shared state." - } - }, - "@supabase/storage-js.StorageClient.throwOnError": { - "name": "@supabase/storage-js.StorageClient.throwOnError", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Enable throwing errors instead of returning them.\\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - }, - "@supabase/storage-js.StorageClient.updateBucket": { - "name": "@supabase/storage-js.StorageClient.updateBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A unique identifier for the bucket you are updating." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "allowedMimeTypes", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\\nThe default value is null, which allows files with all mime types to be uploaded.\\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - }, - { - "name": "fileSizeLimit", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\\nThe global file size limit takes precedence over this value.\\nThe default value is null, which doesn't set a per bucket file size limit." - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates a Storage bucket", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\` and \`update\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "update-bucket", - "name": "Update bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .updateBucket('avatars', {\\n public: false,\\n allowedMimeTypes: ['image/png'],\\n fileSizeLimit: 1024\\n })\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"message\\": \\"Successfully updated\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.StorageError.constructor": { - "name": "@supabase/storage-js.StorageError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "namespace", - "type": { - "type": "union", - "name": "ErrorNamespace", - "subTypes": [ - { - "type": "literal", - "value": "storage" - }, - { - "type": "literal", - "value": "vectors" - } - ] - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "statusCode", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - }, - "@supabase/storage-js.StorageError.toJSON": { - "name": "@supabase/storage-js.StorageError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "statusCode", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - } - }, - "@supabase/storage-js.StorageUnknownError.constructor": { - "name": "@supabase/storage-js.StorageUnknownError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "originalError", - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "name": "namespace", - "type": { - "type": "union", - "name": "ErrorNamespace", - "subTypes": [ - { - "type": "literal", - "value": "storage" - }, - { - "type": "literal", - "value": "vectors" - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageUnknownError" - } - } - }, - "@supabase/storage-js.StorageUnknownError.toJSON": { - "name": "@supabase/storage-js.StorageUnknownError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "statusCode", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - } - }, - "@supabase/storage-js.StorageVectorsApiError.constructor": { - "name": "@supabase/storage-js.StorageVectorsApiError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "name": "statusCode", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageVectorsApiError" - } - } - }, - "@supabase/storage-js.StorageVectorsApiError.toJSON": { - "name": "@supabase/storage-js.StorageVectorsApiError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "statusCode", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - } - }, - "@supabase/storage-js.StorageVectorsError.constructor": { - "name": "@supabase/storage-js.StorageVectorsError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageVectorsError" - } - } - }, - "@supabase/storage-js.StorageVectorsError.toJSON": { - "name": "@supabase/storage-js.StorageVectorsError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "statusCode", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - } - }, - "@supabase/storage-js.StorageVectorsUnknownError.constructor": { - "name": "@supabase/storage-js.StorageVectorsUnknownError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "originalError", - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageVectorsUnknownError" - } - } - }, - "@supabase/storage-js.StorageVectorsUnknownError.toJSON": { - "name": "@supabase/storage-js.StorageVectorsUnknownError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "status", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "name": "statusCode", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - } - }, - "@supabase/storage-js.packages/BlobDownloadBuilder.default.constructor": { - "name": "@supabase/storage-js.packages/BlobDownloadBuilder.default.constructor", - "params": [ - { - "name": "downloadFn", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - } - } - }, - { - "name": "shouldThrowOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "default" - } - } - }, - "@supabase/storage-js.packages/BlobDownloadBuilder.default.asStream": { - "name": "@supabase/storage-js.packages/BlobDownloadBuilder.default.asStream", - "params": [], - "ret": { - "type": { - "type": "nameOnly", - "name": "default" - } - } - }, - "@supabase/storage-js.packages/BlobDownloadBuilder.default.catch": { - "name": "@supabase/storage-js.packages/BlobDownloadBuilder.default.catch", - "params": [ - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "union", - "name": "DownloadResult", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "Blob" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - }, - { - "type": "nameOnly", - "name": "TResult" - } - ] - } - } - }, - "comment": { - "shortText": "Attaches a callback for only the rejection of the Promise." - } - }, - "@supabase/storage-js.packages/BlobDownloadBuilder.default.finally": { - "name": "@supabase/storage-js.packages/BlobDownloadBuilder.default.finally", - "params": [ - { - "name": "onfinally", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is settled (fulfilled or rejected)." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "DownloadResult", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "Blob" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\\nresolved value cannot be modified from the callback." - } - }, - "@supabase/storage-js.packages/BlobDownloadBuilder.default.then": { - "name": "@supabase/storage-js.packages/BlobDownloadBuilder.default.then", - "params": [ - { - "name": "onfulfilled", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "value", - "type": { - "type": "union", - "name": "DownloadResult", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "Blob" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is resolved." - } - }, - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult2" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "TResult2" - } - ] - } - } - }, - "comment": { - "shortText": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - }, - "@supabase/storage-js.packages/StorageAnalyticsClient.default.constructor": { - "name": "@supabase/storage-js.packages/StorageAnalyticsClient.default.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The base URL for the storage API" - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "HTTP headers to include in requests" - } - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true, - "comment": { - "shortText": "Optional custom fetch implementation" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "default" - } - }, - "comment": { - "shortText": "Creates a new StorageAnalyticsClient instance\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`typescript\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.storage.analytics.listBuckets()\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`typescript\\nimport { StorageAnalyticsClient } from '@supabase/storage-js'\\n\\nconst client = new StorageAnalyticsClient(url, headers)\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageAnalyticsClient.default.createBucket": { - "name": "@supabase/storage-js.packages/StorageAnalyticsClient.default.createBucket", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A unique name for the bucket you are creating" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "AnalyticBucket", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ISO 8601 timestamp of bucket creation" - } - }, - { - "name": "format", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Storage format used (e.g., 'iceberg')" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the bucket" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "ANALYTICS" - }, - "comment": { - "shortText": "Bucket type - always 'ANALYTICS' for analytics buckets" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ISO 8601 timestamp of last update" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new analytics bucket using Iceberg tables\\nAnalytics buckets are optimized for analytical queries and data processing\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "text": "- Creates a new analytics bucket using Iceberg tables\\n- Analytics buckets are optimized for analytical queries and data processing", - "examples": [ - { - "id": "create-analytics-bucket", - "name": "Create analytics bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .analytics\\n .createBucket('analytics-data')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"name\\": \\"analytics-data\\",\\n \\"type\\": \\"ANALYTICS\\",\\n \\"format\\": \\"iceberg\\",\\n \\"created_at\\": \\"2024-05-22T22:26:05.100Z\\",\\n \\"updated_at\\": \\"2024-05-22T22:26:05.100Z\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageAnalyticsClient.default.deleteBucket": { - "name": "@supabase/storage-js.packages/StorageAnalyticsClient.default.deleteBucket", - "params": [ - { - "name": "bucketName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes an existing analytics bucket\\nA bucket can't be deleted with existing objects inside it\\nYou must first empty the bucket before deletion\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "text": "- Deletes an analytics bucket", - "examples": [ - { - "id": "delete-analytics-bucket", - "name": "Delete analytics bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .analytics\\n .deleteBucket('analytics-data')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"message\\": \\"Successfully deleted\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageAnalyticsClient.default.from": { - "name": "@supabase/storage-js.packages/StorageAnalyticsClient.default.from", - "params": [ - { - "name": "bucketName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The name of the analytics bucket (warehouse) to connect to" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "WrappedIcebergRestCatalog" - } - }, - "comment": { - "shortText": "Get an Iceberg REST Catalog client configured for a specific analytics bucket\\nUse this to perform advanced table and namespace operations within the bucket\\nThe returned client provides full access to the Apache Iceberg REST Catalog API\\nwith the Supabase \`{ data, error }\` pattern for consistent error handling on all operations.\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "text": "This method provides a bridge between Supabase's bucket management and the standard\\nApache Iceberg REST Catalog API. The bucket name maps to the Iceberg warehouse parameter.\\nAll authentication and configuration is handled automatically using your Supabase credentials.\\n\\n**Error Handling**: Invalid bucket names throw immediately. All catalog\\noperations return \`{ data, error }\` where errors are \`IcebergError\` instances from iceberg-js.\\nUse helper methods like \`error.isNotFound()\` or check \`error.status\` for specific error handling.\\nUse \`.throwOnError()\` on the analytics client if you prefer exceptions for catalog operations.\\n\\n**Cleanup Operations**: When using \`dropTable\`, the \`purge: true\` option permanently\\ndeletes all table data. Without it, the table is marked as deleted but data remains.\\n\\n**Library Dependency**: The returned catalog wraps \`IcebergRestCatalog\` from iceberg-js.\\nFor complete API documentation and advanced usage, refer to the\\n[iceberg-js documentation](https://supabase.github.io/iceberg-js/).", - "examples": [ - { - "id": "get-catalog-and-create-table", - "name": "Get catalog and create table", - "code": "\`\`\`js\\n// First, create an analytics bucket\\nconst { data: bucket, error: bucketError } = await supabase\\n .storage\\n .analytics\\n .createBucket('analytics-data')\\n\\n// Get the Iceberg catalog for that bucket\\nconst catalog = supabase.storage.analytics.from('analytics-data')\\n\\n// Create a namespace\\nconst { error: nsError } = await catalog.createNamespace({ namespace: ['default'] })\\n\\n// Create a table with schema\\nconst { data: tableMetadata, error: tableError } = await catalog.createTable(\\n { namespace: ['default'] },\\n {\\n name: 'events',\\n schema: {\\n type: 'struct',\\n fields: [\\n { id: 1, name: 'id', type: 'long', required: true },\\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\\n { id: 3, name: 'user_id', type: 'string', required: false }\\n ],\\n 'schema-id': 0,\\n 'identifier-field-ids': [1]\\n },\\n 'partition-spec': {\\n 'spec-id': 0,\\n fields: []\\n },\\n 'write-order': {\\n 'order-id': 0,\\n fields: []\\n },\\n properties: {\\n 'write.format.default': 'parquet'\\n }\\n }\\n)\\n\`\`\`" - }, - { - "id": "list-tables-in-namespace", - "name": "List tables in namespace", - "code": "\`\`\`js\\nconst catalog = supabase.storage.analytics.from('analytics-data')\\n\\n// List all tables in the default namespace\\nconst { data: tables, error: listError } = await catalog.listTables({ namespace: ['default'] })\\nif (listError) {\\n if (listError.isNotFound()) {\\n console.log('Namespace not found')\\n }\\n return\\n}\\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\\n\`\`\`" - }, - { - "id": "working-with-namespaces", - "name": "Working with namespaces", - "code": "\`\`\`js\\nconst catalog = supabase.storage.analytics.from('analytics-data')\\n\\n// List all namespaces\\nconst { data: namespaces } = await catalog.listNamespaces()\\n\\n// Create namespace with properties\\nawait catalog.createNamespace(\\n { namespace: ['production'] },\\n { properties: { owner: 'data-team', env: 'prod' } }\\n)\\n\`\`\`" - }, - { - "id": "cleanup-operations", - "name": "Cleanup operations", - "code": "\`\`\`js\\nconst catalog = supabase.storage.analytics.from('analytics-data')\\n\\n// Drop table with purge option (removes all data)\\nconst { error: dropError } = await catalog.dropTable(\\n { namespace: ['default'], name: 'events' },\\n { purge: true }\\n)\\n\\nif (dropError?.isNotFound()) {\\n console.log('Table does not exist')\\n}\\n\\n// Drop namespace (must be empty)\\nawait catalog.dropNamespace({ namespace: ['default'] })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageAnalyticsClient.default.listBuckets": { - "name": "@supabase/storage-js.packages/StorageAnalyticsClient.default.listBuckets", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Maximum number of buckets to return" - } - }, - { - "name": "offset", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Number of buckets to skip" - } - }, - { - "name": "search", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Search term to filter bucket names" - } - }, - { - "name": "sortColumn", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Column to sort by ('name', 'created_at', 'updated_at')" - } - }, - { - "name": "sortOrder", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Sort order ('asc' or 'desc')" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Query parameters for listing buckets" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "AnalyticBucket", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ISO 8601 timestamp of bucket creation" - } - }, - { - "name": "format", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Storage format used (e.g., 'iceberg')" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the bucket" - } - }, - { - "name": "type", - "type": { - "type": "literal", - "value": "ANALYTICS" - }, - "comment": { - "shortText": "Bucket type - always 'ANALYTICS' for analytics buckets" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "ISO 8601 timestamp of last update" - } - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves the details of all Analytics Storage buckets within an existing project\\nOnly returns buckets of type 'ANALYTICS'\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "text": "- Retrieves the details of all Analytics Storage buckets within an existing project\\n- Only returns buckets of type 'ANALYTICS'", - "examples": [ - { - "id": "list-analytics-buckets", - "name": "List analytics buckets", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .analytics\\n .listBuckets({\\n limit: 10,\\n offset: 0,\\n sortColumn: 'created_at',\\n sortOrder: 'desc'\\n })\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"analytics-data\\",\\n \\"type\\": \\"ANALYTICS\\",\\n \\"format\\": \\"iceberg\\",\\n \\"created_at\\": \\"2024-05-22T22:26:05.100Z\\",\\n \\"updated_at\\": \\"2024-05-22T22:26:05.100Z\\"\\n }\\n ],\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageAnalyticsClient.default.setHeader": { - "name": "@supabase/storage-js.packages/StorageAnalyticsClient.default.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header name" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header value" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request.\\nCreates a shallow copy of headers to avoid mutating shared state." - } - }, - "@supabase/storage-js.packages/StorageAnalyticsClient.default.throwOnError": { - "name": "@supabase/storage-js.packages/StorageAnalyticsClient.default.throwOnError", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Enable throwing errors instead of returning them.\\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.constructor": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "opts", - "type": { - "type": "object", - "name": "StorageClientOptions", - "properties": [ - { - "name": "useNewHostname", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "default" - } - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.createBucket": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.createBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A unique identifier for the bucket you are creating." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "allowedMimeTypes", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\\nThe default value is null, which allows files with all mime types to be uploaded.\\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - }, - { - "name": "fileSizeLimit", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\\nThe global file size limit takes precedence over this value.\\nThe default value is null, which doesn't set a per bucket file size limit." - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "BucketType", - "subTypes": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - null - ] - }, - "isOptional": true, - "comment": { - "shortText": "(private-beta) specifies the bucket type. see \`BucketType\` for more details.\\n - default bucket type is \`STANDARD\`" - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data" - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new Storage bucket", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`insert\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "create-bucket", - "name": "Create bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .createBucket('avatars', {\\n public: false,\\n allowedMimeTypes: ['image/png'],\\n fileSizeLimit: 1024\\n })\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"name\\": \\"avatars\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.deleteBucket": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.deleteBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\\nYou must first \`empty()\` the bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\` and \`delete\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "delete-bucket", - "name": "Delete bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .deleteBucket('avatars')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"message\\": \\"Successfully deleted\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.emptyBucket": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.emptyBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique identifier of the bucket you would like to empty." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Removes all objects inside a single bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\`\\n - \`objects\` table permissions: \`select\` and \`delete\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "empty-bucket", - "name": "Empty bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .emptyBucket('avatars')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"message\\": \\"Successfully emptied\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.getBucket": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.getBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "Bucket", - "properties": [ - { - "name": "allowed_mime_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "file_size_limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "owner", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "BucketType", - "subTypes": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - null - ] - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves the details of an existing Storage bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "get-bucket", - "name": "Get bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .getBucket('avatars')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"id\\": \\"avatars\\",\\n \\"name\\": \\"avatars\\",\\n \\"owner\\": \\"\\",\\n \\"public\\": false,\\n \\"file_size_limit\\": 1024,\\n \\"allowed_mime_types\\": [\\n \\"image/png\\"\\n ],\\n \\"created_at\\": \\"2024-05-22T22:26:05.100Z\\",\\n \\"updated_at\\": \\"2024-05-22T22:26:05.100Z\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.listBuckets": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.listBuckets", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "name": "ListBucketOptions", - "properties": [ - { - "name": "limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "offset", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "search", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "sortColumn", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "id" - }, - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - }, - "isOptional": true - }, - { - "name": "sortOrder", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Query parameters for listing buckets" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "Bucket", - "properties": [ - { - "name": "allowed_mime_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "file_size_limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "owner", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "BucketType", - "subTypes": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - null - ] - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "list-buckets", - "name": "List buckets", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .listBuckets()\\n\`\`\`" - }, - { - "id": "list-buckets-with-options", - "name": "List buckets with options", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .listBuckets({\\n limit: 10,\\n offset: 0,\\n sortColumn: 'created_at',\\n sortOrder: 'desc',\\n search: 'prod'\\n })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.setHeader": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header name" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header value" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request.\\nCreates a shallow copy of headers to avoid mutating shared state." - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.throwOnError": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.throwOnError", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Enable throwing errors instead of returning them.\\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - }, - "@supabase/storage-js.packages/StorageBucketApi.default.updateBucket": { - "name": "@supabase/storage-js.packages/StorageBucketApi.default.updateBucket", - "params": [ - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "A unique identifier for the bucket you are updating." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "allowedMimeTypes", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "specifies the allowed mime types that this bucket can accept during upload.\\nThe default value is null, which allows files with all mime types to be uploaded.\\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - }, - { - "name": "fileSizeLimit", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "specifies the max file size in bytes that can be uploaded to this bucket.\\nThe global file size limit takes precedence over this value.\\nThe default value is null, which doesn't set a per bucket file size limit." - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Updates a Storage bucket", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: \`select\` and \`update\`\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "update-bucket", - "name": "Update bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .updateBucket('avatars', {\\n public: false,\\n allowedMimeTypes: ['image/png'],\\n fileSizeLimit: 1024\\n })\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"message\\": \\"Successfully updated\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.constructor": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "name": "bucketId", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "default" - } - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.copy": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.copy", - "params": [ - { - "name": "fromPath", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The original file path, including the current file name. For example \`folder/image.png\`." - } - }, - { - "name": "toPath", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The new file path, including the new file name. For example \`folder/image-copy.png\`." - } - }, - { - "name": "options", - "type": { - "type": "object", - "name": "DestinationOptions", - "properties": [ - { - "name": "destinationBucket", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The destination options." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Copies an existing file to a new path in the same bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`insert\` and \`select\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "copy-file", - "name": "Copy file", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .copy('public/avatar1.png', 'private/avatar2.png')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"path\\": \\"avatars/private/avatar2.png\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.createSignedUploadUrl": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.createSignedUploadUrl", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The file path, including the current file name. For example \`folder/image.png\`." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "upsert", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "comment": { - "shortText": "If set to true, allows the file to be overwritten if it already exists." - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "signedUrl", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a signed upload URL.\\nSigned upload URLs can be used to upload files to the bucket without further authentication.\\nThey are valid for 2 hours.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`insert\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "create-signed-upload-url", - "name": "Create Signed Upload URL", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .createSignedUploadUrl('folder/cat.jpg')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"signedUrl\\": \\"https://example.supabase.co/storage/v1/object/upload/sign/avatars/folder/cat.jpg?token=\\",\\n \\"path\\": \\"folder/cat.jpg\\",\\n \\"token\\": \\"\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.createSignedUrl": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.createSignedUrl", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The file path, including the current file name. For example \`folder/image.png\`." - } - }, - { - "name": "expiresIn", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the signed URL expires. For example, \`60\` for a URL which is valid for one minute." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "cacheNonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Append a cache nonce parameter to the URL to invalidate the cache." - } - }, - { - "name": "download", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - }, - { - "name": "transform", - "type": { - "type": "object", - "name": "TransformOptions", - "properties": [ - { - "name": "format", - "type": { - "type": "literal", - "value": "origin" - }, - "isOptional": true, - "comment": { - "shortText": "Specify the format of the image requested.\\n\\nWhen using 'origin' we force the format to be the same as the original image.\\nWhen this option is not passed in, images are optimized to modern image formats like Webp." - } - }, - { - "name": "height", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The height of the image in pixels." - } - }, - { - "name": "quality", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Set the quality of the returned image.\\nA number from 20 to 100, with 100 being the highest quality.\\nDefaults to 80" - } - }, - { - "name": "resize", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "cover" - }, - { - "type": "literal", - "value": "contain" - }, - { - "type": "literal", - "value": "fill" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." - } - }, - { - "name": "width", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The width of the image in pixels." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Transform the asset before serving it to the client." - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "signedUrl", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`select\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "create-signed-url", - "name": "Create Signed URL", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .createSignedUrl('folder/avatar1.png', 60)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"signedUrl\\": \\"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "create-a-signed-url-for-an-asset-with-transformations", - "name": "Create a signed URL for an asset with transformations", - "code": "\`\`\`js\\nconst { data } = await supabase\\n .storage\\n .from('avatars')\\n .createSignedUrl('folder/avatar1.png', 60, {\\n transform: {\\n width: 100,\\n height: 100,\\n }\\n })\\n\`\`\`" - }, - { - "id": "create-a-signed-url-which-triggers-the-download-of-the-asset", - "name": "Create a signed URL which triggers the download of the asset", - "code": "\`\`\`js\\nconst { data } = await supabase\\n .storage\\n .from('avatars')\\n .createSignedUrl('folder/avatar1.png', 60, {\\n download: true,\\n })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.createSignedUrls": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.createSignedUrls", - "params": [ - { - "name": "paths", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "The file paths to be downloaded, including the current file names. For example \`['folder/image.png', 'folder2/image2.png']\`." - } - }, - { - "name": "expiresIn", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "The number of seconds until the signed URLs expire. For example, \`60\` for URLs which are valid for one minute." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "cacheNonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Append a cache nonce parameter to the URL to invalidate the cache." - } - }, - { - "name": "download", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "type": "object", - "properties": [ - { - "name": "error", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "name": "path", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "name": "signedUrl", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`select\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "create-signed-urls", - "name": "Create Signed URLs", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"error\\": null,\\n \\"path\\": \\"folder/avatar1.png\\",\\n \\"signedURL\\": \\"/object/sign/avatars/folder/avatar1.png?token=\\",\\n \\"signedUrl\\": \\"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\\"\\n },\\n {\\n \\"error\\": null,\\n \\"path\\": \\"folder/avatar2.png\\",\\n \\"signedURL\\": \\"/object/sign/avatars/folder/avatar2.png?token=\\",\\n \\"signedUrl\\": \\"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar2.png?token=\\"\\n }\\n ],\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.download": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.download", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example \`folder/image.png\`." - } - }, - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "Options" - }, - "isOptional": true - }, - { - "name": "parameters", - "type": { - "type": "object", - "name": "FetchParameters", - "properties": [ - { - "name": "cache", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "default" - }, - { - "type": "literal", - "value": "no-store" - }, - { - "type": "literal", - "value": "reload" - }, - { - "type": "literal", - "value": "no-cache" - }, - { - "type": "literal", - "value": "force-cache" - }, - { - "type": "literal", - "value": "only-if-cached" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Controls how the request interacts with the browser's HTTP cache.\\n- 'default': Use standard cache behavior\\n- 'no-store': Bypass cache entirely (useful in Edge Functions)\\n- 'reload': Bypass cache but update it with response\\n- 'no-cache': Validate with server before using cached response\\n- 'force-cache': Use cache even if stale\\n- 'only-if-cached': Only use cache, fail if not cached" - } - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true, - "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Additional fetch parameters like signal for cancellation. Supports standard fetch options including cache control." - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "default" - } - }, - "comment": { - "shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from \`getPublicUrl\` instead.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`select\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "download-file", - "name": "Download file", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .download('folder/avatar1.png')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": ,\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "download-file-with-transformations", - "name": "Download file with transformations", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .download('folder/avatar1.png', {\\n transform: {\\n width: 100,\\n height: 100,\\n quality: 80\\n }\\n })\\n\`\`\`" - }, - { - "id": "download-with-cache-control-useful-in-edge-functions", - "name": "Download with cache control (useful in Edge Functions)", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .download('folder/avatar1.png', {}, { cache: 'no-store' })\\n\`\`\`" - }, - { - "id": "download-with-abort-signal", - "name": "Download with abort signal", - "code": "\`\`\`js\\nconst controller = new AbortController()\\nsetTimeout(() => controller.abort(), 5000)\\n\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .download('folder/avatar1.png', {}, { signal: controller.signal })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.exists": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.exists", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The file path, including the file name. For example \`folder/image.png\`." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Checks the existence of a file.", - "examples": [ - { - "id": "check-file-existence", - "name": "Check file existence", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .exists('folder/avatar1.png')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.getPublicUrl": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.getPublicUrl", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The path and name of the file to generate the public URL for. For example \`folder/image.png\`." - } - }, - { - "name": "options", - "type": { - "type": "object", - "properties": [ - { - "name": "cacheNonce", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Append a cache nonce parameter to the URL to invalidate the cache." - } - }, - { - "name": "download", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - }, - { - "name": "transform", - "type": { - "type": "object", - "name": "TransformOptions", - "properties": [ - { - "name": "format", - "type": { - "type": "literal", - "value": "origin" - }, - "isOptional": true, - "comment": { - "shortText": "Specify the format of the image requested.\\n\\nWhen using 'origin' we force the format to be the same as the original image.\\nWhen this option is not passed in, images are optimized to modern image formats like Webp." - } - }, - { - "name": "height", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The height of the image in pixels." - } - }, - { - "name": "quality", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Set the quality of the returned image.\\nA number from 20 to 100, with 100 being the highest quality.\\nDefaults to 80" - } - }, - { - "name": "resize", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "cover" - }, - { - "type": "literal", - "value": "contain" - }, - { - "type": "literal", - "value": "fill" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The resize mode can be cover, contain or fill. Defaults to cover.\\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." - } - }, - { - "name": "width", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The width of the image in pixels." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Transform the asset before serving it to the client." - } - } - ] - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "publicUrl", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ] - } - }, - "comment": { - "shortText": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.", - "text": "- The bucket needs to be set to public, either via [updateBucket()](/docs/reference/javascript/storage-updatebucket) or by going to Storage on [supabase.com/dashboard](https://supabase.com/dashboard), clicking the overflow menu on a bucket and choosing \\"Make public\\"\\n- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "returns-the-url-for-an-asset-in-a-public-bucket", - "name": "Returns the URL for an asset in a public bucket", - "code": "\`\`\`js\\nconst { data } = supabase\\n .storage\\n .from('public-bucket')\\n .getPublicUrl('folder/avatar1.png')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"publicUrl\\": \\"https://example.supabase.co/storage/v1/object/public/public-bucket/folder/avatar1.png\\"\\n }\\n}\\n\`\`\`" - }, - { - "id": "returns-the-url-for-an-asset-in-a-public-bucket-with-transformations", - "name": "Returns the URL for an asset in a public bucket with transformations", - "code": "\`\`\`js\\nconst { data } = supabase\\n .storage\\n .from('public-bucket')\\n .getPublicUrl('folder/avatar1.png', {\\n transform: {\\n width: 100,\\n height: 100,\\n }\\n })\\n\`\`\`" - }, - { - "id": "returns-the-url-which-triggers-the-download-of-an-asset-in-a-public-bucket", - "name": "Returns the URL which triggers the download of an asset in a public bucket", - "code": "\`\`\`js\\nconst { data } = supabase\\n .storage\\n .from('public-bucket')\\n .getPublicUrl('folder/avatar1.png', {\\n download: true,\\n })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.info": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.info", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The file path, including the file name. For example \`folder/image.png\`." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "Camelize" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves the details of an existing file.\\n\\nReturns detailed file metadata including size, content type, and timestamps.\\nNote: The API returns \`last_modified\` field, not \`updated_at\`.", - "examples": [ - { - "id": "get-file-info", - "name": "Get file info", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .info('folder/avatar1.png')\\n\\nif (data) {\\n console.log('Last modified:', data.lastModified)\\n console.log('Size:', data.size)\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.list": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.list", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The folder path." - } - }, - { - "name": "options", - "type": { - "type": "object", - "name": "SearchOptions", - "properties": [ - { - "name": "limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The number of files you want to be returned." - } - }, - { - "name": "offset", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The starting position." - } - }, - { - "name": "search", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The search string to filter files by." - } - }, - { - "name": "sortBy", - "type": { - "type": "object", - "name": "SortBy", - "properties": [ - { - "name": "column", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "order", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Search options including limit (defaults to 100), offset, sortBy, and search" - } - }, - { - "name": "parameters", - "type": { - "type": "object", - "name": "FetchParameters", - "properties": [ - { - "name": "cache", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "default" - }, - { - "type": "literal", - "value": "no-store" - }, - { - "type": "literal", - "value": "reload" - }, - { - "type": "literal", - "value": "no-cache" - }, - { - "type": "literal", - "value": "force-cache" - }, - { - "type": "literal", - "value": "only-if-cached" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Controls how the request interacts with the browser's HTTP cache.\\n- 'default': Use standard cache behavior\\n- 'no-store': Bypass cache entirely (useful in Edge Functions)\\n- 'reload': Bypass cache but update it with response\\n- 'no-cache': Validate with server before using cached response\\n- 'force-cache': Use cache even if stale\\n- 'only-if-cached': Only use cache, fail if not cached" - } - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true, - "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional fetch parameters including signal for cancellation" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "FileObject", - "properties": [ - { - "name": "bucket_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "" - } - }, - { - "name": "buckets", - "type": { - "type": "object", - "name": "Bucket", - "properties": [ - { - "name": "allowed_mime_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "file_size_limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "owner", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "BucketType", - "subTypes": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - null - ] - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "" - } - }, - { - "name": "created_at", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "Creation timestamp (null for folders)" - } - }, - { - "name": "id", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "Unique identifier for the file (null for folders)" - } - }, - { - "name": "last_accessed_at", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "" - } - }, - { - "name": "metadata", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "FileMetadata", - "properties": [ - { - "name": "cacheControl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Cache control directive (e.g., \\"max-age=3600\\")" - } - }, - { - "name": "contentLength", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Content length in bytes (usually same as size)" - } - }, - { - "name": "eTag", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Entity tag for caching and conditional requests" - } - }, - { - "name": "httpStatusCode", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "HTTP status code from the storage backend" - } - }, - { - "name": "lastModified", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Last modification timestamp (ISO 8601)" - } - }, - { - "name": "mimetype", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "MIME type of the file" - } - }, - { - "name": "size", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "File size in bytes" - } - } - ] - } - ] - }, - "comment": { - "shortText": "File metadata including size, mimetype, etc. (null for folders)" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "File or folder name (relative to the prefix) - always present" - } - }, - { - "name": "owner", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "" - } - }, - { - "name": "updated_at", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "Last update timestamp (null for folders)" - } - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all the files and folders within a path of the bucket.\\n\\n**Important:** For folder entries, fields like \`id\`, \`updated_at\`, \`created_at\`,\\n\`last_accessed_at\`, and \`metadata\` will be \`null\`. Only files have these fields populated.\\nAdditionally, deprecated fields like \`bucket_id\`, \`owner\`, and \`buckets\` are NOT returned\\nby this method.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`select\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "list-files-in-a-bucket", - "name": "List files in a bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .list('folder', {\\n limit: 100,\\n offset: 0,\\n sortBy: { column: 'name', order: 'asc' },\\n })\\n\\n// Handle files vs folders\\ndata?.forEach(item => {\\n if (item.id !== null) {\\n // It's a file\\n console.log('File:', item.name, 'Size:', item.metadata?.size)\\n } else {\\n // It's a folder\\n console.log('Folder:', item.name)\\n }\\n})\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": [\\n {\\n \\"name\\": \\"avatar1.png\\",\\n \\"id\\": \\"e668cf7f-821b-4a2f-9dce-7dfa5dd1cfd2\\",\\n \\"updated_at\\": \\"2024-05-22T23:06:05.580Z\\",\\n \\"created_at\\": \\"2024-05-22T23:04:34.443Z\\",\\n \\"last_accessed_at\\": \\"2024-05-22T23:04:34.443Z\\",\\n \\"metadata\\": {\\n \\"eTag\\": \\"\\\\\\"c5e8c553235d9af30ef4f6e280790b92\\\\\\"\\",\\n \\"size\\": 32175,\\n \\"mimetype\\": \\"image/png\\",\\n \\"cacheControl\\": \\"max-age=3600\\",\\n \\"lastModified\\": \\"2024-05-22T23:06:05.574Z\\",\\n \\"contentLength\\": 32175,\\n \\"httpStatusCode\\": 200\\n }\\n }\\n ],\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "search-files-in-a-bucket", - "name": "Search files in a bucket", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .list('folder', {\\n limit: 100,\\n offset: 0,\\n sortBy: { column: 'name', order: 'asc' },\\n search: 'jon'\\n })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.listV2": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.listV2", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "name": "SearchV2Options", - "properties": [ - { - "name": "cursor", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The cursor used for pagination. Pass the value received from nextCursor of the previous request." - } - }, - { - "name": "limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The number of files you want to be returned." - } - }, - { - "name": "prefix", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The prefix search string to filter files by." - } - }, - { - "name": "sortBy", - "type": { - "type": "object", - "name": "SortByV2", - "properties": [ - { - "name": "column", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "name": "order", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The column and order to sort by" - } - }, - { - "name": "with_delimiter", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "Whether to emulate a hierarchical listing of objects using delimiters.\\n\\n- When \`false\` (default), all objects are listed as flat key/value pairs.\\n- When \`true\`, the response groups objects by delimiter, making it appear\\n like a file/folder hierarchy." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Search options including prefix, cursor for pagination, limit, with_delimiter" - } - }, - { - "name": "parameters", - "type": { - "type": "object", - "name": "FetchParameters", - "properties": [ - { - "name": "cache", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "default" - }, - { - "type": "literal", - "value": "no-store" - }, - { - "type": "literal", - "value": "reload" - }, - { - "type": "literal", - "value": "no-cache" - }, - { - "type": "literal", - "value": "force-cache" - }, - { - "type": "literal", - "value": "only-if-cached" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Controls how the request interacts with the browser's HTTP cache.\\n- 'default': Use standard cache behavior\\n- 'no-store': Bypass cache entirely (useful in Edge Functions)\\n- 'reload': Bypass cache but update it with response\\n- 'no-cache': Validate with server before using cached response\\n- 'force-cache': Use cache even if stale\\n- 'only-if-cached': Only use cache, fail if not cached" - } - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true, - "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional fetch parameters including signal for cancellation" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "SearchV2Result", - "properties": [ - { - "name": "folders", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "SearchV2Folder", - "properties": [ - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Full folder key/path" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Folder name/prefix" - } - } - ] - } - } - }, - { - "name": "hasNext", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "nextCursor", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - }, - { - "name": "objects", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "SearchV2Object", - "properties": [ - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Creation timestamp" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the file" - } - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Full object key/path" - } - }, - { - "name": "last_accessed_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "" - } - }, - { - "name": "metadata", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "FileMetadata", - "properties": [ - { - "name": "cacheControl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Cache control directive (e.g., \\"max-age=3600\\")" - } - }, - { - "name": "contentLength", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Content length in bytes (usually same as size)" - } - }, - { - "name": "eTag", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Entity tag for caching and conditional requests" - } - }, - { - "name": "httpStatusCode", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "HTTP status code from the storage backend" - } - }, - { - "name": "lastModified", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Last modification timestamp (ISO 8601)" - } - }, - { - "name": "mimetype", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "MIME type of the file" - } - }, - { - "name": "size", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "File size in bytes" - } - } - ] - } - ] - }, - "comment": { - "shortText": "File metadata including size, mimetype, etc. (null if not yet set)" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "File name" - } - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Last update timestamp" - } - } - ] - } - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all the files and folders within a bucket using the V2 API with pagination support.\\n\\n**Important:** Folder entries in the \`folders\` array only contain \`name\` and optionally \`key\` —\\nthey have no \`id\`, timestamps, or \`metadata\` fields. Full file metadata is only available\\non entries in the \`objects\` array.\\n\\n this method signature might change in the future", - "tags": [ - { - "tag": "experimental", - "text": "" - } - ], - "examples": [ - { - "id": "list-files-with-pagination", - "name": "List files with pagination", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .listV2({\\n prefix: 'folder/',\\n limit: 100,\\n })\\n\\n// Handle pagination\\nif (data?.hasNext) {\\n const nextPage = await supabase\\n .storage\\n .from('avatars')\\n .listV2({\\n prefix: 'folder/',\\n cursor: data.nextCursor,\\n })\\n}\\n\\n// Handle files vs folders\\ndata?.objects.forEach(file => {\\n if (file.id !== null) {\\n console.log('File:', file.name, 'Size:', file.metadata?.size)\\n }\\n})\\ndata?.folders.forEach(folder => {\\n console.log('Folder:', folder.name)\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.move": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.move", - "params": [ - { - "name": "fromPath", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The original file path, including the current file name. For example \`folder/image.png\`." - } - }, - { - "name": "toPath", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The new file path, including the new file name. For example \`folder/image-new.png\`." - } - }, - { - "name": "options", - "type": { - "type": "object", - "name": "DestinationOptions", - "properties": [ - { - "name": "destinationBucket", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The destination options." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Moves an existing file to a new path in the same bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`update\` and \`select\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "move-file", - "name": "Move file", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .move('public/avatar1.png', 'private/avatar2.png')\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"message\\": \\"Successfully moved\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.remove": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.remove", - "params": [ - { - "name": "paths", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "comment": { - "shortText": "An array of files to delete, including the path and file name. For example [\`'folder/image.png'\`]." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "FileObject", - "properties": [ - { - "name": "bucket_id", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "" - } - }, - { - "name": "buckets", - "type": { - "type": "object", - "name": "Bucket", - "properties": [ - { - "name": "allowed_mime_types", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "created_at", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "file_size_limit", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "owner", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "public", - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "name": "type", - "type": { - "type": "union", - "name": "BucketType", - "subTypes": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - null - ] - }, - "isOptional": true - }, - { - "name": "updated_at", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "" - } - }, - { - "name": "created_at", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "Creation timestamp (null for folders)" - } - }, - { - "name": "id", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "Unique identifier for the file (null for folders)" - } - }, - { - "name": "last_accessed_at", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "" - } - }, - { - "name": "metadata", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "object", - "name": "FileMetadata", - "properties": [ - { - "name": "cacheControl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Cache control directive (e.g., \\"max-age=3600\\")" - } - }, - { - "name": "contentLength", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Content length in bytes (usually same as size)" - } - }, - { - "name": "eTag", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Entity tag for caching and conditional requests" - } - }, - { - "name": "httpStatusCode", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "HTTP status code from the storage backend" - } - }, - { - "name": "lastModified", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Last modification timestamp (ISO 8601)" - } - }, - { - "name": "mimetype", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "MIME type of the file" - } - }, - { - "name": "size", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "File size in bytes" - } - } - ] - } - ] - }, - "comment": { - "shortText": "File metadata including size, mimetype, etc. (null for folders)" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "File or folder name (relative to the prefix) - always present" - } - }, - { - "name": "owner", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "" - } - }, - { - "name": "updated_at", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "comment": { - "shortText": "Last update timestamp (null for folders)" - } - } - ] - } - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes files within the same bucket\\n\\nReturns an array of FileObject entries for the deleted files. Note that deprecated\\nfields like \`bucket_id\` may or may not be present in the response - do not rely on them.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`delete\` and \`select\`\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "delete-file", - "name": "Delete file", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .remove(['folder/avatar1.png'])\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": [],\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.setHeader": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header name" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header value" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request.\\nCreates a shallow copy of headers to avoid mutating shared state." - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.throwOnError": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.throwOnError", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Enable throwing errors instead of returning them.\\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.toBase64": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.toBase64", - "params": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "string" - } - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.update": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.update", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The relative file path. Should be of the format \`folder/subfolder/filename.png\`. The bucket must already exist before attempting to update." - } - }, - { - "name": "fileBody", - "type": { - "type": "union", - "subTypes": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "nameOnly", - "name": "ArrayBuffer" - }, - { - "type": "nameOnly", - "name": "ReadableStream" - }, - { - "type": "nameOnly", - "name": "Blob" - }, - { - "type": "nameOnly", - "name": "File" - }, - { - "type": "nameOnly", - "name": "FormData" - }, - { - "type": "nameOnly", - "name": "@types/node.__global.NodeJS.ReadableStream" - }, - { - "type": "nameOnly", - "name": "URLSearchParams" - }, - { - "type": "nameOnly", - "name": "ArrayBufferView" - }, - { - "type": "nameOnly", - "name": "@types/node.__global.Buffer" - } - ] - }, - "comment": { - "shortText": "The body of the file to be stored in the bucket." - } - }, - { - "name": "fileOptions", - "type": { - "type": "object", - "name": "FileOptions", - "properties": [ - { - "name": "cacheControl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the \`Cache-Control: max-age=\` header. Defaults to 3600 seconds." - } - }, - { - "name": "contentType", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "the \`Content-Type\` header value. Should be specified if using a \`fileBody\` that is neither \`Blob\` nor \`File\` nor \`FormData\`, otherwise will default to \`text/plain;charset=UTF-8\`." - } - }, - { - "name": "duplex", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." - } - }, - { - "name": "headers", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Optionally add extra headers" - } - }, - { - "name": "metadata", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." - } - }, - { - "name": "upsert", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional file upload options including cacheControl, contentType, and metadata.\\n**Note:** The \`upsert\` option has no effect here. \`update()\` always replaces the\\nfile at the given path, so the \`x-upsert\` header is not sent. To control upsert\\nbehavior, use \`upload()\` instead." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "fullPath", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Replaces an existing file at the specified path with a new one.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: \`update\` and \`select\`\\n- \`update()\` always replaces the file at the given path regardless of the \`upsert\` option.\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\\n- For React Native, using either \`Blob\`, \`File\` or \`FormData\` does not work as intended. Update file using \`ArrayBuffer\` from base64 file data instead, see example below.", - "examples": [ - { - "id": "update-file", - "name": "Update file", - "code": "\`\`\`js\\nconst avatarFile = event.target.files[0]\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .update('public/avatar1.png', avatarFile, {\\n cacheControl: '3600'\\n })\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"path\\": \\"public/avatar1.png\\",\\n \\"fullPath\\": \\"avatars/public/avatar1.png\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "update-file-using-arraybuffer-from-base64-file-data", - "name": "Update file using \`ArrayBuffer\` from base64 file data", - "code": "\`\`\`js\\nimport {decode} from 'base64-arraybuffer'\\n\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .update('public/avatar1.png', decode('base64FileData'), {\\n contentType: 'image/png'\\n })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.upload": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.upload", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The file path, including the file name. Should be of the format \`folder/subfolder/filename.png\`. The bucket must already exist before attempting to upload." - } - }, - { - "name": "fileBody", - "type": { - "type": "nameOnly", - "name": "FileBody" - }, - "comment": { - "shortText": "The body of the file to be stored in the bucket." - } - }, - { - "name": "fileOptions", - "type": { - "type": "object", - "name": "FileOptions", - "properties": [ - { - "name": "cacheControl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the \`Cache-Control: max-age=\` header. Defaults to 3600 seconds." - } - }, - { - "name": "contentType", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "the \`Content-Type\` header value. Should be specified if using a \`fileBody\` that is neither \`Blob\` nor \`File\` nor \`FormData\`, otherwise will default to \`text/plain;charset=UTF-8\`." - } - }, - { - "name": "duplex", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." - } - }, - { - "name": "headers", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Optionally add extra headers" - } - }, - { - "name": "metadata", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." - } - }, - { - "name": "upsert", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional file upload options including cacheControl, contentType, upsert, and metadata." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "fullPath", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "id", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Uploads a file to an existing bucket.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: only \`insert\` when you are uploading new files and \`select\`, \`insert\` and \`update\` when you are upserting files\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\\n- For React Native, using either \`Blob\`, \`File\` or \`FormData\` does not work as intended. Upload file using \`ArrayBuffer\` from base64 file data instead, see example below.", - "examples": [ - { - "id": "upload-file", - "name": "Upload file", - "code": "\`\`\`js\\nconst avatarFile = event.target.files[0]\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .upload('public/avatar1.png', avatarFile, {\\n cacheControl: '3600',\\n upsert: false\\n })\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"path\\": \\"public/avatar1.png\\",\\n \\"fullPath\\": \\"avatars/public/avatar1.png\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - }, - { - "id": "upload-file-using-arraybuffer-from-base64-file-data", - "name": "Upload file using \`ArrayBuffer\` from base64 file data", - "code": "\`\`\`js\\nimport { decode } from 'base64-arraybuffer'\\n\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .upload('public/avatar1.png', decode('base64FileData'), {\\n contentType: 'image/png'\\n })\\n\`\`\`" - }, - { - "id": "handling-errors", - "name": "Handling errors", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .upload('public/avatar1.png', avatarFile)\\n\\nif (error) {\\n // Log the full error so fields like \`statusCode\` and \`error\` (the\\n // Storage error name, e.g. \\"Duplicate\\") aren't hidden behind \`error.message\`.\\n console.error(error)\\n return\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageFileApi.default.uploadToSignedUrl": { - "name": "@supabase/storage-js.packages/StorageFileApi.default.uploadToSignedUrl", - "params": [ - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The file path, including the file name. Should be of the format \`folder/subfolder/filename.png\`. The bucket must already exist before attempting to upload." - } - }, - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The token generated from \`createSignedUploadUrl\`" - } - }, - { - "name": "fileBody", - "type": { - "type": "nameOnly", - "name": "FileBody" - }, - "comment": { - "shortText": "The body of the file to be stored in the bucket." - } - }, - { - "name": "fileOptions", - "type": { - "type": "object", - "name": "FileOptions", - "properties": [ - { - "name": "cacheControl", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the \`Cache-Control: max-age=\` header. Defaults to 3600 seconds." - } - }, - { - "name": "contentType", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "the \`Content-Type\` header value. Should be specified if using a \`fileBody\` that is neither \`Blob\` nor \`File\` nor \`FormData\`, otherwise will default to \`text/plain;charset=UTF-8\`." - } - }, - { - "name": "duplex", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." - } - }, - { - "name": "headers", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Optionally add extra headers" - } - }, - { - "name": "metadata", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." - } - }, - { - "name": "upsert", - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "isOptional": true, - "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "HTTP headers (cacheControl, contentType, etc.).\\n**Note:** The \`upsert\` option has no effect here. To enable upsert behavior,\\npass \`{ upsert: true }\` when calling \`createSignedUploadUrl()\` instead." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "fullPath", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "path", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Upload a file with a token generated from \`createSignedUploadUrl\`.", - "text": "- RLS policy permissions required:\\n - \`buckets\` table permissions: none\\n - \`objects\` table permissions: none\\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works", - "examples": [ - { - "id": "upload-to-a-signed-url", - "name": "Upload to a signed URL", - "code": "\`\`\`js\\nconst { data, error } = await supabase\\n .storage\\n .from('avatars')\\n .uploadToSignedUrl('folder/cat.jpg', 'token-from-createSignedUploadUrl', file)\\n\`\`\`", - "response": "\`\`\`json\\n{\\n \\"data\\": {\\n \\"path\\": \\"folder/cat.jpg\\",\\n \\"fullPath\\": \\"avatars/folder/cat.jpg\\"\\n },\\n \\"error\\": null\\n}\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.constructor": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Base URL of the Storage Vectors REST API." - } - }, - { - "name": "options", - "type": { - "type": "object", - "name": "StorageVectorsClientOptions", - "properties": [ - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true, - "comment": { - "shortText": "Custom fetch implementation (optional)\\nUseful for testing or custom request handling", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ] - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Custom headers to include in all requests", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ] - } - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "StorageVectorsClient" - } - }, - "comment": { - "shortText": "Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`typescript\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`typescript\\nimport { StorageVectorsClient } from '@supabase/storage-js'\\n\\nconst client = new StorageVectorsClient(url, options)\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.createBucket": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.createBucket", - "params": [ - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique name for the vector bucket" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new vector bucket\\nVector buckets are containers for vector indexes and their data\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "creating-a-vector-bucket", - "name": "Creating a vector bucket", - "code": "\`\`\`typescript\\nconst { data, error } = await supabase\\n .storage\\n .vectors\\n .createBucket('embeddings-prod')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.deleteBucket": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.deleteBucket", - "params": [ - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the vector bucket to delete" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes a vector bucket (bucket must be empty)\\nAll indexes must be deleted before deleting the bucket\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "delete-a-vector-bucket", - "name": "Delete a vector bucket", - "code": "\`\`\`typescript\\nconst { data, error } = await supabase\\n .storage\\n .vectors\\n .deleteBucket('embeddings-old')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.from": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.from", - "params": [ - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the vector bucket" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "VectorBucketScope" - } - }, - "comment": { - "shortText": "Access operations for a specific vector bucket\\nReturns a scoped client for index and vector operations within the bucket\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "accessing-a-vector-bucket", - "name": "Accessing a vector bucket", - "code": "\`\`\`typescript\\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.getBucket": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.getBucket", - "params": [ - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the vector bucket" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "vectorBucket", - "type": { - "type": "object", - "name": "VectorBucket", - "properties": [ - { - "name": "creationTime", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Unix timestamp of when the bucket was created" - } - }, - { - "name": "encryptionConfiguration", - "type": { - "type": "object", - "name": "EncryptionConfiguration", - "properties": [ - { - "name": "kmsKeyArn", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "ARN of the KMS key used for encryption" - } - }, - { - "name": "sseType", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Server-side encryption type (e.g., 'KMS')" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Optional encryption settings" - } - }, - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique name of the vector bucket" - } - } - ] - } - } - ] - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves metadata for a specific vector bucket\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "get-bucket-metadata", - "name": "Get bucket metadata", - "code": "\`\`\`typescript\\nconst { data, error } = await supabase\\n .storage\\n .vectors\\n .getBucket('embeddings-prod')\\n\\nconsole.log('Bucket created:', data?.vectorBucket.creationTime)\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.listBuckets": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.listBuckets", - "params": [ - { - "name": "options", - "type": { - "type": "object", - "name": "ListVectorBucketsOptions", - "properties": [ - { - "name": "maxResults", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Maximum number of results to return (default: 100)" - } - }, - { - "name": "nextToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Token for pagination from previous response" - } - }, - { - "name": "prefix", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Filter buckets by name prefix" - } - } - ] - }, - "comment": { - "shortText": "Optional filters (prefix, maxResults, nextToken)" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "ListVectorBucketsResponse", - "properties": [ - { - "name": "nextToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Token for fetching next page (if more results exist)" - } - }, - { - "name": "vectorBuckets", - "type": { - "type": "array", - "elemType": { - "type": "object", - "properties": [ - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "comment": { - "shortText": "Array of bucket names" - } - } - ] - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists all vector buckets with optional filtering and pagination\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "list-vector-buckets", - "name": "List vector buckets", - "code": "\`\`\`typescript\\nconst { data, error } = await supabase\\n .storage\\n .vectors\\n .listBuckets({ prefix: 'embeddings-' })\\n\\ndata?.vectorBuckets.forEach(bucket => {\\n console.log(bucket.vectorBucketName)\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.setHeader": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header name" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header value" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request.\\nCreates a shallow copy of headers to avoid mutating shared state.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.throwOnError": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.throwOnError", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Enable throwing errors instead of returning them.\\nWhen enabled, errors are thrown instead of returned in { data, error } format.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.constructor": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "VectorBucketScope" - } - }, - "comment": { - "shortText": "Creates a helper that automatically scopes all index operations to the provided bucket.\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "creating-a-vector-bucket-scope", - "name": "Creating a vector bucket scope", - "code": "\`\`\`typescript\\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.createIndex": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.createIndex", - "params": [ - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "Omit" - }, - "comment": { - "shortText": "Index configuration (vectorBucketName is automatically set)" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Creates a new vector index in this bucket\\nConvenience method that automatically includes the bucket name\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "creating-a-vector-index", - "name": "Creating a vector index", - "code": "\`\`\`typescript\\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\\nawait bucket.createIndex({\\n indexName: 'documents-openai',\\n dataType: 'float32',\\n dimension: 1536,\\n distanceMetric: 'cosine',\\n metadataConfiguration: {\\n nonFilterableMetadataKeys: ['raw_text']\\n }\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.deleteIndex": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.deleteIndex", - "params": [ - { - "name": "indexName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the index to delete" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes an index from this bucket\\nConvenience method that automatically includes the bucket name\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "delete-an-index", - "name": "Delete an index", - "code": "\`\`\`typescript\\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\\nawait bucket.deleteIndex('old-index')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.getIndex": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.getIndex", - "params": [ - { - "name": "indexName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the index to retrieve" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "properties": [ - { - "name": "index", - "type": { - "type": "object", - "name": "VectorIndex", - "properties": [ - { - "name": "creationTime", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Unix timestamp of when the index was created" - } - }, - { - "name": "dataType", - "type": { - "type": "union", - "name": "VectorDataType", - "subTypes": [ - { - "type": "literal", - "value": "float32" - }, - null - ] - }, - "comment": { - "shortText": "Data type of vector components (currently only 'float32')" - } - }, - { - "name": "dimension", - "type": { - "type": "intrinsic", - "name": "number" - }, - "comment": { - "shortText": "Dimensionality of vectors (e.g., 384, 768, 1536)" - } - }, - { - "name": "distanceMetric", - "type": { - "type": "union", - "name": "DistanceMetric", - "subTypes": [ - { - "type": "literal", - "value": "cosine" - }, - { - "type": "literal", - "value": "euclidean" - }, - { - "type": "literal", - "value": "dotproduct" - }, - null - ] - }, - "comment": { - "shortText": "Similarity metric used for queries" - } - }, - { - "name": "indexName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique name of the index within the bucket" - } - }, - { - "name": "metadataConfiguration", - "type": { - "type": "object", - "name": "MetadataConfiguration", - "properties": [ - { - "name": "nonFilterableMetadataKeys", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Array of metadata keys that cannot be used in filters" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Configuration for metadata filtering" - } - }, - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the parent vector bucket" - } - } - ] - } - } - ] - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves metadata for a specific index in this bucket\\nConvenience method that automatically includes the bucket name\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "get-index-metadata", - "name": "Get index metadata", - "code": "\`\`\`typescript\\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\\nconst { data } = await bucket.getIndex('documents-openai')\\nconsole.log('Dimension:', data?.index.dimension)\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope", - "params": [ - { - "name": "indexName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Name of the index" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "VectorIndexScope" - } - }, - "comment": { - "shortText": "Access operations for a specific index within this bucket\\nReturns a scoped client for vector data operations\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "accessing-an-index", - "name": "Accessing an index", - "code": "\`\`\`typescript\\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\\n\\n// Insert vectors\\nawait index.putVectors({\\n vectors: [\\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\\n ]\\n})\\n\\n// Query similar vectors\\nconst { data } = await index.queryVectors({\\n queryVector: { float32: [...] },\\n topK: 5\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.listIndexes": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.listIndexes", - "params": [ - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "Omit" - }, - "comment": { - "shortText": "Listing options (vectorBucketName is automatically set)" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "ListIndexesResponse", - "properties": [ - { - "name": "indexes", - "type": { - "type": "array", - "elemType": { - "type": "object", - "properties": [ - { - "name": "indexName", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "comment": { - "shortText": "Array of index names" - } - }, - { - "name": "nextToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Token for fetching next page (if more results exist)" - } - } - ] - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists indexes in this bucket\\nConvenience method that automatically includes the bucket name\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "list-indexes", - "name": "List indexes", - "code": "\`\`\`typescript\\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\\nconst { data } = await bucket.listIndexes({ prefix: 'documents-' })\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.setHeader": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header name" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header value" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request.\\nCreates a shallow copy of headers to avoid mutating shared state.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.throwOnError": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.throwOnError", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Enable throwing errors instead of returning them.\\nWhen enabled, errors are thrown instead of returned in { data, error } format.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.constructor": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "name": "vectorBucketName", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "indexName", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "fetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "VectorIndexScope" - } - }, - "comment": { - "shortText": "Creates a helper that automatically scopes all vector operations to the provided bucket/index names.\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "creating-a-vector-index-scope", - "name": "Creating a vector index scope", - "code": "\`\`\`typescript\\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.deleteVectors": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.deleteVectors", - "params": [ - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "Omit" - }, - "comment": { - "shortText": "Deletion options (bucket and index names automatically set)" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Deletes vectors by keys from this index\\nConvenience method that automatically includes bucket and index names\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "delete-vectors-by-keys", - "name": "Delete vectors by keys", - "code": "\`\`\`typescript\\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\\nawait index.deleteVectors({\\n keys: ['doc-1', 'doc-2', 'doc-3']\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.getVectors": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.getVectors", - "params": [ - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "Omit" - }, - "comment": { - "shortText": "Vector retrieval options (bucket and index names automatically set)" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "GetVectorsResponse", - "properties": [ - { - "name": "vectors", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "VectorMatch", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "VectorData", - "properties": [ - { - "name": "float32", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "number" - } - }, - "comment": { - "shortText": "Array of 32-bit floating point numbers" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Vector embedding data (if requested)" - } - }, - { - "name": "distance", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Similarity distance from query vector (if requested)" - } - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the vector" - } - }, - { - "name": "metadata", - "type": { - "type": "record", - "name": "VectorMetadata", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Arbitrary metadata (if requested)" - } - } - ] - } - }, - "comment": { - "shortText": "Array of retrieved vector objects" - } - } - ] - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Retrieves vectors by keys from this index\\nConvenience method that automatically includes bucket and index names\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "get-vectors-by-keys", - "name": "Get vectors by keys", - "code": "\`\`\`typescript\\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\\nconst { data } = await index.getVectors({\\n keys: ['doc-1', 'doc-2'],\\n returnMetadata: true\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.listVectors": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.listVectors", - "params": [ - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "Omit" - }, - "comment": { - "shortText": "Listing options (bucket and index names automatically set)" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "ListVectorsResponse", - "properties": [ - { - "name": "nextToken", - "type": { - "type": "intrinsic", - "name": "string" - }, - "isOptional": true, - "comment": { - "shortText": "Token for fetching next page (if more results exist)" - } - }, - { - "name": "vectors", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "VectorMatch", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "VectorData", - "properties": [ - { - "name": "float32", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "number" - } - }, - "comment": { - "shortText": "Array of 32-bit floating point numbers" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Vector embedding data (if requested)" - } - }, - { - "name": "distance", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Similarity distance from query vector (if requested)" - } - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the vector" - } - }, - { - "name": "metadata", - "type": { - "type": "record", - "name": "VectorMetadata", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Arbitrary metadata (if requested)" - } - } - ] - } - }, - "comment": { - "shortText": "Array of vector objects" - } - } - ] - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Lists vectors in this index with pagination\\nConvenience method that automatically includes bucket and index names\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "list-vectors-with-pagination", - "name": "List vectors with pagination", - "code": "\`\`\`typescript\\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\\nconst { data } = await index.listVectors({\\n maxResults: 500,\\n returnMetadata: true\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.putVectors": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.putVectors", - "params": [ - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "Omit" - }, - "comment": { - "shortText": "Vector insertion options (bucket and index names automatically set)" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "intrinsic", - "name": "undefined" - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Inserts or updates vectors in this index\\nConvenience method that automatically includes bucket and index names\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "insert-vectors-into-an-index", - "name": "Insert vectors into an index", - "code": "\`\`\`typescript\\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\\nawait index.putVectors({\\n vectors: [\\n {\\n key: 'doc-1',\\n data: { float32: [0.1, 0.2, ...] },\\n metadata: { title: 'Introduction', page: 1 }\\n }\\n ]\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.queryVectors": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.queryVectors", - "params": [ - { - "name": "options", - "type": { - "type": "nameOnly", - "name": "Omit" - }, - "comment": { - "shortText": "Query options (bucket and index names automatically set)" - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "ApiResponse", - "subTypes": [ - { - "type": "object", - "name": "SuccessResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "QueryVectorsResponse", - "properties": [ - { - "name": "distanceMetric", - "type": { - "type": "union", - "name": "DistanceMetric", - "subTypes": [ - { - "type": "literal", - "value": "cosine" - }, - { - "type": "literal", - "value": "euclidean" - }, - { - "type": "literal", - "value": "dotproduct" - }, - null - ] - }, - "isOptional": true, - "comment": { - "shortText": "The distance metric used for the similarity search" - } - }, - { - "name": "vectors", - "type": { - "type": "array", - "elemType": { - "type": "object", - "name": "VectorMatch", - "properties": [ - { - "name": "data", - "type": { - "type": "object", - "name": "VectorData", - "properties": [ - { - "name": "float32", - "type": { - "type": "array", - "elemType": { - "type": "intrinsic", - "name": "number" - } - }, - "comment": { - "shortText": "Array of 32-bit floating point numbers" - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "Vector embedding data (if requested)" - } - }, - { - "name": "distance", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "Similarity distance from query vector (if requested)" - } - }, - { - "name": "key", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Unique identifier for the vector" - } - }, - { - "name": "metadata", - "type": { - "type": "record", - "name": "VectorMetadata", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - "isOptional": true, - "comment": { - "shortText": "Arbitrary metadata (if requested)" - } - } - ] - } - }, - "comment": { - "shortText": "Array of similar vectors ordered by distance" - } - } - ] - }, - "comment": { - "shortText": "Response data of type T" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on success" - } - } - ] - }, - { - "type": "object", - "name": "ErrorResponse", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - }, - "comment": { - "shortText": "Null on error" - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - }, - "comment": { - "shortText": "StorageError with details (named StorageVectorsError for vector operations)" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Queries for similar vectors in this index\\nConvenience method that automatically includes bucket and index names\\n\\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ], - "examples": [ - { - "id": "query-similar-vectors", - "name": "Query similar vectors", - "code": "\`\`\`typescript\\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\\nconst { data } = await index.queryVectors({\\n queryVector: { float32: [0.1, 0.2, ...] },\\n topK: 5,\\n filter: { category: 'technical' },\\n returnDistance: true,\\n returnMetadata: true\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.setHeader": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.setHeader", - "params": [ - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header name" - } - }, - { - "name": "value", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "Header value" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Set an HTTP header for the request.\\nCreates a shallow copy of headers to avoid mutating shared state.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ] - } - }, - "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.throwOnError": { - "name": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.throwOnError", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "this" - } - }, - "comment": { - "shortText": "Enable throwing errors instead of returning them.\\nWhen enabled, errors are thrown instead of returned in { data, error } format.", - "tags": [ - { - "tag": "alpha", - "text": "" - } - ] - } - }, - "@supabase/storage-js.packages/StreamDownloadBuilder.default.constructor": { - "name": "@supabase/storage-js.packages/StreamDownloadBuilder.default.constructor", - "params": [ - { - "name": "downloadFn", - "type": { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - } - } - }, - { - "name": "shouldThrowOnError", - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "default" - } - } - }, - "@supabase/storage-js.packages/StreamDownloadBuilder.default.catch": { - "name": "@supabase/storage-js.packages/StreamDownloadBuilder.default.catch", - "params": [ - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "union", - "name": "DownloadResult", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "ReadableStream" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - }, - { - "type": "nameOnly", - "name": "TResult" - } - ] - } - } - }, - "comment": { - "shortText": "Attaches a callback for only the rejection of the Promise." - } - }, - "@supabase/storage-js.packages/StreamDownloadBuilder.default.finally": { - "name": "@supabase/storage-js.packages/StreamDownloadBuilder.default.finally", - "params": [ - { - "name": "onfinally", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is settled (fulfilled or rejected)." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "DownloadResult", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "ReadableStream" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - }, - "comment": { - "shortText": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\\nresolved value cannot be modified from the callback." - } - }, - "@supabase/storage-js.packages/StreamDownloadBuilder.default.then": { - "name": "@supabase/storage-js.packages/StreamDownloadBuilder.default.then", - "params": [ - { - "name": "onfulfilled", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "value", - "type": { - "type": "union", - "name": "DownloadResult", - "subTypes": [ - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "nameOnly", - "name": "ReadableStream" - } - }, - { - "name": "error", - "type": { - "type": "literal", - "value": null - } - } - ] - }, - { - "type": "object", - "properties": [ - { - "name": "data", - "type": { - "type": "literal", - "value": null - } - }, - { - "name": "error", - "type": { - "type": "nameOnly", - "name": "StorageError" - } - } - ] - } - ] - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is resolved." - } - }, - { - "name": "onrejected", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": null - }, - { - "type": "function", - "params": [ - { - "name": "reason", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult2" - }, - { - "type": "nameOnly", - "name": "PromiseLike" - } - ] - } - } - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The callback to execute when the Promise is rejected." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "TResult1" - }, - { - "type": "nameOnly", - "name": "TResult2" - } - ] - } - } - }, - "comment": { - "shortText": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - } - }, - "variables": {} - }, - { - "name": "@supabase/functions-js", - "methods": { - "@supabase/functions-js.FunctionsClient.constructor": { - "name": "@supabase/functions-js.FunctionsClient.constructor", - "params": [ - { - "name": "url", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": { - "type": "object", - "properties": [ - { - "name": "customFetch", - "type": { - "type": "function", - "params": [ - { - "name": "input", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "RequestInfo" - }, - { - "type": "nameOnly", - "name": "URL" - } - ] - } - }, - { - "name": "init", - "type": { - "type": "nameOnly", - "name": "RequestInit" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "nameOnly", - "name": "Response" - } - } - }, - "comment": { - "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - }, - "isOptional": true - }, - { - "name": "headers", - "type": { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true - }, - { - "name": "region", - "type": { - "type": "nameOnly", - "name": "FunctionRegion" - }, - "isOptional": true - } - ] - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsClient" - } - }, - "comment": { - "shortText": "Creates a new Functions client bound to an Edge Functions URL.", - "examples": [ - { - "id": "using-supabase-js-recommended", - "name": "Using supabase-js (recommended)", - "code": "\`\`\`ts\\nimport { createClient } from '@supabase/supabase-js'\\n\\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\\nconst { data, error } = await supabase.functions.invoke('hello-world')\\n\`\`\`" - }, - { - "id": "standalone-import-for-bundle-sensitive-environments", - "name": "Standalone import for bundle-sensitive environments", - "code": "\`\`\`ts\\nimport { FunctionsClient, FunctionRegion } from '@supabase/functions-js'\\n\\nconst functions = new FunctionsClient('https://xyzcompany.supabase.co/functions/v1', {\\n headers: { apikey: 'your-publishable-key' },\\n region: FunctionRegion.UsEast1,\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/functions-js.FunctionsClient.invoke": { - "name": "@supabase/functions-js.FunctionsClient.invoke", - "params": [ - { - "name": "functionName", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "The name of the Function to invoke." - } - }, - { - "name": "options", - "type": { - "name": "FunctionInvokeOptions", - "type": "object", - "properties": [ - { - "name": "body", - "type": { - "type": "union", - "subTypes": [ - { - "type": "nameOnly", - "name": "File" - }, - { - "type": "nameOnly", - "name": "Blob" - }, - { - "type": "nameOnly", - "name": "ArrayBuffer" - }, - { - "type": "nameOnly", - "name": "FormData" - }, - { - "type": "nameOnly", - "name": "ReadableStream" - }, - { - "type": "record", - "name": "Record", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "any" - } - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The body of the request." - } - }, - { - "name": "headers", - "type": { - "type": "index signature", - "keyType": { - "type": "intrinsic", - "name": "string" - }, - "valueType": { - "type": "intrinsic", - "name": "string" - } - }, - "isOptional": true, - "comment": { - "shortText": "Object representing the headers to send with the request." - } - }, - { - "name": "method", - "type": { - "type": "union", - "subTypes": [ - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "isOptional": true, - "comment": { - "shortText": "The HTTP verb of the request" - } - }, - { - "name": "region", - "type": { - "type": "nameOnly", - "name": "FunctionRegion" - }, - "isOptional": true, - "comment": { - "shortText": "The Region to invoke the function in." - } - }, - { - "name": "signal", - "type": { - "type": "nameOnly", - "name": "AbortSignal" - }, - "isOptional": true, - "comment": { - "shortText": "The AbortSignal to use for the request." - } - }, - { - "name": "timeout", - "type": { - "type": "intrinsic", - "name": "number" - }, - "isOptional": true, - "comment": { - "shortText": "The timeout for the request in milliseconds.\\nIf the function takes longer than this, the request will be aborted." - } - } - ] - }, - "comment": { - "shortText": "Options for invoking the Function." - } - } - ], - "ret": { - "type": { - "type": "promise", - "name": "Promise", - "awaited": { - "type": "union", - "name": "FunctionsResponse", - "subTypes": [ - { - "type": "nameOnly", - "name": "FunctionsResponseSuccess" - }, - { - "type": "nameOnly", - "name": "FunctionsResponseFailure" - } - ] - } - } - }, - "comment": { - "shortText": "Invokes a function", - "text": "- Requires an Authorization header.\\n- Invoke params generally match the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) spec.\\n- When you pass in a body to your function, we automatically attach the Content-Type header for \`Blob\`, \`ArrayBuffer\`, \`File\`, \`FormData\` and \`String\`. If it doesn't match any of these types we assume the payload is \`json\`, serialize it and attach the \`Content-Type\` header as \`application/json\`. You can override this behavior by passing in a \`Content-Type\` header of your own.\\n- Responses are automatically parsed as \`json\`, \`blob\` and \`form-data\` depending on the \`Content-Type\` header sent by your function. Responses are parsed as \`text\` by default.", - "examples": [ - { - "id": "example-1", - "name": "Example 1", - "code": "\`\`\`ts\\nconst { data, error } = await functions.invoke('hello-world', {\\n body: { name: 'Ada' },\\n})\\n\`\`\`" - }, - { - "id": "basic-invocation", - "name": "Basic invocation", - "code": "\`\`\`js\\nconst { data, error } = await supabase.functions.invoke('hello', {\\n body: { foo: 'bar' }\\n})\\n\`\`\`" - }, - { - "id": "error-handling", - "name": "Error handling", - "code": "\`\`\`js\\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \\"@supabase/supabase-js\\";\\n\\nconst { data, error } = await supabase.functions.invoke('hello', {\\n headers: {\\n \\"my-custom-header\\": 'my-custom-header-value'\\n },\\n body: { foo: 'bar' }\\n})\\n\\nif (error instanceof FunctionsHttpError) {\\n const errorMessage = await error.context.json()\\n console.error('Function returned an error', errorMessage)\\n} else if (error instanceof FunctionsRelayError) {\\n console.error('Relay error:', error)\\n} else if (error instanceof FunctionsFetchError) {\\n console.error('Fetch error:', error)\\n}\\n\`\`\`", - "description": "A \`FunctionsHttpError\` error is returned if your function throws an error, \`FunctionsRelayError\` if the Supabase Relay has an error processing your function and \`FunctionsFetchError\` if there is a network error in calling your function. Log the full error object so fields like \`name\`, \`context\`, and any structured body aren't hidden." - }, - { - "id": "passing-custom-headers", - "name": "Passing custom headers", - "code": "\`\`\`js\\nconst { data, error } = await supabase.functions.invoke('hello', {\\n headers: {\\n \\"my-custom-header\\": 'my-custom-header-value'\\n },\\n body: { foo: 'bar' }\\n})\\n\`\`\`", - "description": "You can pass custom headers to your function. Note: supabase-js automatically passes the \`Authorization\` header with the signed in user's JWT." - }, - { - "id": "calling-with-delete-http-verb", - "name": "Calling with DELETE HTTP verb", - "code": "\`\`\`js\\nconst { data, error } = await supabase.functions.invoke('hello', {\\n headers: {\\n \\"my-custom-header\\": 'my-custom-header-value'\\n },\\n body: { foo: 'bar' },\\n method: 'DELETE'\\n})\\n\`\`\`", - "description": "You can also set the HTTP verb to \`DELETE\` when calling your Edge Function." - }, - { - "id": "invoking-a-function-in-the-useast1-region", - "name": "Invoking a Function in the UsEast1 region", - "code": "\`\`\`js\\nimport { createClient, FunctionRegion } from '@supabase/supabase-js'\\n\\nconst { data, error } = await supabase.functions.invoke('hello', {\\n body: { foo: 'bar' },\\n region: FunctionRegion.UsEast1\\n})\\n\`\`\`", - "description": "Here are the available regions:\\n- \`FunctionRegion.Any\`\\n- \`FunctionRegion.ApNortheast1\`\\n- \`FunctionRegion.ApNortheast2\`\\n- \`FunctionRegion.ApSouth1\`\\n- \`FunctionRegion.ApSoutheast1\`\\n- \`FunctionRegion.ApSoutheast2\`\\n- \`FunctionRegion.CaCentral1\`\\n- \`FunctionRegion.EuCentral1\`\\n- \`FunctionRegion.EuWest1\`\\n- \`FunctionRegion.EuWest2\`\\n- \`FunctionRegion.EuWest3\`\\n- \`FunctionRegion.SaEast1\`\\n- \`FunctionRegion.UsEast1\`\\n- \`FunctionRegion.UsWest1\`\\n- \`FunctionRegion.UsWest2\`" - }, - { - "id": "calling-with-get-http-verb", - "name": "Calling with GET HTTP verb", - "code": "\`\`\`js\\nconst { data, error } = await supabase.functions.invoke('hello', {\\n headers: {\\n \\"my-custom-header\\": 'my-custom-header-value'\\n },\\n method: 'GET'\\n})\\n\`\`\`", - "description": "You can also set the HTTP verb to \`GET\` when calling your Edge Function." - }, - { - "id": "standalone-client-invoke", - "name": "Standalone client invoke", - "code": "\`\`\`ts\\nconst { data, error } = await functions.invoke('hello-world', {\\n body: { name: 'Ada' },\\n})\\n\`\`\`" - } - ] - } - }, - "@supabase/functions-js.FunctionsClient.setAuth": { - "name": "@supabase/functions-js.FunctionsClient.setAuth", - "params": [ - { - "name": "token", - "type": { - "type": "intrinsic", - "name": "string" - }, - "comment": { - "shortText": "the new jwt token sent in the authorisation header" - } - } - ], - "ret": { - "type": { - "type": "intrinsic", - "name": "void" - } - }, - "comment": { - "shortText": "Updates the authorization header", - "examples": [ - { - "id": "setting-the-authorization-header", - "name": "Setting the authorization header", - "code": "\`\`\`ts\\nfunctions.setAuth(session.access_token)\\n\`\`\`" - } - ] - } - }, - "@supabase/functions-js.FunctionsError.constructor": { - "name": "@supabase/functions-js.FunctionsError.constructor", - "params": [ - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - }, - "isOptional": true - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsError" - } - } - }, - "@supabase/functions-js.FunctionsError.toJSON": { - "name": "@supabase/functions-js.FunctionsError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/functions-js.FunctionsFetchError.constructor": { - "name": "@supabase/functions-js.FunctionsFetchError.constructor", - "params": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsFetchError" - } - } - }, - "@supabase/functions-js.FunctionsFetchError.toJSON": { - "name": "@supabase/functions-js.FunctionsFetchError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/functions-js.FunctionsHttpError.constructor": { - "name": "@supabase/functions-js.FunctionsHttpError.constructor", - "params": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsHttpError" - } - } - }, - "@supabase/functions-js.FunctionsHttpError.toJSON": { - "name": "@supabase/functions-js.FunctionsHttpError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - "@supabase/functions-js.FunctionsRelayError.constructor": { - "name": "@supabase/functions-js.FunctionsRelayError.constructor", - "params": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "ret": { - "type": { - "type": "nameOnly", - "name": "FunctionsRelayError" - } - } - }, - "@supabase/functions-js.FunctionsRelayError.toJSON": { - "name": "@supabase/functions-js.FunctionsRelayError.toJSON", - "params": [], - "ret": { - "type": { - "type": "object", - "properties": [ - { - "name": "context", - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "name": "message", - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "name": "name", - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - }, - "variables": {} - } -]" -`; diff --git a/apps/docs/package.json b/apps/docs/package.json index 52c2550659e..eb7450ad900 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -13,6 +13,8 @@ "clean": "rimraf .next .turbo node_modules features/docs/generated examples __generated__", "codegen:examples": "shx cp -r ../../examples ./examples", "codegen:graphql": "tsx --conditions=react-server ./scripts/graphqlSchema.ts && graphql-codegen --config codegen.ts", + "codegen:references:ensure": "test -f spec/reference/javascript/v2/supabase.json || (cd spec && make download.tsdoc.v2)", + "codegen:references:new": "pnpm run codegen:references:ensure && tsx scripts/build-reference-content.ts", "codegen:references": "tsx features/docs/Reference.generated.script.ts", "codemod:frontmatter": "node ./scripts/codemod/mdx-meta.mjs && prettier --cache --write \"content/**/*.mdx\"", "dev": "concurrently --kill-others \"next dev --port 3001\" \"pnpm run dev:watch:troubleshooting\"", @@ -27,8 +29,8 @@ "lint": "eslint .", "lint:mdx": "supa-mdx-lint content --config ../../supa-mdx-lint.config.toml", "postbuild": "pnpm run build:sitemap && pnpm run build:llms && ./../../scripts/upload-static-assets.sh", - "prebuild": "pnpm run codegen:graphql && pnpm run codegen:references && pnpm run codegen:examples && pnpm run build:guides-markdown && pnpm run build:gz-archive", - "predev": "pnpm run codegen:graphql && pnpm run codegen:references && pnpm run codegen:examples", + "prebuild": "pnpm run codegen:graphql && pnpm run codegen:references && pnpm run codegen:references:new && pnpm run codegen:examples && pnpm run build:guides-markdown && pnpm run build:gz-archive", + "predev": "pnpm run codegen:graphql && pnpm run codegen:references && pnpm run codegen:references:new && pnpm run codegen:examples", "preembeddings": "pnpm run codegen:references", "preinstall": "npx only-allow pnpm", "presync": "pnpm run codegen:graphql", diff --git a/apps/docs/scripts/__snapshots__/build-reference-content.test.ts.snap b/apps/docs/scripts/__snapshots__/build-reference-content.test.ts.snap new file mode 100644 index 00000000000..6e8a295b385 --- /dev/null +++ b/apps/docs/scripts/__snapshots__/build-reference-content.test.ts.snap @@ -0,0 +1,27316 @@ +// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html + +exports[`build-reference-content — javascript/v2 > matches snapshot 1`] = ` +{ + "bySlug": { + "analytics-buckets": { + "id": "analytics-buckets", + "slug": "analytics-buckets", + "title": "Analytics Buckets", + "type": "function", + }, + "analytics-buckets-createbucket": { + "id": "analytics-buckets-createbucket", + "product": "storage", + "slug": "analytics-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + "analytics-buckets-deletebucket": { + "id": "analytics-buckets-deletebucket", + "product": "storage", + "slug": "analytics-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + "analytics-buckets-from": { + "id": "analytics-buckets-from", + "product": "storage", + "slug": "analytics-buckets-from", + "title": "from", + "type": "function", + }, + "analytics-buckets-listbuckets": { + "id": "analytics-buckets-listbuckets", + "product": "storage", + "slug": "analytics-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + "auth": { + "id": "auth", + "slug": "auth", + "title": "Overview", + "type": "function", + }, + "auth-admin": { + "id": "auth-admin", + "slug": "auth-admin", + "title": "Overview", + "type": "function", + }, + "auth-admin-createprovider": { + "id": "auth-admin-createprovider", + "product": "auth", + "slug": "auth-admin-createprovider", + "title": "createProvider", + "type": "function", + }, + "auth-admin-createuser": { + "id": "auth-admin-createuser", + "product": "auth", + "slug": "auth-admin-createuser", + "title": "createUser", + "type": "function", + }, + "auth-admin-deletefactor": { + "id": "auth-admin-deletefactor", + "product": "auth", + "slug": "auth-admin-deletefactor", + "title": "deleteFactor", + "type": "function", + }, + "auth-admin-deleteprovider": { + "id": "auth-admin-deleteprovider", + "product": "auth", + "slug": "auth-admin-deleteprovider", + "title": "deleteProvider", + "type": "function", + }, + "auth-admin-deleteuser": { + "id": "auth-admin-deleteuser", + "product": "auth", + "slug": "auth-admin-deleteuser", + "title": "deleteUser", + "type": "function", + }, + "auth-admin-generatelink": { + "id": "auth-admin-generatelink", + "product": "auth", + "slug": "auth-admin-generatelink", + "title": "generateLink", + "type": "function", + }, + "auth-admin-getprovider": { + "id": "auth-admin-getprovider", + "product": "auth", + "slug": "auth-admin-getprovider", + "title": "getProvider", + "type": "function", + }, + "auth-admin-getuserbyid": { + "id": "auth-admin-getuserbyid", + "product": "auth", + "slug": "auth-admin-getuserbyid", + "title": "getUserById", + "type": "function", + }, + "auth-admin-inviteuserbyemail": { + "id": "auth-admin-inviteuserbyemail", + "product": "auth", + "slug": "auth-admin-inviteuserbyemail", + "title": "inviteUserByEmail", + "type": "function", + }, + "auth-admin-listfactors": { + "id": "auth-admin-listfactors", + "product": "auth", + "slug": "auth-admin-listfactors", + "title": "listFactors", + "type": "function", + }, + "auth-admin-listproviders": { + "id": "auth-admin-listproviders", + "product": "auth", + "slug": "auth-admin-listproviders", + "title": "listProviders", + "type": "function", + }, + "auth-admin-listusers": { + "id": "auth-admin-listusers", + "product": "auth", + "slug": "auth-admin-listusers", + "title": "listUsers", + "type": "function", + }, + "auth-admin-signout": { + "id": "auth-admin-signout", + "product": "auth", + "slug": "auth-admin-signout", + "title": "signOut", + "type": "function", + }, + "auth-admin-updateprovider": { + "id": "auth-admin-updateprovider", + "product": "auth", + "slug": "auth-admin-updateprovider", + "title": "updateProvider", + "type": "function", + }, + "auth-admin-updateuserbyid": { + "id": "auth-admin-updateuserbyid", + "product": "auth", + "slug": "auth-admin-updateuserbyid", + "title": "updateUserById", + "type": "function", + }, + "auth-dispose": { + "id": "auth-dispose", + "product": "auth", + "slug": "auth-dispose", + "title": "dispose", + "type": "function", + }, + "auth-exchangecodeforsession": { + "id": "auth-exchangecodeforsession", + "product": "auth", + "slug": "auth-exchangecodeforsession", + "title": "exchangeCodeForSession", + "type": "function", + }, + "auth-getclaims": { + "id": "auth-getclaims", + "product": "auth", + "slug": "auth-getclaims", + "title": "getClaims", + "type": "function", + }, + "auth-getsession": { + "id": "auth-getsession", + "product": "auth", + "slug": "auth-getsession", + "title": "getSession", + "type": "function", + }, + "auth-getuser": { + "id": "auth-getuser", + "product": "auth", + "slug": "auth-getuser", + "title": "getUser", + "type": "function", + }, + "auth-getuseridentities": { + "id": "auth-getuseridentities", + "product": "auth", + "slug": "auth-getuseridentities", + "title": "getUserIdentities", + "type": "function", + }, + "auth-initialize": { + "id": "auth-initialize", + "product": "auth", + "slug": "auth-initialize", + "title": "initialize", + "type": "function", + }, + "auth-linkidentity": { + "id": "auth-linkidentity", + "product": "auth", + "slug": "auth-linkidentity", + "title": "linkIdentity", + "type": "function", + }, + "auth-mfa": { + "id": "auth-mfa", + "slug": "auth-mfa", + "title": "Auth MFA", + "type": "function", + }, + "auth-mfa-challenge": { + "id": "auth-mfa-challenge", + "product": "auth", + "slug": "auth-mfa-challenge", + "title": "challenge", + "type": "function", + }, + "auth-mfa-challengeandverify": { + "id": "auth-mfa-challengeandverify", + "product": "auth", + "slug": "auth-mfa-challengeandverify", + "title": "challengeAndVerify", + "type": "function", + }, + "auth-mfa-enroll": { + "id": "auth-mfa-enroll", + "product": "auth", + "slug": "auth-mfa-enroll", + "title": "enroll", + "type": "function", + }, + "auth-mfa-getauthenticatorassurancelevel": { + "id": "auth-mfa-getauthenticatorassurancelevel", + "product": "auth", + "slug": "auth-mfa-getauthenticatorassurancelevel", + "title": "getAuthenticatorAssuranceLevel", + "type": "function", + }, + "auth-mfa-listfactors": { + "id": "auth-mfa-listfactors", + "product": "auth", + "slug": "auth-mfa-listfactors", + "title": "listFactors", + "type": "function", + }, + "auth-mfa-unenroll": { + "id": "auth-mfa-unenroll", + "product": "auth", + "slug": "auth-mfa-unenroll", + "title": "unenroll", + "type": "function", + }, + "auth-mfa-verify": { + "id": "auth-mfa-verify", + "product": "auth", + "slug": "auth-mfa-verify", + "title": "verify", + "type": "function", + }, + "auth-onauthstatechange": { + "id": "auth-onauthstatechange", + "product": "auth", + "slug": "auth-onauthstatechange", + "title": "onAuthStateChange", + "type": "function", + }, + "auth-passkey": { + "id": "auth-passkey", + "slug": "auth-passkey", + "title": "Auth Passkey", + "type": "function", + }, + "auth-passkey-delete": { + "id": "auth-passkey-delete", + "product": "auth", + "slug": "auth-passkey-delete", + "title": "delete", + "type": "function", + }, + "auth-passkey-list": { + "id": "auth-passkey-list", + "product": "auth", + "slug": "auth-passkey-list", + "title": "list", + "type": "function", + }, + "auth-passkey-startauthentication": { + "id": "auth-passkey-startauthentication", + "product": "auth", + "slug": "auth-passkey-startauthentication", + "title": "startAuthentication", + "type": "function", + }, + "auth-passkey-startregistration": { + "id": "auth-passkey-startregistration", + "product": "auth", + "slug": "auth-passkey-startregistration", + "title": "startRegistration", + "type": "function", + }, + "auth-passkey-update": { + "id": "auth-passkey-update", + "product": "auth", + "slug": "auth-passkey-update", + "title": "update", + "type": "function", + }, + "auth-passkey-verifyauthentication": { + "id": "auth-passkey-verifyauthentication", + "product": "auth", + "slug": "auth-passkey-verifyauthentication", + "title": "verifyAuthentication", + "type": "function", + }, + "auth-passkey-verifyregistration": { + "id": "auth-passkey-verifyregistration", + "product": "auth", + "slug": "auth-passkey-verifyregistration", + "title": "verifyRegistration", + "type": "function", + }, + "auth-reauthenticate": { + "id": "auth-reauthenticate", + "product": "auth", + "slug": "auth-reauthenticate", + "title": "reauthenticate", + "type": "function", + }, + "auth-refreshsession": { + "id": "auth-refreshsession", + "product": "auth", + "slug": "auth-refreshsession", + "title": "refreshSession", + "type": "function", + }, + "auth-registerpasskey": { + "id": "auth-registerpasskey", + "product": "auth", + "slug": "auth-registerpasskey", + "title": "registerPasskey", + "type": "function", + }, + "auth-resend": { + "id": "auth-resend", + "product": "auth", + "slug": "auth-resend", + "title": "resend", + "type": "function", + }, + "auth-resetpasswordforemail": { + "id": "auth-resetpasswordforemail", + "product": "auth", + "slug": "auth-resetpasswordforemail", + "title": "resetPasswordForEmail", + "type": "function", + }, + "auth-setsession": { + "id": "auth-setsession", + "product": "auth", + "slug": "auth-setsession", + "title": "setSession", + "type": "function", + }, + "auth-signinanonymously": { + "id": "auth-signinanonymously", + "product": "auth", + "slug": "auth-signinanonymously", + "title": "signInAnonymously", + "type": "function", + }, + "auth-signinwithidtoken": { + "id": "auth-signinwithidtoken", + "product": "auth", + "slug": "auth-signinwithidtoken", + "title": "signInWithIdToken", + "type": "function", + }, + "auth-signinwithoauth": { + "id": "auth-signinwithoauth", + "product": "auth", + "slug": "auth-signinwithoauth", + "title": "signInWithOAuth", + "type": "function", + }, + "auth-signinwithotp": { + "id": "auth-signinwithotp", + "product": "auth", + "slug": "auth-signinwithotp", + "title": "signInWithOtp", + "type": "function", + }, + "auth-signinwithpasskey": { + "id": "auth-signinwithpasskey", + "product": "auth", + "slug": "auth-signinwithpasskey", + "title": "signInWithPasskey", + "type": "function", + }, + "auth-signinwithpassword": { + "id": "auth-signinwithpassword", + "product": "auth", + "slug": "auth-signinwithpassword", + "title": "signInWithPassword", + "type": "function", + }, + "auth-signinwithsso": { + "id": "auth-signinwithsso", + "product": "auth", + "slug": "auth-signinwithsso", + "title": "signInWithSSO", + "type": "function", + }, + "auth-signinwithweb3": { + "id": "auth-signinwithweb3", + "product": "auth", + "slug": "auth-signinwithweb3", + "title": "signInWithWeb3", + "type": "function", + }, + "auth-signout": { + "id": "auth-signout", + "product": "auth", + "slug": "auth-signout", + "title": "signOut", + "type": "function", + }, + "auth-signup": { + "id": "auth-signup", + "product": "auth", + "slug": "auth-signup", + "title": "signUp", + "type": "function", + }, + "auth-startautorefresh": { + "id": "auth-startautorefresh", + "product": "auth", + "slug": "auth-startautorefresh", + "title": "startAutoRefresh", + "type": "function", + }, + "auth-stopautorefresh": { + "id": "auth-stopautorefresh", + "product": "auth", + "slug": "auth-stopautorefresh", + "title": "stopAutoRefresh", + "type": "function", + }, + "auth-unlinkidentity": { + "id": "auth-unlinkidentity", + "product": "auth", + "slug": "auth-unlinkidentity", + "title": "unlinkIdentity", + "type": "function", + }, + "auth-updateuser": { + "id": "auth-updateuser", + "product": "auth", + "slug": "auth-updateuser", + "title": "updateUser", + "type": "function", + }, + "auth-verifyotp": { + "id": "auth-verifyotp", + "product": "auth", + "slug": "auth-verifyotp", + "title": "verifyOtp", + "type": "function", + }, + "channel": { + "id": "channel", + "product": "realtime", + "slug": "channel", + "title": "channel", + "type": "function", + }, + "connect": { + "id": "connect", + "product": "realtime", + "slug": "connect", + "title": "connect", + "type": "function", + }, + "connectionstate": { + "id": "connectionstate", + "product": "realtime", + "slug": "connectionstate", + "title": "connectionState", + "type": "function", + }, + "database": { + "title": "Database", + "type": "category", + }, + "delete": { + "id": "delete", + "product": "database", + "slug": "delete", + "title": "delete", + "type": "function", + }, + "disconnect": { + "id": "disconnect", + "product": "realtime", + "slug": "disconnect", + "title": "disconnect", + "type": "function", + }, + "endpointurl": { + "id": "endpointurl", + "product": "realtime", + "slug": "endpointurl", + "title": "endpointURL", + "type": "function", + }, + "file-buckets": { + "id": "file-buckets", + "slug": "file-buckets", + "title": "File Buckets", + "type": "function", + }, + "file-buckets-copy": { + "id": "file-buckets-copy", + "product": "storage", + "slug": "file-buckets-copy", + "title": "copy", + "type": "function", + }, + "file-buckets-createbucket": { + "id": "file-buckets-createbucket", + "product": "storage", + "slug": "file-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + "file-buckets-createsigneduploadurl": { + "id": "file-buckets-createsigneduploadurl", + "product": "storage", + "slug": "file-buckets-createsigneduploadurl", + "title": "createSignedUploadUrl", + "type": "function", + }, + "file-buckets-createsignedurl": { + "id": "file-buckets-createsignedurl", + "product": "storage", + "slug": "file-buckets-createsignedurl", + "title": "createSignedUrl", + "type": "function", + }, + "file-buckets-createsignedurls": { + "id": "file-buckets-createsignedurls", + "product": "storage", + "slug": "file-buckets-createsignedurls", + "title": "createSignedUrls", + "type": "function", + }, + "file-buckets-deletebucket": { + "id": "file-buckets-deletebucket", + "product": "storage", + "slug": "file-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + "file-buckets-download": { + "id": "file-buckets-download", + "product": "storage", + "slug": "file-buckets-download", + "title": "download", + "type": "function", + }, + "file-buckets-emptybucket": { + "id": "file-buckets-emptybucket", + "product": "storage", + "slug": "file-buckets-emptybucket", + "title": "emptyBucket", + "type": "function", + }, + "file-buckets-exists": { + "id": "file-buckets-exists", + "product": "storage", + "slug": "file-buckets-exists", + "title": "exists", + "type": "function", + }, + "file-buckets-from": { + "id": "file-buckets-from", + "product": "storage", + "slug": "file-buckets-from", + "title": "from", + "type": "function", + }, + "file-buckets-getbucket": { + "id": "file-buckets-getbucket", + "product": "storage", + "slug": "file-buckets-getbucket", + "title": "getBucket", + "type": "function", + }, + "file-buckets-getpublicurl": { + "id": "file-buckets-getpublicurl", + "product": "storage", + "slug": "file-buckets-getpublicurl", + "title": "getPublicUrl", + "type": "function", + }, + "file-buckets-info": { + "id": "file-buckets-info", + "product": "storage", + "slug": "file-buckets-info", + "title": "info", + "type": "function", + }, + "file-buckets-list": { + "id": "file-buckets-list", + "product": "storage", + "slug": "file-buckets-list", + "title": "list", + "type": "function", + }, + "file-buckets-listbuckets": { + "id": "file-buckets-listbuckets", + "product": "storage", + "slug": "file-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + "file-buckets-listv2": { + "id": "file-buckets-listv2", + "product": "storage", + "slug": "file-buckets-listv2", + "title": "listV2", + "type": "function", + }, + "file-buckets-move": { + "id": "file-buckets-move", + "product": "storage", + "slug": "file-buckets-move", + "title": "move", + "type": "function", + }, + "file-buckets-remove": { + "id": "file-buckets-remove", + "product": "storage", + "slug": "file-buckets-remove", + "title": "remove", + "type": "function", + }, + "file-buckets-update": { + "id": "file-buckets-update", + "product": "storage", + "slug": "file-buckets-update", + "title": "update", + "type": "function", + }, + "file-buckets-updatebucket": { + "id": "file-buckets-updatebucket", + "product": "storage", + "slug": "file-buckets-updatebucket", + "title": "updateBucket", + "type": "function", + }, + "file-buckets-upload": { + "id": "file-buckets-upload", + "product": "storage", + "slug": "file-buckets-upload", + "title": "upload", + "type": "function", + }, + "file-buckets-uploadtosignedurl": { + "id": "file-buckets-uploadtosignedurl", + "product": "storage", + "slug": "file-buckets-uploadtosignedurl", + "title": "uploadToSignedUrl", + "type": "function", + }, + "from": { + "id": "from", + "product": "database", + "slug": "from", + "title": "from", + "type": "function", + }, + "functions": { + "title": "Edge Functions", + "type": "category", + }, + "functions-corsheaders": { + "id": "functions-corsheaders", + "product": "edge-functions", + "slug": "functions-corsheaders", + "title": "corsHeaders", + "type": "function", + }, + "functions-invoke": { + "id": "functions-invoke", + "product": "edge-functions", + "slug": "functions-invoke", + "title": "invoke", + "type": "function", + }, + "functions-setauth": { + "id": "functions-setauth", + "product": "edge-functions", + "slug": "functions-setauth", + "title": "setAuth", + "type": "function", + }, + "geojson": { + "id": "geojson", + "product": "database", + "slug": "geojson", + "title": "geojson", + "type": "function", + }, + "getchannels": { + "id": "getchannels", + "product": "realtime", + "slug": "getchannels", + "title": "getChannels", + "type": "function", + }, + "getwebsocketconstructor": { + "id": "getwebsocketconstructor", + "product": "realtime", + "slug": "getwebsocketconstructor", + "title": "getWebSocketConstructor", + "type": "function", + }, + "httpsend": { + "id": "httpsend", + "product": "realtime", + "slug": "httpsend", + "title": "httpSend", + "type": "function", + }, + "initializing": { + "id": "initializing", + "slug": "initializing", + "title": "Initializing", + "type": "function", + }, + "insert": { + "id": "insert", + "product": "database", + "slug": "insert", + "title": "insert", + "type": "function", + }, + "installing": { + "id": "installing", + "slug": "installing", + "title": "Installing", + "type": "markdown", + }, + "introduction": { + "id": "introduction", + "slug": "introduction", + "title": "Introduction", + "type": "markdown", + }, + "isconnected": { + "id": "isconnected", + "product": "realtime", + "slug": "isconnected", + "title": "isConnected", + "type": "function", + }, + "isconnecting": { + "id": "isconnecting", + "product": "realtime", + "slug": "isconnecting", + "title": "isConnecting", + "type": "function", + }, + "isdisconnecting": { + "id": "isdisconnecting", + "product": "realtime", + "slug": "isdisconnecting", + "title": "isDisconnecting", + "type": "function", + }, + "iswebsocketsupported": { + "id": "iswebsocketsupported", + "product": "realtime", + "slug": "iswebsocketsupported", + "title": "isWebSocketSupported", + "type": "function", + }, + "log": { + "id": "log", + "product": "realtime", + "slug": "log", + "title": "log", + "type": "function", + }, + "maxaffected": { + "id": "maxaffected", + "product": "database", + "slug": "maxaffected", + "title": "maxAffected", + "type": "function", + }, + "oauth-admin": { + "id": "oauth-admin", + "slug": "oauth-admin", + "title": "OAuth Admin", + "type": "function", + }, + "oauth-admin-createclient": { + "id": "oauth-admin-createclient", + "product": "auth", + "slug": "oauth-admin-createclient", + "title": "createClient", + "type": "function", + }, + "oauth-admin-deleteclient": { + "id": "oauth-admin-deleteclient", + "product": "auth", + "slug": "oauth-admin-deleteclient", + "title": "deleteClient", + "type": "function", + }, + "oauth-admin-getclient": { + "id": "oauth-admin-getclient", + "product": "auth", + "slug": "oauth-admin-getclient", + "title": "getClient", + "type": "function", + }, + "oauth-admin-listclients": { + "id": "oauth-admin-listclients", + "product": "auth", + "slug": "oauth-admin-listclients", + "title": "listClients", + "type": "function", + }, + "oauth-admin-regenerateclientsecret": { + "id": "oauth-admin-regenerateclientsecret", + "product": "auth", + "slug": "oauth-admin-regenerateclientsecret", + "title": "regenerateClientSecret", + "type": "function", + }, + "oauth-admin-updateclient": { + "id": "oauth-admin-updateclient", + "product": "auth", + "slug": "oauth-admin-updateclient", + "title": "updateClient", + "type": "function", + }, + "oauth-server": { + "id": "oauth-server", + "slug": "oauth-server", + "title": "OAuth Server", + "type": "function", + }, + "oauth-server-approveauthorization": { + "id": "oauth-server-approveauthorization", + "product": "auth", + "slug": "oauth-server-approveauthorization", + "title": "approveAuthorization", + "type": "function", + }, + "oauth-server-denyauthorization": { + "id": "oauth-server-denyauthorization", + "product": "auth", + "slug": "oauth-server-denyauthorization", + "title": "denyAuthorization", + "type": "function", + }, + "oauth-server-getauthorizationdetails": { + "id": "oauth-server-getauthorizationdetails", + "product": "auth", + "slug": "oauth-server-getauthorizationdetails", + "title": "getAuthorizationDetails", + "type": "function", + }, + "oauth-server-listgrants": { + "id": "oauth-server-listgrants", + "product": "auth", + "slug": "oauth-server-listgrants", + "title": "listGrants", + "type": "function", + }, + "oauth-server-revokegrant": { + "id": "oauth-server-revokegrant", + "product": "auth", + "slug": "oauth-server-revokegrant", + "title": "revokeGrant", + "type": "function", + }, + "on": { + "id": "on", + "product": "realtime", + "slug": "on", + "title": "on", + "type": "function", + }, + "onheartbeat": { + "id": "onheartbeat", + "product": "realtime", + "slug": "onheartbeat", + "title": "onHeartbeat", + "type": "function", + }, + "passkey-admin": { + "id": "passkey-admin", + "slug": "passkey-admin", + "title": "Passkey admin", + "type": "function", + }, + "passkey-admin-deletepasskey": { + "id": "passkey-admin-deletepasskey", + "product": "auth", + "slug": "passkey-admin-deletepasskey", + "title": "deletePasskey", + "type": "function", + }, + "passkey-admin-listpasskeys": { + "id": "passkey-admin-listpasskeys", + "product": "auth", + "slug": "passkey-admin-listpasskeys", + "title": "listPasskeys", + "type": "function", + }, + "presencestate": { + "id": "presencestate", + "product": "realtime", + "slug": "presencestate", + "title": "presenceState", + "type": "function", + }, + "push": { + "id": "push", + "product": "realtime", + "slug": "push", + "title": "push", + "type": "function", + }, + "realtime": { + "title": "Realtime", + "type": "category", + }, + "removeallchannels": { + "id": "removeallchannels", + "product": "realtime", + "slug": "removeallchannels", + "title": "removeAllChannels", + "type": "function", + }, + "removechannel": { + "id": "removechannel", + "product": "realtime", + "slug": "removechannel", + "title": "removeChannel", + "type": "function", + }, + "retry": { + "id": "retry", + "product": "database", + "slug": "retry", + "title": "retry", + "type": "function", + }, + "returns": { + "id": "returns", + "product": "database", + "slug": "returns", + "title": "returns", + "type": "function", + }, + "rollback": { + "id": "rollback", + "product": "database", + "slug": "rollback", + "title": "rollback", + "type": "function", + }, + "rpc": { + "id": "rpc", + "product": "database", + "slug": "rpc", + "title": "rpc", + "type": "function", + }, + "schema": { + "id": "schema", + "product": "database", + "slug": "schema", + "title": "schema", + "type": "function", + }, + "select": { + "id": "select", + "product": "database", + "slug": "select", + "title": "select", + "type": "function", + }, + "send": { + "id": "send", + "product": "realtime", + "slug": "send", + "title": "send", + "type": "function", + }, + "sendheartbeat": { + "id": "sendheartbeat", + "product": "realtime", + "slug": "sendheartbeat", + "title": "sendHeartbeat", + "type": "function", + }, + "setauth": { + "id": "setauth", + "product": "realtime", + "slug": "setauth", + "title": "setAuth", + "type": "function", + }, + "setheader": { + "id": "setheader", + "product": "database", + "slug": "setheader", + "title": "setHeader", + "type": "function", + }, + "storage": { + "title": "Storage", + "type": "category", + }, + "subscribe": { + "id": "subscribe", + "product": "realtime", + "slug": "subscribe", + "title": "subscribe", + "type": "function", + }, + "teardown": { + "id": "teardown", + "product": "realtime", + "slug": "teardown", + "title": "teardown", + "type": "function", + }, + "throwonerror": { + "id": "throwonerror", + "product": "database", + "slug": "throwonerror", + "title": "throwOnError", + "type": "function", + }, + "track": { + "id": "track", + "product": "realtime", + "slug": "track", + "title": "track", + "type": "function", + }, + "typescript-support": { + "id": "typescript-support", + "slug": "typescript-support", + "title": "TypeScript support", + "type": "markdown", + }, + "unsubscribe": { + "id": "unsubscribe", + "product": "realtime", + "slug": "unsubscribe", + "title": "unsubscribe", + "type": "function", + }, + "untrack": { + "id": "untrack", + "product": "realtime", + "slug": "untrack", + "title": "untrack", + "type": "function", + }, + "update": { + "id": "update", + "product": "database", + "slug": "update", + "title": "update", + "type": "function", + }, + "updatejoinpayload": { + "id": "updatejoinpayload", + "product": "realtime", + "slug": "updatejoinpayload", + "title": "updateJoinPayload", + "type": "function", + }, + "upsert": { + "id": "upsert", + "product": "database", + "slug": "upsert", + "title": "upsert", + "type": "function", + }, + "using-filters": { + "id": "using-filters", + "slug": "using-filters", + "title": "Using Filters", + "type": "function", + }, + "using-filters-containedby": { + "id": "using-filters-containedby", + "product": "database", + "slug": "using-filters-containedby", + "title": "containedBy", + "type": "function", + }, + "using-filters-contains": { + "id": "using-filters-contains", + "product": "database", + "slug": "using-filters-contains", + "title": "contains", + "type": "function", + }, + "using-filters-eq": { + "id": "using-filters-eq", + "product": "database", + "slug": "using-filters-eq", + "title": "eq", + "type": "function", + }, + "using-filters-filter": { + "id": "using-filters-filter", + "product": "database", + "slug": "using-filters-filter", + "title": "filter", + "type": "function", + }, + "using-filters-gt": { + "id": "using-filters-gt", + "product": "database", + "slug": "using-filters-gt", + "title": "gt", + "type": "function", + }, + "using-filters-gte": { + "id": "using-filters-gte", + "product": "database", + "slug": "using-filters-gte", + "title": "gte", + "type": "function", + }, + "using-filters-ilike": { + "id": "using-filters-ilike", + "product": "database", + "slug": "using-filters-ilike", + "title": "ilike", + "type": "function", + }, + "using-filters-ilikeallof": { + "id": "using-filters-ilikeallof", + "product": "database", + "slug": "using-filters-ilikeallof", + "title": "ilikeAllOf", + "type": "function", + }, + "using-filters-ilikeanyof": { + "id": "using-filters-ilikeanyof", + "product": "database", + "slug": "using-filters-ilikeanyof", + "title": "ilikeAnyOf", + "type": "function", + }, + "using-filters-in": { + "id": "using-filters-in", + "product": "database", + "slug": "using-filters-in", + "title": "in", + "type": "function", + }, + "using-filters-is": { + "id": "using-filters-is", + "product": "database", + "slug": "using-filters-is", + "title": "is", + "type": "function", + }, + "using-filters-like": { + "id": "using-filters-like", + "product": "database", + "slug": "using-filters-like", + "title": "like", + "type": "function", + }, + "using-filters-likeallof": { + "id": "using-filters-likeallof", + "product": "database", + "slug": "using-filters-likeallof", + "title": "likeAllOf", + "type": "function", + }, + "using-filters-likeanyof": { + "id": "using-filters-likeanyof", + "product": "database", + "slug": "using-filters-likeanyof", + "title": "likeAnyOf", + "type": "function", + }, + "using-filters-lt": { + "id": "using-filters-lt", + "product": "database", + "slug": "using-filters-lt", + "title": "lt", + "type": "function", + }, + "using-filters-lte": { + "id": "using-filters-lte", + "product": "database", + "slug": "using-filters-lte", + "title": "lte", + "type": "function", + }, + "using-filters-match": { + "id": "using-filters-match", + "product": "database", + "slug": "using-filters-match", + "title": "match", + "type": "function", + }, + "using-filters-neq": { + "id": "using-filters-neq", + "product": "database", + "slug": "using-filters-neq", + "title": "neq", + "type": "function", + }, + "using-filters-not": { + "id": "using-filters-not", + "product": "database", + "slug": "using-filters-not", + "title": "not", + "type": "function", + }, + "using-filters-or": { + "id": "using-filters-or", + "product": "database", + "slug": "using-filters-or", + "title": "or", + "type": "function", + }, + "using-filters-overlaps": { + "id": "using-filters-overlaps", + "product": "database", + "slug": "using-filters-overlaps", + "title": "overlaps", + "type": "function", + }, + "using-filters-rangeadjacent": { + "id": "using-filters-rangeadjacent", + "product": "database", + "slug": "using-filters-rangeadjacent", + "title": "rangeAdjacent", + "type": "function", + }, + "using-filters-rangegt": { + "id": "using-filters-rangegt", + "product": "database", + "slug": "using-filters-rangegt", + "title": "rangeGt", + "type": "function", + }, + "using-filters-rangegte": { + "id": "using-filters-rangegte", + "product": "database", + "slug": "using-filters-rangegte", + "title": "rangeGte", + "type": "function", + }, + "using-filters-rangelt": { + "id": "using-filters-rangelt", + "product": "database", + "slug": "using-filters-rangelt", + "title": "rangeLt", + "type": "function", + }, + "using-filters-rangelte": { + "id": "using-filters-rangelte", + "product": "database", + "slug": "using-filters-rangelte", + "title": "rangeLte", + "type": "function", + }, + "using-filters-textsearch": { + "id": "using-filters-textsearch", + "product": "database", + "slug": "using-filters-textsearch", + "title": "textSearch", + "type": "function", + }, + "using-modifiers": { + "id": "using-modifiers", + "slug": "using-modifiers", + "title": "Using modifiers", + "type": "function", + }, + "using-modifiers-abortsignal": { + "id": "using-modifiers-abortsignal", + "product": "database", + "slug": "using-modifiers-abortsignal", + "title": "abortSignal", + "type": "function", + }, + "using-modifiers-csv": { + "id": "using-modifiers-csv", + "product": "database", + "slug": "using-modifiers-csv", + "title": "csv", + "type": "function", + }, + "using-modifiers-explain": { + "id": "using-modifiers-explain", + "product": "database", + "slug": "using-modifiers-explain", + "title": "explain", + "type": "function", + }, + "using-modifiers-limit": { + "id": "using-modifiers-limit", + "product": "database", + "slug": "using-modifiers-limit", + "title": "limit", + "type": "function", + }, + "using-modifiers-maybesingle": { + "id": "using-modifiers-maybesingle", + "product": "database", + "slug": "using-modifiers-maybesingle", + "title": "maybeSingle", + "type": "function", + }, + "using-modifiers-order": { + "id": "using-modifiers-order", + "product": "database", + "slug": "using-modifiers-order", + "title": "order", + "type": "function", + }, + "using-modifiers-overridetypes": { + "id": "using-modifiers-overridetypes", + "product": "database", + "slug": "using-modifiers-overridetypes", + "title": "overrideTypes", + "type": "function", + }, + "using-modifiers-range": { + "id": "using-modifiers-range", + "product": "database", + "slug": "using-modifiers-range", + "title": "range", + "type": "function", + }, + "using-modifiers-returns": { + "id": "using-modifiers-returns", + "product": "database", + "slug": "using-modifiers-returns", + "title": "returns", + "type": "function", + }, + "using-modifiers-select": { + "id": "using-modifiers-select", + "product": "database", + "slug": "using-modifiers-select", + "title": "select", + "type": "function", + }, + "using-modifiers-single": { + "id": "using-modifiers-single", + "product": "database", + "slug": "using-modifiers-single", + "title": "single", + "type": "function", + }, + "using-modifiers-stripnulls": { + "id": "using-modifiers-stripnulls", + "product": "database", + "slug": "using-modifiers-stripnulls", + "title": "stripNulls", + "type": "function", + }, + "vector-buckets": { + "id": "vector-buckets", + "slug": "vector-buckets", + "title": "Vector Buckets", + "type": "function", + }, + "vector-buckets-createbucket": { + "id": "vector-buckets-createbucket", + "product": "storage", + "slug": "vector-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + "vector-buckets-createindex": { + "id": "vector-buckets-createindex", + "product": "storage", + "slug": "vector-buckets-createindex", + "title": "createIndex", + "type": "function", + }, + "vector-buckets-deletebucket": { + "id": "vector-buckets-deletebucket", + "product": "storage", + "slug": "vector-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + "vector-buckets-deleteindex": { + "id": "vector-buckets-deleteindex", + "product": "storage", + "slug": "vector-buckets-deleteindex", + "title": "deleteIndex", + "type": "function", + }, + "vector-buckets-deletevectors": { + "id": "vector-buckets-deletevectors", + "product": "storage", + "slug": "vector-buckets-deletevectors", + "title": "deleteVectors", + "type": "function", + }, + "vector-buckets-from": { + "id": "vector-buckets-from", + "product": "storage", + "slug": "vector-buckets-from", + "title": "from", + "type": "function", + }, + "vector-buckets-getbucket": { + "id": "vector-buckets-getbucket", + "product": "storage", + "slug": "vector-buckets-getbucket", + "title": "getBucket", + "type": "function", + }, + "vector-buckets-getindex": { + "id": "vector-buckets-getindex", + "product": "storage", + "slug": "vector-buckets-getindex", + "title": "getIndex", + "type": "function", + }, + "vector-buckets-getvectors": { + "id": "vector-buckets-getvectors", + "product": "storage", + "slug": "vector-buckets-getvectors", + "title": "getVectors", + "type": "function", + }, + "vector-buckets-index": { + "id": "vector-buckets-index", + "product": "storage", + "slug": "vector-buckets-index", + "title": "index", + "type": "function", + }, + "vector-buckets-listbuckets": { + "id": "vector-buckets-listbuckets", + "product": "storage", + "slug": "vector-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + "vector-buckets-listindexes": { + "id": "vector-buckets-listindexes", + "product": "storage", + "slug": "vector-buckets-listindexes", + "title": "listIndexes", + "type": "function", + }, + "vector-buckets-listvectors": { + "id": "vector-buckets-listvectors", + "product": "storage", + "slug": "vector-buckets-listvectors", + "title": "listVectors", + "type": "function", + }, + "vector-buckets-putvectors": { + "id": "vector-buckets-putvectors", + "product": "storage", + "slug": "vector-buckets-putvectors", + "title": "putVectors", + "type": "function", + }, + "vector-buckets-queryvectors": { + "id": "vector-buckets-queryvectors", + "product": "storage", + "slug": "vector-buckets-queryvectors", + "title": "queryVectors", + "type": "function", + }, + }, + "flat": [ + { + "id": "introduction", + "slug": "introduction", + "title": "Introduction", + "type": "markdown", + }, + { + "id": "installing", + "slug": "installing", + "title": "Installing", + "type": "markdown", + }, + { + "id": "initializing", + "slug": "initializing", + "title": "Initializing", + "type": "function", + }, + { + "id": "typescript-support", + "slug": "typescript-support", + "title": "TypeScript support", + "type": "markdown", + }, + { + "title": "Database", + "type": "category", + }, + { + "id": "delete", + "product": "database", + "slug": "delete", + "title": "delete", + "type": "function", + }, + { + "id": "from", + "product": "database", + "slug": "from", + "title": "from", + "type": "function", + }, + { + "id": "geojson", + "product": "database", + "slug": "geojson", + "title": "geojson", + "type": "function", + }, + { + "id": "insert", + "product": "database", + "slug": "insert", + "title": "insert", + "type": "function", + }, + { + "id": "maxaffected", + "product": "database", + "slug": "maxaffected", + "title": "maxAffected", + "type": "function", + }, + { + "id": "retry", + "product": "database", + "slug": "retry", + "title": "retry", + "type": "function", + }, + { + "id": "returns", + "product": "database", + "slug": "returns", + "title": "returns", + "type": "function", + }, + { + "id": "rollback", + "product": "database", + "slug": "rollback", + "title": "rollback", + "type": "function", + }, + { + "id": "rpc", + "product": "database", + "slug": "rpc", + "title": "rpc", + "type": "function", + }, + { + "id": "schema", + "product": "database", + "slug": "schema", + "title": "schema", + "type": "function", + }, + { + "id": "select", + "product": "database", + "slug": "select", + "title": "select", + "type": "function", + }, + { + "id": "setheader", + "product": "database", + "slug": "setheader", + "title": "setHeader", + "type": "function", + }, + { + "id": "throwonerror", + "product": "database", + "slug": "throwonerror", + "title": "throwOnError", + "type": "function", + }, + { + "id": "update", + "product": "database", + "slug": "update", + "title": "update", + "type": "function", + }, + { + "id": "upsert", + "product": "database", + "slug": "upsert", + "title": "upsert", + "type": "function", + }, + { + "id": "using-filters", + "slug": "using-filters", + "title": "Using Filters", + "type": "function", + }, + { + "id": "using-filters-containedby", + "product": "database", + "slug": "using-filters-containedby", + "title": "containedBy", + "type": "function", + }, + { + "id": "using-filters-contains", + "product": "database", + "slug": "using-filters-contains", + "title": "contains", + "type": "function", + }, + { + "id": "using-filters-eq", + "product": "database", + "slug": "using-filters-eq", + "title": "eq", + "type": "function", + }, + { + "id": "using-filters-filter", + "product": "database", + "slug": "using-filters-filter", + "title": "filter", + "type": "function", + }, + { + "id": "using-filters-gt", + "product": "database", + "slug": "using-filters-gt", + "title": "gt", + "type": "function", + }, + { + "id": "using-filters-gte", + "product": "database", + "slug": "using-filters-gte", + "title": "gte", + "type": "function", + }, + { + "id": "using-filters-ilike", + "product": "database", + "slug": "using-filters-ilike", + "title": "ilike", + "type": "function", + }, + { + "id": "using-filters-ilikeallof", + "product": "database", + "slug": "using-filters-ilikeallof", + "title": "ilikeAllOf", + "type": "function", + }, + { + "id": "using-filters-ilikeanyof", + "product": "database", + "slug": "using-filters-ilikeanyof", + "title": "ilikeAnyOf", + "type": "function", + }, + { + "id": "using-filters-in", + "product": "database", + "slug": "using-filters-in", + "title": "in", + "type": "function", + }, + { + "id": "using-filters-is", + "product": "database", + "slug": "using-filters-is", + "title": "is", + "type": "function", + }, + { + "id": "using-filters-like", + "product": "database", + "slug": "using-filters-like", + "title": "like", + "type": "function", + }, + { + "id": "using-filters-likeallof", + "product": "database", + "slug": "using-filters-likeallof", + "title": "likeAllOf", + "type": "function", + }, + { + "id": "using-filters-likeanyof", + "product": "database", + "slug": "using-filters-likeanyof", + "title": "likeAnyOf", + "type": "function", + }, + { + "id": "using-filters-lt", + "product": "database", + "slug": "using-filters-lt", + "title": "lt", + "type": "function", + }, + { + "id": "using-filters-lte", + "product": "database", + "slug": "using-filters-lte", + "title": "lte", + "type": "function", + }, + { + "id": "using-filters-match", + "product": "database", + "slug": "using-filters-match", + "title": "match", + "type": "function", + }, + { + "id": "using-filters-neq", + "product": "database", + "slug": "using-filters-neq", + "title": "neq", + "type": "function", + }, + { + "id": "using-filters-not", + "product": "database", + "slug": "using-filters-not", + "title": "not", + "type": "function", + }, + { + "id": "using-filters-or", + "product": "database", + "slug": "using-filters-or", + "title": "or", + "type": "function", + }, + { + "id": "using-filters-overlaps", + "product": "database", + "slug": "using-filters-overlaps", + "title": "overlaps", + "type": "function", + }, + { + "id": "using-filters-rangeadjacent", + "product": "database", + "slug": "using-filters-rangeadjacent", + "title": "rangeAdjacent", + "type": "function", + }, + { + "id": "using-filters-rangegt", + "product": "database", + "slug": "using-filters-rangegt", + "title": "rangeGt", + "type": "function", + }, + { + "id": "using-filters-rangegte", + "product": "database", + "slug": "using-filters-rangegte", + "title": "rangeGte", + "type": "function", + }, + { + "id": "using-filters-rangelt", + "product": "database", + "slug": "using-filters-rangelt", + "title": "rangeLt", + "type": "function", + }, + { + "id": "using-filters-rangelte", + "product": "database", + "slug": "using-filters-rangelte", + "title": "rangeLte", + "type": "function", + }, + { + "id": "using-filters-textsearch", + "product": "database", + "slug": "using-filters-textsearch", + "title": "textSearch", + "type": "function", + }, + { + "id": "using-modifiers", + "slug": "using-modifiers", + "title": "Using modifiers", + "type": "function", + }, + { + "id": "using-modifiers-abortsignal", + "product": "database", + "slug": "using-modifiers-abortsignal", + "title": "abortSignal", + "type": "function", + }, + { + "id": "using-modifiers-csv", + "product": "database", + "slug": "using-modifiers-csv", + "title": "csv", + "type": "function", + }, + { + "id": "using-modifiers-explain", + "product": "database", + "slug": "using-modifiers-explain", + "title": "explain", + "type": "function", + }, + { + "id": "using-modifiers-limit", + "product": "database", + "slug": "using-modifiers-limit", + "title": "limit", + "type": "function", + }, + { + "id": "using-modifiers-maybesingle", + "product": "database", + "slug": "using-modifiers-maybesingle", + "title": "maybeSingle", + "type": "function", + }, + { + "id": "using-modifiers-order", + "product": "database", + "slug": "using-modifiers-order", + "title": "order", + "type": "function", + }, + { + "id": "using-modifiers-overridetypes", + "product": "database", + "slug": "using-modifiers-overridetypes", + "title": "overrideTypes", + "type": "function", + }, + { + "id": "using-modifiers-range", + "product": "database", + "slug": "using-modifiers-range", + "title": "range", + "type": "function", + }, + { + "id": "using-modifiers-returns", + "product": "database", + "slug": "using-modifiers-returns", + "title": "returns", + "type": "function", + }, + { + "id": "using-modifiers-select", + "product": "database", + "slug": "using-modifiers-select", + "title": "select", + "type": "function", + }, + { + "id": "using-modifiers-single", + "product": "database", + "slug": "using-modifiers-single", + "title": "single", + "type": "function", + }, + { + "id": "using-modifiers-stripnulls", + "product": "database", + "slug": "using-modifiers-stripnulls", + "title": "stripNulls", + "type": "function", + }, + { + "id": "auth", + "slug": "auth", + "title": "Overview", + "type": "function", + }, + { + "id": "auth-dispose", + "product": "auth", + "slug": "auth-dispose", + "title": "dispose", + "type": "function", + }, + { + "id": "auth-exchangecodeforsession", + "product": "auth", + "slug": "auth-exchangecodeforsession", + "title": "exchangeCodeForSession", + "type": "function", + }, + { + "id": "auth-getclaims", + "product": "auth", + "slug": "auth-getclaims", + "title": "getClaims", + "type": "function", + }, + { + "id": "auth-getsession", + "product": "auth", + "slug": "auth-getsession", + "title": "getSession", + "type": "function", + }, + { + "id": "auth-getuser", + "product": "auth", + "slug": "auth-getuser", + "title": "getUser", + "type": "function", + }, + { + "id": "auth-getuseridentities", + "product": "auth", + "slug": "auth-getuseridentities", + "title": "getUserIdentities", + "type": "function", + }, + { + "id": "auth-initialize", + "product": "auth", + "slug": "auth-initialize", + "title": "initialize", + "type": "function", + }, + { + "id": "auth-linkidentity", + "product": "auth", + "slug": "auth-linkidentity", + "title": "linkIdentity", + "type": "function", + }, + { + "id": "auth-onauthstatechange", + "product": "auth", + "slug": "auth-onauthstatechange", + "title": "onAuthStateChange", + "type": "function", + }, + { + "id": "auth-reauthenticate", + "product": "auth", + "slug": "auth-reauthenticate", + "title": "reauthenticate", + "type": "function", + }, + { + "id": "auth-refreshsession", + "product": "auth", + "slug": "auth-refreshsession", + "title": "refreshSession", + "type": "function", + }, + { + "id": "auth-registerpasskey", + "product": "auth", + "slug": "auth-registerpasskey", + "title": "registerPasskey", + "type": "function", + }, + { + "id": "auth-resend", + "product": "auth", + "slug": "auth-resend", + "title": "resend", + "type": "function", + }, + { + "id": "auth-resetpasswordforemail", + "product": "auth", + "slug": "auth-resetpasswordforemail", + "title": "resetPasswordForEmail", + "type": "function", + }, + { + "id": "auth-setsession", + "product": "auth", + "slug": "auth-setsession", + "title": "setSession", + "type": "function", + }, + { + "id": "auth-signinanonymously", + "product": "auth", + "slug": "auth-signinanonymously", + "title": "signInAnonymously", + "type": "function", + }, + { + "id": "auth-signinwithidtoken", + "product": "auth", + "slug": "auth-signinwithidtoken", + "title": "signInWithIdToken", + "type": "function", + }, + { + "id": "auth-signinwithoauth", + "product": "auth", + "slug": "auth-signinwithoauth", + "title": "signInWithOAuth", + "type": "function", + }, + { + "id": "auth-signinwithotp", + "product": "auth", + "slug": "auth-signinwithotp", + "title": "signInWithOtp", + "type": "function", + }, + { + "id": "auth-signinwithpasskey", + "product": "auth", + "slug": "auth-signinwithpasskey", + "title": "signInWithPasskey", + "type": "function", + }, + { + "id": "auth-signinwithpassword", + "product": "auth", + "slug": "auth-signinwithpassword", + "title": "signInWithPassword", + "type": "function", + }, + { + "id": "auth-signinwithsso", + "product": "auth", + "slug": "auth-signinwithsso", + "title": "signInWithSSO", + "type": "function", + }, + { + "id": "auth-signinwithweb3", + "product": "auth", + "slug": "auth-signinwithweb3", + "title": "signInWithWeb3", + "type": "function", + }, + { + "id": "auth-signout", + "product": "auth", + "slug": "auth-signout", + "title": "signOut", + "type": "function", + }, + { + "id": "auth-signup", + "product": "auth", + "slug": "auth-signup", + "title": "signUp", + "type": "function", + }, + { + "id": "auth-startautorefresh", + "product": "auth", + "slug": "auth-startautorefresh", + "title": "startAutoRefresh", + "type": "function", + }, + { + "id": "auth-stopautorefresh", + "product": "auth", + "slug": "auth-stopautorefresh", + "title": "stopAutoRefresh", + "type": "function", + }, + { + "id": "auth-unlinkidentity", + "product": "auth", + "slug": "auth-unlinkidentity", + "title": "unlinkIdentity", + "type": "function", + }, + { + "id": "auth-updateuser", + "product": "auth", + "slug": "auth-updateuser", + "title": "updateUser", + "type": "function", + }, + { + "id": "auth-verifyotp", + "product": "auth", + "slug": "auth-verifyotp", + "title": "verifyOtp", + "type": "function", + }, + { + "id": "auth-admin", + "slug": "auth-admin", + "title": "Overview", + "type": "function", + }, + { + "id": "auth-admin-createprovider", + "product": "auth", + "slug": "auth-admin-createprovider", + "title": "createProvider", + "type": "function", + }, + { + "id": "auth-admin-createuser", + "product": "auth", + "slug": "auth-admin-createuser", + "title": "createUser", + "type": "function", + }, + { + "id": "auth-admin-deletefactor", + "product": "auth", + "slug": "auth-admin-deletefactor", + "title": "deleteFactor", + "type": "function", + }, + { + "id": "auth-admin-deleteprovider", + "product": "auth", + "slug": "auth-admin-deleteprovider", + "title": "deleteProvider", + "type": "function", + }, + { + "id": "auth-admin-deleteuser", + "product": "auth", + "slug": "auth-admin-deleteuser", + "title": "deleteUser", + "type": "function", + }, + { + "id": "auth-admin-generatelink", + "product": "auth", + "slug": "auth-admin-generatelink", + "title": "generateLink", + "type": "function", + }, + { + "id": "auth-admin-getprovider", + "product": "auth", + "slug": "auth-admin-getprovider", + "title": "getProvider", + "type": "function", + }, + { + "id": "auth-admin-getuserbyid", + "product": "auth", + "slug": "auth-admin-getuserbyid", + "title": "getUserById", + "type": "function", + }, + { + "id": "auth-admin-inviteuserbyemail", + "product": "auth", + "slug": "auth-admin-inviteuserbyemail", + "title": "inviteUserByEmail", + "type": "function", + }, + { + "id": "auth-admin-listfactors", + "product": "auth", + "slug": "auth-admin-listfactors", + "title": "listFactors", + "type": "function", + }, + { + "id": "auth-admin-listproviders", + "product": "auth", + "slug": "auth-admin-listproviders", + "title": "listProviders", + "type": "function", + }, + { + "id": "auth-admin-listusers", + "product": "auth", + "slug": "auth-admin-listusers", + "title": "listUsers", + "type": "function", + }, + { + "id": "auth-admin-signout", + "product": "auth", + "slug": "auth-admin-signout", + "title": "signOut", + "type": "function", + }, + { + "id": "auth-admin-updateprovider", + "product": "auth", + "slug": "auth-admin-updateprovider", + "title": "updateProvider", + "type": "function", + }, + { + "id": "auth-admin-updateuserbyid", + "product": "auth", + "slug": "auth-admin-updateuserbyid", + "title": "updateUserById", + "type": "function", + }, + { + "id": "auth-mfa", + "slug": "auth-mfa", + "title": "Auth MFA", + "type": "function", + }, + { + "id": "auth-mfa-challenge", + "product": "auth", + "slug": "auth-mfa-challenge", + "title": "challenge", + "type": "function", + }, + { + "id": "auth-mfa-challengeandverify", + "product": "auth", + "slug": "auth-mfa-challengeandverify", + "title": "challengeAndVerify", + "type": "function", + }, + { + "id": "auth-mfa-enroll", + "product": "auth", + "slug": "auth-mfa-enroll", + "title": "enroll", + "type": "function", + }, + { + "id": "auth-mfa-getauthenticatorassurancelevel", + "product": "auth", + "slug": "auth-mfa-getauthenticatorassurancelevel", + "title": "getAuthenticatorAssuranceLevel", + "type": "function", + }, + { + "id": "auth-mfa-listfactors", + "product": "auth", + "slug": "auth-mfa-listfactors", + "title": "listFactors", + "type": "function", + }, + { + "id": "auth-mfa-unenroll", + "product": "auth", + "slug": "auth-mfa-unenroll", + "title": "unenroll", + "type": "function", + }, + { + "id": "auth-mfa-verify", + "product": "auth", + "slug": "auth-mfa-verify", + "title": "verify", + "type": "function", + }, + { + "id": "auth-passkey", + "slug": "auth-passkey", + "title": "Auth Passkey", + "type": "function", + }, + { + "id": "auth-passkey-delete", + "product": "auth", + "slug": "auth-passkey-delete", + "title": "delete", + "type": "function", + }, + { + "id": "auth-passkey-list", + "product": "auth", + "slug": "auth-passkey-list", + "title": "list", + "type": "function", + }, + { + "id": "auth-passkey-startauthentication", + "product": "auth", + "slug": "auth-passkey-startauthentication", + "title": "startAuthentication", + "type": "function", + }, + { + "id": "auth-passkey-startregistration", + "product": "auth", + "slug": "auth-passkey-startregistration", + "title": "startRegistration", + "type": "function", + }, + { + "id": "auth-passkey-update", + "product": "auth", + "slug": "auth-passkey-update", + "title": "update", + "type": "function", + }, + { + "id": "auth-passkey-verifyauthentication", + "product": "auth", + "slug": "auth-passkey-verifyauthentication", + "title": "verifyAuthentication", + "type": "function", + }, + { + "id": "auth-passkey-verifyregistration", + "product": "auth", + "slug": "auth-passkey-verifyregistration", + "title": "verifyRegistration", + "type": "function", + }, + { + "id": "oauth-admin", + "slug": "oauth-admin", + "title": "OAuth Admin", + "type": "function", + }, + { + "id": "oauth-admin-createclient", + "product": "auth", + "slug": "oauth-admin-createclient", + "title": "createClient", + "type": "function", + }, + { + "id": "oauth-admin-deleteclient", + "product": "auth", + "slug": "oauth-admin-deleteclient", + "title": "deleteClient", + "type": "function", + }, + { + "id": "oauth-admin-getclient", + "product": "auth", + "slug": "oauth-admin-getclient", + "title": "getClient", + "type": "function", + }, + { + "id": "oauth-admin-listclients", + "product": "auth", + "slug": "oauth-admin-listclients", + "title": "listClients", + "type": "function", + }, + { + "id": "oauth-admin-regenerateclientsecret", + "product": "auth", + "slug": "oauth-admin-regenerateclientsecret", + "title": "regenerateClientSecret", + "type": "function", + }, + { + "id": "oauth-admin-updateclient", + "product": "auth", + "slug": "oauth-admin-updateclient", + "title": "updateClient", + "type": "function", + }, + { + "id": "oauth-server", + "slug": "oauth-server", + "title": "OAuth Server", + "type": "function", + }, + { + "id": "oauth-server-approveauthorization", + "product": "auth", + "slug": "oauth-server-approveauthorization", + "title": "approveAuthorization", + "type": "function", + }, + { + "id": "oauth-server-denyauthorization", + "product": "auth", + "slug": "oauth-server-denyauthorization", + "title": "denyAuthorization", + "type": "function", + }, + { + "id": "oauth-server-getauthorizationdetails", + "product": "auth", + "slug": "oauth-server-getauthorizationdetails", + "title": "getAuthorizationDetails", + "type": "function", + }, + { + "id": "oauth-server-listgrants", + "product": "auth", + "slug": "oauth-server-listgrants", + "title": "listGrants", + "type": "function", + }, + { + "id": "oauth-server-revokegrant", + "product": "auth", + "slug": "oauth-server-revokegrant", + "title": "revokeGrant", + "type": "function", + }, + { + "id": "passkey-admin", + "slug": "passkey-admin", + "title": "Passkey admin", + "type": "function", + }, + { + "id": "passkey-admin-deletepasskey", + "product": "auth", + "slug": "passkey-admin-deletepasskey", + "title": "deletePasskey", + "type": "function", + }, + { + "id": "passkey-admin-listpasskeys", + "product": "auth", + "slug": "passkey-admin-listpasskeys", + "title": "listPasskeys", + "type": "function", + }, + { + "title": "Edge Functions", + "type": "category", + }, + { + "id": "functions-corsheaders", + "product": "edge-functions", + "slug": "functions-corsheaders", + "title": "corsHeaders", + "type": "function", + }, + { + "id": "functions-invoke", + "product": "edge-functions", + "slug": "functions-invoke", + "title": "invoke", + "type": "function", + }, + { + "id": "functions-setauth", + "product": "edge-functions", + "slug": "functions-setauth", + "title": "setAuth", + "type": "function", + }, + { + "title": "Realtime", + "type": "category", + }, + { + "id": "channel", + "product": "realtime", + "slug": "channel", + "title": "channel", + "type": "function", + }, + { + "id": "connect", + "product": "realtime", + "slug": "connect", + "title": "connect", + "type": "function", + }, + { + "id": "connectionstate", + "product": "realtime", + "slug": "connectionstate", + "title": "connectionState", + "type": "function", + }, + { + "id": "disconnect", + "product": "realtime", + "slug": "disconnect", + "title": "disconnect", + "type": "function", + }, + { + "id": "endpointurl", + "product": "realtime", + "slug": "endpointurl", + "title": "endpointURL", + "type": "function", + }, + { + "id": "getchannels", + "product": "realtime", + "slug": "getchannels", + "title": "getChannels", + "type": "function", + }, + { + "id": "getwebsocketconstructor", + "product": "realtime", + "slug": "getwebsocketconstructor", + "title": "getWebSocketConstructor", + "type": "function", + }, + { + "id": "httpsend", + "product": "realtime", + "slug": "httpsend", + "title": "httpSend", + "type": "function", + }, + { + "id": "isconnected", + "product": "realtime", + "slug": "isconnected", + "title": "isConnected", + "type": "function", + }, + { + "id": "isconnecting", + "product": "realtime", + "slug": "isconnecting", + "title": "isConnecting", + "type": "function", + }, + { + "id": "isdisconnecting", + "product": "realtime", + "slug": "isdisconnecting", + "title": "isDisconnecting", + "type": "function", + }, + { + "id": "iswebsocketsupported", + "product": "realtime", + "slug": "iswebsocketsupported", + "title": "isWebSocketSupported", + "type": "function", + }, + { + "id": "log", + "product": "realtime", + "slug": "log", + "title": "log", + "type": "function", + }, + { + "id": "on", + "product": "realtime", + "slug": "on", + "title": "on", + "type": "function", + }, + { + "id": "onheartbeat", + "product": "realtime", + "slug": "onheartbeat", + "title": "onHeartbeat", + "type": "function", + }, + { + "id": "presencestate", + "product": "realtime", + "slug": "presencestate", + "title": "presenceState", + "type": "function", + }, + { + "id": "push", + "product": "realtime", + "slug": "push", + "title": "push", + "type": "function", + }, + { + "id": "removeallchannels", + "product": "realtime", + "slug": "removeallchannels", + "title": "removeAllChannels", + "type": "function", + }, + { + "id": "removechannel", + "product": "realtime", + "slug": "removechannel", + "title": "removeChannel", + "type": "function", + }, + { + "id": "send", + "product": "realtime", + "slug": "send", + "title": "send", + "type": "function", + }, + { + "id": "sendheartbeat", + "product": "realtime", + "slug": "sendheartbeat", + "title": "sendHeartbeat", + "type": "function", + }, + { + "id": "setauth", + "product": "realtime", + "slug": "setauth", + "title": "setAuth", + "type": "function", + }, + { + "id": "subscribe", + "product": "realtime", + "slug": "subscribe", + "title": "subscribe", + "type": "function", + }, + { + "id": "teardown", + "product": "realtime", + "slug": "teardown", + "title": "teardown", + "type": "function", + }, + { + "id": "track", + "product": "realtime", + "slug": "track", + "title": "track", + "type": "function", + }, + { + "id": "unsubscribe", + "product": "realtime", + "slug": "unsubscribe", + "title": "unsubscribe", + "type": "function", + }, + { + "id": "untrack", + "product": "realtime", + "slug": "untrack", + "title": "untrack", + "type": "function", + }, + { + "id": "updatejoinpayload", + "product": "realtime", + "slug": "updatejoinpayload", + "title": "updateJoinPayload", + "type": "function", + }, + { + "title": "Storage", + "type": "category", + }, + { + "id": "analytics-buckets", + "slug": "analytics-buckets", + "title": "Analytics Buckets", + "type": "function", + }, + { + "id": "analytics-buckets-createbucket", + "product": "storage", + "slug": "analytics-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + { + "id": "analytics-buckets-deletebucket", + "product": "storage", + "slug": "analytics-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + { + "id": "analytics-buckets-from", + "product": "storage", + "slug": "analytics-buckets-from", + "title": "from", + "type": "function", + }, + { + "id": "analytics-buckets-listbuckets", + "product": "storage", + "slug": "analytics-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + { + "id": "file-buckets", + "slug": "file-buckets", + "title": "File Buckets", + "type": "function", + }, + { + "id": "file-buckets-copy", + "product": "storage", + "slug": "file-buckets-copy", + "title": "copy", + "type": "function", + }, + { + "id": "file-buckets-createbucket", + "product": "storage", + "slug": "file-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + { + "id": "file-buckets-createsigneduploadurl", + "product": "storage", + "slug": "file-buckets-createsigneduploadurl", + "title": "createSignedUploadUrl", + "type": "function", + }, + { + "id": "file-buckets-createsignedurl", + "product": "storage", + "slug": "file-buckets-createsignedurl", + "title": "createSignedUrl", + "type": "function", + }, + { + "id": "file-buckets-createsignedurls", + "product": "storage", + "slug": "file-buckets-createsignedurls", + "title": "createSignedUrls", + "type": "function", + }, + { + "id": "file-buckets-deletebucket", + "product": "storage", + "slug": "file-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + { + "id": "file-buckets-download", + "product": "storage", + "slug": "file-buckets-download", + "title": "download", + "type": "function", + }, + { + "id": "file-buckets-emptybucket", + "product": "storage", + "slug": "file-buckets-emptybucket", + "title": "emptyBucket", + "type": "function", + }, + { + "id": "file-buckets-exists", + "product": "storage", + "slug": "file-buckets-exists", + "title": "exists", + "type": "function", + }, + { + "id": "file-buckets-from", + "product": "storage", + "slug": "file-buckets-from", + "title": "from", + "type": "function", + }, + { + "id": "file-buckets-getbucket", + "product": "storage", + "slug": "file-buckets-getbucket", + "title": "getBucket", + "type": "function", + }, + { + "id": "file-buckets-getpublicurl", + "product": "storage", + "slug": "file-buckets-getpublicurl", + "title": "getPublicUrl", + "type": "function", + }, + { + "id": "file-buckets-info", + "product": "storage", + "slug": "file-buckets-info", + "title": "info", + "type": "function", + }, + { + "id": "file-buckets-list", + "product": "storage", + "slug": "file-buckets-list", + "title": "list", + "type": "function", + }, + { + "id": "file-buckets-listbuckets", + "product": "storage", + "slug": "file-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + { + "id": "file-buckets-listv2", + "product": "storage", + "slug": "file-buckets-listv2", + "title": "listV2", + "type": "function", + }, + { + "id": "file-buckets-move", + "product": "storage", + "slug": "file-buckets-move", + "title": "move", + "type": "function", + }, + { + "id": "file-buckets-remove", + "product": "storage", + "slug": "file-buckets-remove", + "title": "remove", + "type": "function", + }, + { + "id": "file-buckets-update", + "product": "storage", + "slug": "file-buckets-update", + "title": "update", + "type": "function", + }, + { + "id": "file-buckets-updatebucket", + "product": "storage", + "slug": "file-buckets-updatebucket", + "title": "updateBucket", + "type": "function", + }, + { + "id": "file-buckets-upload", + "product": "storage", + "slug": "file-buckets-upload", + "title": "upload", + "type": "function", + }, + { + "id": "file-buckets-uploadtosignedurl", + "product": "storage", + "slug": "file-buckets-uploadtosignedurl", + "title": "uploadToSignedUrl", + "type": "function", + }, + { + "id": "vector-buckets", + "slug": "vector-buckets", + "title": "Vector Buckets", + "type": "function", + }, + { + "id": "vector-buckets-createbucket", + "product": "storage", + "slug": "vector-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + { + "id": "vector-buckets-createindex", + "product": "storage", + "slug": "vector-buckets-createindex", + "title": "createIndex", + "type": "function", + }, + { + "id": "vector-buckets-deletebucket", + "product": "storage", + "slug": "vector-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + { + "id": "vector-buckets-deleteindex", + "product": "storage", + "slug": "vector-buckets-deleteindex", + "title": "deleteIndex", + "type": "function", + }, + { + "id": "vector-buckets-deletevectors", + "product": "storage", + "slug": "vector-buckets-deletevectors", + "title": "deleteVectors", + "type": "function", + }, + { + "id": "vector-buckets-from", + "product": "storage", + "slug": "vector-buckets-from", + "title": "from", + "type": "function", + }, + { + "id": "vector-buckets-getbucket", + "product": "storage", + "slug": "vector-buckets-getbucket", + "title": "getBucket", + "type": "function", + }, + { + "id": "vector-buckets-getindex", + "product": "storage", + "slug": "vector-buckets-getindex", + "title": "getIndex", + "type": "function", + }, + { + "id": "vector-buckets-getvectors", + "product": "storage", + "slug": "vector-buckets-getvectors", + "title": "getVectors", + "type": "function", + }, + { + "id": "vector-buckets-index", + "product": "storage", + "slug": "vector-buckets-index", + "title": "index", + "type": "function", + }, + { + "id": "vector-buckets-listbuckets", + "product": "storage", + "slug": "vector-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + { + "id": "vector-buckets-listindexes", + "product": "storage", + "slug": "vector-buckets-listindexes", + "title": "listIndexes", + "type": "function", + }, + { + "id": "vector-buckets-listvectors", + "product": "storage", + "slug": "vector-buckets-listvectors", + "title": "listVectors", + "type": "function", + }, + { + "id": "vector-buckets-putvectors", + "product": "storage", + "slug": "vector-buckets-putvectors", + "title": "putVectors", + "type": "function", + }, + { + "id": "vector-buckets-queryvectors", + "product": "storage", + "slug": "vector-buckets-queryvectors", + "title": "queryVectors", + "type": "function", + }, + ], + "functionsList": [ + { + "$ref": "@supabase/supabase-js.SupabaseClient.constructor", + "id": "initializing", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestQueryBuilder.delete", + "id": "delete", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestClient.from", + "id": "from", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.geojson", + "id": "geojson", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestQueryBuilder.insert", + "id": "insert", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.maxAffected", + "id": "maxaffected", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestBuilder.retry", + "id": "retry", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestBuilder.returns", + "id": "returns", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.rollback", + "id": "rollback", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestClient.rpc", + "id": "rpc", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestClient.schema", + "id": "schema", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestQueryBuilder.select", + "id": "select", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestBuilder.setHeader", + "id": "setheader", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestBuilder.throwOnError", + "id": "throwonerror", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestQueryBuilder.update", + "id": "update", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestQueryBuilder.upsert", + "id": "upsert", + }, + { + "description": "Filters allow you to only return rows that match certain conditions. + +Filters can be used on \`select()\`, \`update()\`, \`upsert()\`, and \`delete()\` queries. + +If a Postgres function returns a table response, you can also apply filters. +", + "examples": [ + { + "code": "\`\`\`ts +const { data, error } = await supabase + .from('instruments') + .select('name, section_id') + .eq('name', 'violin') // Correct + +const { data, error } = await supabase + .from('instruments') + .eq('name', 'violin') // Incorrect + .select('name, section_id') +\`\`\` +", + "description": "Filters must be applied after any of \`select()\`, \`update()\`, \`upsert()\`, +\`delete()\`, and \`rpc()\` and before +[modifiers](/docs/reference/javascript/using-modifiers). +", + "id": "applying-filters", + "name": "Applying Filters", + }, + { + "code": "\`\`\`ts +const { data, error } = await supabase + .from('cities') + .select('name, country_id') + .gte('population', 1000) + .lt('population', 10000) +\`\`\` +", + "description": "Filters can be chained together to produce advanced queries. For example, +to query cities with population between 1,000 and 10,000: + +\`\`\`ts +const { data, error } = await supabase + .from('cities') + .select('name, country_id') + .gte('population', 1000) + .lt('population', 10000) +\`\`\` +", + "id": "chaining-filters", + "name": "Chaining", + }, + { + "code": "\`\`\`ts +const filterByName = null +const filterPopLow = 1000 +const filterPopHigh = 10000 + +let query = supabase + .from('cities') + .select('name, country_id') + +if (filterByName) { query = query.eq('name', filterByName) } +if (filterPopLow) { query = query.gte('population', filterPopLow) } +if (filterPopHigh) { query = query.lt('population', filterPopHigh) } + +const { data, error } = await query +\`\`\` +", + "description": "Filters can be built up one step at a time and then executed. For example: + +\`\`\`ts +const filterByName = null +const filterPopLow = 1000 +const filterPopHigh = 10000 + +let query = supabase + .from('cities') + .select('name, country_id') + +if (filterByName) { query = query.eq('name', filterByName) } +if (filterPopLow) { query = query.gte('population', filterPopLow) } +if (filterPopHigh) { query = query.lt('population', filterPopHigh) } + +const { data, error } = await query +\`\`\` +", + "id": "conditional-chaining", + "name": "Conditional Chaining", + }, + { + "code": "\`\`\`ts +const { data, error } = await supabase + .from('users') + .select() + .eq('address->postcode', 90210) +\`\`\` +", + "data": { + "sql": "\`\`\`sql +create table + users ( + id int8 primary key, + name text, + address jsonb + ); + +insert into + users (id, name, address) +values + (1, 'Michael', '{ "postcode": 90210 }'), + (2, 'Jane', null); +\`\`\` +", + }, + "id": "filter-by-value-within-json-column", + "name": "Filter by values within a JSON column", + "response": "\`\`\`json +{ + "data": [ + { + "id": 1, + "name": "Michael", + "address": { + "postcode": 90210 + } + } + ], + "status": 200, + "statusText": "OK" +} +\`\`\` +", + }, + { + "code": "\`\`\`ts +const { data, error } = await supabase + .from('orchestral_sections') + .select(\` + name, + instruments!inner ( + name + ) + \`) + .eq('instruments.name', 'flute') +\`\`\` +", + "data": { + "response": "\`\`\`json +{ + "data": [ + { + "name": "woodwinds", + "characters": [ + { + "name": "flute" + } + ] + } + ], + "status": 200, + "statusText": "OK" +} +\`\`\` +", + "sql": "\`\`\`sql +create table + orchestral_sections (id int8 primary key, name text); +create table + instruments ( + id int8 primary key, + section_id int8 not null references orchestral_sections, + name text + ); + +insert into + orchestral_sections (id, name) +values + (1, 'strings'), + (2, 'woodwinds'); +insert into + instruments (id, section_id, name) +values + (1, 2, 'flute'), + (2, 1, 'violin'); +\`\`\` +", + }, + "description": "You can filter on referenced tables in your \`select()\` query using dot +notation. +", + "id": "filter-referenced-tables", + "name": "Filter referenced tables", + }, + ], + "id": "using-filters", + "title": "Using Filters", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.containedBy", + "id": "using-filters-containedby", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.contains", + "id": "using-filters-contains", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.eq", + "id": "using-filters-eq", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.filter", + "id": "using-filters-filter", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.gt", + "id": "using-filters-gt", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.gte", + "id": "using-filters-gte", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.ilike", + "id": "using-filters-ilike", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.ilikeAllOf", + "id": "using-filters-ilikeallof", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.ilikeAnyOf", + "id": "using-filters-ilikeanyof", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.in", + "id": "using-filters-in", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.is", + "id": "using-filters-is", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.like", + "id": "using-filters-like", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.likeAllOf", + "id": "using-filters-likeallof", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.likeAnyOf", + "id": "using-filters-likeanyof", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.lt", + "id": "using-filters-lt", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.lte", + "id": "using-filters-lte", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.match", + "id": "using-filters-match", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.neq", + "id": "using-filters-neq", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.not", + "id": "using-filters-not", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.or", + "id": "using-filters-or", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.overlaps", + "id": "using-filters-overlaps", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeAdjacent", + "id": "using-filters-rangeadjacent", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeGt", + "id": "using-filters-rangegt", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeGte", + "id": "using-filters-rangegte", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeLt", + "id": "using-filters-rangelt", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.rangeLte", + "id": "using-filters-rangelte", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.textSearch", + "id": "using-filters-textsearch", + }, + { + "description": "Filters work on the row level—they allow you to return rows that only match certain conditions without changing the shape of the rows. Modifiers are everything that don't fit that definition—allowing you to change the format of the response (e.g., returning a CSV string). + +Modifiers must be specified after filters. Some modifiers only apply for queries that return rows (e.g., \`select()\` or \`rpc()\` on a function that returns a table response).", + "id": "using-modifiers", + "title": "Using modifiers", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.abortSignal", + "id": "using-modifiers-abortsignal", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.csv", + "id": "using-modifiers-csv", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.explain", + "id": "using-modifiers-explain", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.limit", + "id": "using-modifiers-limit", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.maybeSingle", + "id": "using-modifiers-maybesingle", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.order", + "id": "using-modifiers-order", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestBuilder.overrideTypes", + "id": "using-modifiers-overridetypes", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.range", + "id": "using-modifiers-range", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.returns", + "id": "using-modifiers-returns", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.select", + "id": "using-modifiers-select", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestFilterBuilder.single", + "id": "using-modifiers-single", + }, + { + "$ref": "@supabase/postgrest-js.PostgrestBuilder.stripNulls", + "id": "using-modifiers-stripnulls", + }, + { + "examples": [ + { + "code": "\`\`\`js +import { createClient } from '@supabase/supabase-js' + +const supabase = createClient(supabase_url, publishable_key) +\`\`\` +", + "id": "create-auth-client", + "isSpotlight": true, + "name": "Create auth client", + }, + { + "code": "\`\`\`js +import { createClient } from '@supabase/supabase-js' + +const supabase = createClient(supabase_url, publishable_key, { + auth: { + autoRefreshToken: false, + persistSession: false, + detectSessionInUrl: false + } +}) +\`\`\` +", + "id": "create-auth-client-server-side", + "isSpotlight": false, + "name": "Create auth client (server-side)", + }, + ], + "id": "auth", + "notes": "- The auth methods can be accessed via the \`supabase.auth\` namespace. +- By default, the supabase client sets \`persistSession\` to true and attempts to store the session in local storage. When using the supabase client in an environment that doesn't support local storage, you might notice the following warning message being logged: + + > No storage option exists to persist the session, which may result in unexpected behavior when using auth. If you want to set \`persistSession\` to true, please provide a storage option or you may set \`persistSession\` to false to disable this warning. + + This warning message can be safely ignored if you're not using auth on the server-side. If you are using auth and you want to set \`persistSession\` to true, you will need to provide a custom storage implementation that follows [this interface](https://github.com/supabase/supabase-js/blob/master/packages/core/auth-js/src/lib/types.ts#L1053). +- Any email links and one-time passwords (OTPs) sent have a default expiry of 24 hours. We have the following [rate limits](/docs/guides/platform/going-into-prod#auth-rate-limits) in place to guard against brute force attacks. +- The expiry of an access token can be set in the "JWT expiry limit" field in [your project's auth settings](/dashboard/project/_/auth/providers). A refresh token never expires and can only be used once. +", + "title": "Overview", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.dispose", + "id": "auth-dispose", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.exchangeCodeForSession", + "id": "auth-exchangecodeforsession", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.getClaims", + "id": "auth-getclaims", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.getSession", + "id": "auth-getsession", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.getUser", + "id": "auth-getuser", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.getUserIdentities", + "id": "auth-getuseridentities", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.initialize", + "id": "auth-initialize", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.linkIdentity", + "id": "auth-linkidentity", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.onAuthStateChange", + "id": "auth-onauthstatechange", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.reauthenticate", + "id": "auth-reauthenticate", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.refreshSession", + "id": "auth-refreshsession", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.registerPasskey", + "id": "auth-registerpasskey", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.resend", + "id": "auth-resend", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.resetPasswordForEmail", + "id": "auth-resetpasswordforemail", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.setSession", + "id": "auth-setsession", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signInAnonymously", + "id": "auth-signinanonymously", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signInWithIdToken", + "id": "auth-signinwithidtoken", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signInWithOAuth", + "id": "auth-signinwithoauth", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signInWithOtp", + "id": "auth-signinwithotp", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signInWithPasskey", + "id": "auth-signinwithpasskey", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signInWithPassword", + "id": "auth-signinwithpassword", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signInWithSSO", + "id": "auth-signinwithsso", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signInWithWeb3", + "id": "auth-signinwithweb3", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signOut", + "id": "auth-signout", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.signUp", + "id": "auth-signup", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.startAutoRefresh", + "id": "auth-startautorefresh", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.stopAutoRefresh", + "id": "auth-stopautorefresh", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.unlinkIdentity", + "id": "auth-unlinkidentity", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.updateUser", + "id": "auth-updateuser", + }, + { + "$ref": "@supabase/auth-js.GoTrueClient.verifyOtp", + "id": "auth-verifyotp", + }, + { + "examples": [ + { + "code": "\`\`\`js +import { createClient } from '@supabase/supabase-js' + +const supabase = createClient(supabase_url, secret_key, { + auth: { + autoRefreshToken: false, + persistSession: false + } +}) + +// Access auth admin api +const adminAuthClient = supabase.auth.admin +\`\`\` +", + "id": "create-auth-admin-client", + "isSpotlight": true, + "name": "Create server-side auth client", + }, + ], + "id": "auth-admin", + "notes": "- Any method under the \`supabase.auth.admin\` namespace requires a \`secret\` key. +- These methods are considered admin methods and should be called on a trusted server. Never expose your \`secret\` key in the browser. +", + "title": "Overview", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.createProvider", + "id": "auth-admin-createprovider", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminApi.createUser", + "id": "auth-admin-createuser", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminMFAApi.deleteFactor", + "id": "auth-admin-deletefactor", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.deleteProvider", + "id": "auth-admin-deleteprovider", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminApi.deleteUser", + "id": "auth-admin-deleteuser", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminApi.generateLink", + "id": "auth-admin-generatelink", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.getProvider", + "id": "auth-admin-getprovider", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminApi.getUserById", + "id": "auth-admin-getuserbyid", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminApi.inviteUserByEmail", + "id": "auth-admin-inviteuserbyemail", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminMFAApi.listFactors", + "id": "auth-admin-listfactors", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.listProviders", + "id": "auth-admin-listproviders", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminApi.listUsers", + "id": "auth-admin-listusers", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminApi.signOut", + "id": "auth-admin-signout", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.updateProvider", + "id": "auth-admin-updateprovider", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminApi.updateUserById", + "id": "auth-admin-updateuserbyid", + }, + { + "description": "This section contains methods commonly used for Multi-Factor Authentication (MFA) and are invoked behind the \`supabase.auth.mfa\` namespace. + +Currently, there is support for time-based one-time password (TOTP) and phone verification code as the 2nd factor. Recovery codes are not supported but users can enroll multiple factors, with an upper limit of 10. + +Having a 2nd factor for recovery frees the user of the burden of having to store their recovery codes somewhere. It also reduces the attack surface since multiple recovery codes are usually generated compared to just having 1 backup factor. + +Learn more about implementing MFA in your application [in the MFA guide](https://supabase.com/docs/guides/auth/auth-mfa#overview).", + "id": "auth-mfa", + "title": "Auth MFA", + }, + { + "$ref": "@supabase/auth-js.GoTrueMFAApi.challenge", + "id": "auth-mfa-challenge", + }, + { + "$ref": "@supabase/auth-js.GoTrueMFAApi.challengeAndVerify", + "id": "auth-mfa-challengeandverify", + }, + { + "$ref": "@supabase/auth-js.GoTrueMFAApi.enroll", + "id": "auth-mfa-enroll", + }, + { + "$ref": "@supabase/auth-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel", + "id": "auth-mfa-getauthenticatorassurancelevel", + }, + { + "$ref": "@supabase/auth-js.GoTrueMFAApi.listFactors", + "id": "auth-mfa-listfactors", + }, + { + "$ref": "@supabase/auth-js.GoTrueMFAApi.unenroll", + "id": "auth-mfa-unenroll", + }, + { + "$ref": "@supabase/auth-js.GoTrueMFAApi.verify", + "id": "auth-mfa-verify", + }, + { + "code": "\`\`\`js +const supabase = createClient(supabaseUrl, publishableKey, { + auth: { + experimental: { passkey: true }, + }, +}) +\`\`\`", + "description": "This section contains methods for WebAuthn passkey registration, authentication, and management. Methods are invoked behind the \`supabase.auth.passkey\` namespace. + +Passkey support is an experimental feature. Enable it when creating the client:", + "id": "auth-passkey", + "title": "Auth Passkey", + }, + { + "$ref": "@supabase/auth-js.AuthPasskeyApi.delete", + "id": "auth-passkey-delete", + }, + { + "$ref": "@supabase/auth-js.AuthPasskeyApi.list", + "id": "auth-passkey-list", + }, + { + "$ref": "@supabase/auth-js.AuthPasskeyApi.startAuthentication", + "id": "auth-passkey-startauthentication", + }, + { + "$ref": "@supabase/auth-js.AuthPasskeyApi.startRegistration", + "id": "auth-passkey-startregistration", + }, + { + "$ref": "@supabase/auth-js.AuthPasskeyApi.update", + "id": "auth-passkey-update", + }, + { + "$ref": "@supabase/auth-js.AuthPasskeyApi.verifyAuthentication", + "id": "auth-passkey-verifyauthentication", + }, + { + "$ref": "@supabase/auth-js.AuthPasskeyApi.verifyRegistration", + "id": "auth-passkey-verifyregistration", + }, + { + "description": "The OAuth Admin API allows you to manage OAuth clients programmatically. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. These functions should only be called on a server. Never expose your \`secret\` key in the browser.", + "id": "oauth-admin", + "title": "OAuth Admin", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminOAuthApi.createClient", + "id": "oauth-admin-createclient", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminOAuthApi.deleteClient", + "id": "oauth-admin-deleteclient", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminOAuthApi.getClient", + "id": "oauth-admin-getclient", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminOAuthApi.listClients", + "id": "oauth-admin-listclients", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminOAuthApi.regenerateClientSecret", + "id": "oauth-admin-regenerateclientsecret", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminOAuthApi.updateClient", + "id": "oauth-admin-updateclient", + }, + { + "description": "The OAuth Server API allows you to build custom OAuth consent screens for your application. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.", + "id": "oauth-server", + "title": "OAuth Server", + }, + { + "$ref": "@supabase/auth-js.AuthOAuthServerApi.approveAuthorization", + "id": "oauth-server-approveauthorization", + }, + { + "$ref": "@supabase/auth-js.AuthOAuthServerApi.denyAuthorization", + "id": "oauth-server-denyauthorization", + }, + { + "$ref": "@supabase/auth-js.AuthOAuthServerApi.getAuthorizationDetails", + "id": "oauth-server-getauthorizationdetails", + }, + { + "$ref": "@supabase/auth-js.AuthOAuthServerApi.listGrants", + "id": "oauth-server-listgrants", + }, + { + "$ref": "@supabase/auth-js.AuthOAuthServerApi.revokeGrant", + "id": "oauth-server-revokegrant", + }, + { + "description": "Contains passkey administration methods. Requires a secret key.", + "id": "passkey-admin", + "title": "Passkey admin", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminPasskeyApi.deletePasskey", + "id": "passkey-admin-deletepasskey", + }, + { + "$ref": "@supabase/auth-js.GoTrueAdminPasskeyApi.listPasskeys", + "id": "passkey-admin-listpasskeys", + }, + { + "$ref": "@supabase/supabase-js.cors.corsHeaders", + "id": "functions-corsheaders", + }, + { + "$ref": "@supabase/functions-js.FunctionsClient.invoke", + "id": "functions-invoke", + }, + { + "$ref": "@supabase/functions-js.FunctionsClient.setAuth", + "id": "functions-setauth", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.channel", + "id": "channel", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.connect", + "id": "connect", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.connectionState", + "id": "connectionstate", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.disconnect", + "id": "disconnect", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.endpointURL", + "id": "endpointurl", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.getChannels", + "id": "getchannels", + }, + { + "$ref": "@supabase/realtime-js.WebSocketFactory.getWebSocketConstructor", + "id": "getwebsocketconstructor", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.httpSend", + "id": "httpsend", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.isConnected", + "id": "isconnected", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.isConnecting", + "id": "isconnecting", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.isDisconnecting", + "id": "isdisconnecting", + }, + { + "$ref": "@supabase/realtime-js.WebSocketFactory.isWebSocketSupported", + "id": "iswebsocketsupported", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.log", + "id": "log", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.on", + "id": "on", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.onHeartbeat", + "id": "onheartbeat", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.presenceState", + "id": "presencestate", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.push", + "id": "push", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.removeAllChannels", + "id": "removeallchannels", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.removeChannel", + "id": "removechannel", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.send", + "id": "send", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.sendHeartbeat", + "id": "sendheartbeat", + }, + { + "$ref": "@supabase/realtime-js.RealtimeClient.setAuth", + "id": "setauth", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.subscribe", + "id": "subscribe", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.teardown", + "id": "teardown", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.track", + "id": "track", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.unsubscribe", + "id": "unsubscribe", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.untrack", + "id": "untrack", + }, + { + "$ref": "@supabase/realtime-js.RealtimeChannel.updateJoinPayload", + "id": "updatejoinpayload", + }, + { + "description": "This section contains methods for working with Analytics Buckets.", + "id": "analytics-buckets", + "title": "Analytics Buckets", + }, + { + "$ref": "@supabase/storage-js.packages/StorageAnalyticsClient.default.createBucket", + "id": "analytics-buckets-createbucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageAnalyticsClient.default.deleteBucket", + "id": "analytics-buckets-deletebucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageAnalyticsClient.default.from", + "id": "analytics-buckets-from", + }, + { + "$ref": "@supabase/storage-js.packages/StorageAnalyticsClient.default.listBuckets", + "id": "analytics-buckets-listbuckets", + }, + { + "description": "This section contains methods for working with File Buckets.", + "id": "file-buckets", + "title": "File Buckets", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.copy", + "id": "file-buckets-copy", + }, + { + "$ref": "@supabase/storage-js.StorageClient.createBucket", + "id": "file-buckets-createbucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.createSignedUploadUrl", + "id": "file-buckets-createsigneduploadurl", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.createSignedUrl", + "id": "file-buckets-createsignedurl", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.createSignedUrls", + "id": "file-buckets-createsignedurls", + }, + { + "$ref": "@supabase/storage-js.StorageClient.deleteBucket", + "id": "file-buckets-deletebucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.download", + "id": "file-buckets-download", + }, + { + "$ref": "@supabase/storage-js.StorageClient.emptyBucket", + "id": "file-buckets-emptybucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.exists", + "id": "file-buckets-exists", + }, + { + "$ref": "@supabase/storage-js.StorageClient.from", + "id": "file-buckets-from", + }, + { + "$ref": "@supabase/storage-js.StorageClient.getBucket", + "id": "file-buckets-getbucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.getPublicUrl", + "id": "file-buckets-getpublicurl", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.info", + "id": "file-buckets-info", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.list", + "id": "file-buckets-list", + }, + { + "$ref": "@supabase/storage-js.StorageClient.listBuckets", + "id": "file-buckets-listbuckets", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.listV2", + "id": "file-buckets-listv2", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.move", + "id": "file-buckets-move", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.remove", + "id": "file-buckets-remove", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.update", + "id": "file-buckets-update", + }, + { + "$ref": "@supabase/storage-js.StorageClient.updateBucket", + "id": "file-buckets-updatebucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.upload", + "id": "file-buckets-upload", + }, + { + "$ref": "@supabase/storage-js.packages/StorageFileApi.default.uploadToSignedUrl", + "id": "file-buckets-uploadtosignedurl", + }, + { + "description": "This section contains methods for working with Vector Buckets.", + "id": "vector-buckets", + "title": "Vector Buckets", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.createBucket", + "id": "vector-buckets-createbucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.createIndex", + "id": "vector-buckets-createindex", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.deleteBucket", + "id": "vector-buckets-deletebucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.deleteIndex", + "id": "vector-buckets-deleteindex", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.deleteVectors", + "id": "vector-buckets-deletevectors", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.from", + "id": "vector-buckets-from", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.getBucket", + "id": "vector-buckets-getbucket", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.getIndex", + "id": "vector-buckets-getindex", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.getVectors", + "id": "vector-buckets-getvectors", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope", + "id": "vector-buckets-index", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.listBuckets", + "id": "vector-buckets-listbuckets", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.listIndexes", + "id": "vector-buckets-listindexes", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.listVectors", + "id": "vector-buckets-listvectors", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.putVectors", + "id": "vector-buckets-putvectors", + }, + { + "$ref": "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.queryVectors", + "id": "vector-buckets-queryvectors", + }, + ], + "sections": [ + { + "id": "introduction", + "slug": "introduction", + "title": "Introduction", + "type": "markdown", + }, + { + "id": "installing", + "slug": "installing", + "title": "Installing", + "type": "markdown", + }, + { + "id": "initializing", + "slug": "initializing", + "title": "Initializing", + "type": "function", + }, + { + "id": "typescript-support", + "slug": "typescript-support", + "title": "TypeScript support", + "type": "markdown", + }, + { + "items": [ + { + "id": "delete", + "product": "database", + "slug": "delete", + "title": "delete", + "type": "function", + }, + { + "id": "from", + "product": "database", + "slug": "from", + "title": "from", + "type": "function", + }, + { + "id": "geojson", + "product": "database", + "slug": "geojson", + "title": "geojson", + "type": "function", + }, + { + "id": "insert", + "product": "database", + "slug": "insert", + "title": "insert", + "type": "function", + }, + { + "id": "maxaffected", + "product": "database", + "slug": "maxaffected", + "title": "maxAffected", + "type": "function", + }, + { + "id": "retry", + "product": "database", + "slug": "retry", + "title": "retry", + "type": "function", + }, + { + "id": "returns", + "product": "database", + "slug": "returns", + "title": "returns", + "type": "function", + }, + { + "id": "rollback", + "product": "database", + "slug": "rollback", + "title": "rollback", + "type": "function", + }, + { + "id": "rpc", + "product": "database", + "slug": "rpc", + "title": "rpc", + "type": "function", + }, + { + "id": "schema", + "product": "database", + "slug": "schema", + "title": "schema", + "type": "function", + }, + { + "id": "select", + "product": "database", + "slug": "select", + "title": "select", + "type": "function", + }, + { + "id": "setheader", + "product": "database", + "slug": "setheader", + "title": "setHeader", + "type": "function", + }, + { + "id": "throwonerror", + "product": "database", + "slug": "throwonerror", + "title": "throwOnError", + "type": "function", + }, + { + "id": "update", + "product": "database", + "slug": "update", + "title": "update", + "type": "function", + }, + { + "id": "upsert", + "product": "database", + "slug": "upsert", + "title": "upsert", + "type": "function", + }, + { + "id": "using-filters", + "isFunc": false, + "items": [ + { + "id": "using-filters", + "slug": "using-filters", + "title": "Using Filters", + "type": "function", + }, + { + "id": "using-filters-containedby", + "product": "database", + "slug": "using-filters-containedby", + "title": "containedBy", + "type": "function", + }, + { + "id": "using-filters-contains", + "product": "database", + "slug": "using-filters-contains", + "title": "contains", + "type": "function", + }, + { + "id": "using-filters-eq", + "product": "database", + "slug": "using-filters-eq", + "title": "eq", + "type": "function", + }, + { + "id": "using-filters-filter", + "product": "database", + "slug": "using-filters-filter", + "title": "filter", + "type": "function", + }, + { + "id": "using-filters-gt", + "product": "database", + "slug": "using-filters-gt", + "title": "gt", + "type": "function", + }, + { + "id": "using-filters-gte", + "product": "database", + "slug": "using-filters-gte", + "title": "gte", + "type": "function", + }, + { + "id": "using-filters-ilike", + "product": "database", + "slug": "using-filters-ilike", + "title": "ilike", + "type": "function", + }, + { + "id": "using-filters-ilikeallof", + "product": "database", + "slug": "using-filters-ilikeallof", + "title": "ilikeAllOf", + "type": "function", + }, + { + "id": "using-filters-ilikeanyof", + "product": "database", + "slug": "using-filters-ilikeanyof", + "title": "ilikeAnyOf", + "type": "function", + }, + { + "id": "using-filters-in", + "product": "database", + "slug": "using-filters-in", + "title": "in", + "type": "function", + }, + { + "id": "using-filters-is", + "product": "database", + "slug": "using-filters-is", + "title": "is", + "type": "function", + }, + { + "id": "using-filters-like", + "product": "database", + "slug": "using-filters-like", + "title": "like", + "type": "function", + }, + { + "id": "using-filters-likeallof", + "product": "database", + "slug": "using-filters-likeallof", + "title": "likeAllOf", + "type": "function", + }, + { + "id": "using-filters-likeanyof", + "product": "database", + "slug": "using-filters-likeanyof", + "title": "likeAnyOf", + "type": "function", + }, + { + "id": "using-filters-lt", + "product": "database", + "slug": "using-filters-lt", + "title": "lt", + "type": "function", + }, + { + "id": "using-filters-lte", + "product": "database", + "slug": "using-filters-lte", + "title": "lte", + "type": "function", + }, + { + "id": "using-filters-match", + "product": "database", + "slug": "using-filters-match", + "title": "match", + "type": "function", + }, + { + "id": "using-filters-neq", + "product": "database", + "slug": "using-filters-neq", + "title": "neq", + "type": "function", + }, + { + "id": "using-filters-not", + "product": "database", + "slug": "using-filters-not", + "title": "not", + "type": "function", + }, + { + "id": "using-filters-or", + "product": "database", + "slug": "using-filters-or", + "title": "or", + "type": "function", + }, + { + "id": "using-filters-overlaps", + "product": "database", + "slug": "using-filters-overlaps", + "title": "overlaps", + "type": "function", + }, + { + "id": "using-filters-rangeadjacent", + "product": "database", + "slug": "using-filters-rangeadjacent", + "title": "rangeAdjacent", + "type": "function", + }, + { + "id": "using-filters-rangegt", + "product": "database", + "slug": "using-filters-rangegt", + "title": "rangeGt", + "type": "function", + }, + { + "id": "using-filters-rangegte", + "product": "database", + "slug": "using-filters-rangegte", + "title": "rangeGte", + "type": "function", + }, + { + "id": "using-filters-rangelt", + "product": "database", + "slug": "using-filters-rangelt", + "title": "rangeLt", + "type": "function", + }, + { + "id": "using-filters-rangelte", + "product": "database", + "slug": "using-filters-rangelte", + "title": "rangeLte", + "type": "function", + }, + { + "id": "using-filters-textsearch", + "product": "database", + "slug": "using-filters-textsearch", + "title": "textSearch", + "type": "function", + }, + ], + "product": "database", + "slug": "using-filters", + "title": "Using filters", + "type": "function", + }, + { + "id": "using-modifiers", + "isFunc": false, + "items": [ + { + "id": "using-modifiers", + "slug": "using-modifiers", + "title": "Using modifiers", + "type": "function", + }, + { + "id": "using-modifiers-abortsignal", + "product": "database", + "slug": "using-modifiers-abortsignal", + "title": "abortSignal", + "type": "function", + }, + { + "id": "using-modifiers-csv", + "product": "database", + "slug": "using-modifiers-csv", + "title": "csv", + "type": "function", + }, + { + "id": "using-modifiers-explain", + "product": "database", + "slug": "using-modifiers-explain", + "title": "explain", + "type": "function", + }, + { + "id": "using-modifiers-limit", + "product": "database", + "slug": "using-modifiers-limit", + "title": "limit", + "type": "function", + }, + { + "id": "using-modifiers-maybesingle", + "product": "database", + "slug": "using-modifiers-maybesingle", + "title": "maybeSingle", + "type": "function", + }, + { + "id": "using-modifiers-order", + "product": "database", + "slug": "using-modifiers-order", + "title": "order", + "type": "function", + }, + { + "id": "using-modifiers-overridetypes", + "product": "database", + "slug": "using-modifiers-overridetypes", + "title": "overrideTypes", + "type": "function", + }, + { + "id": "using-modifiers-range", + "product": "database", + "slug": "using-modifiers-range", + "title": "range", + "type": "function", + }, + { + "id": "using-modifiers-returns", + "product": "database", + "slug": "using-modifiers-returns", + "title": "returns", + "type": "function", + }, + { + "id": "using-modifiers-select", + "product": "database", + "slug": "using-modifiers-select", + "title": "select", + "type": "function", + }, + { + "id": "using-modifiers-single", + "product": "database", + "slug": "using-modifiers-single", + "title": "single", + "type": "function", + }, + { + "id": "using-modifiers-stripnulls", + "product": "database", + "slug": "using-modifiers-stripnulls", + "title": "stripNulls", + "type": "function", + }, + ], + "product": "database", + "slug": "using-modifiers", + "title": "Using modifiers", + "type": "function", + }, + ], + "title": "Database", + "type": "category", + }, + { + "items": [ + { + "id": "auth", + "slug": "auth", + "title": "Overview", + "type": "function", + }, + { + "id": "auth-dispose", + "product": "auth", + "slug": "auth-dispose", + "title": "dispose", + "type": "function", + }, + { + "id": "auth-exchangecodeforsession", + "product": "auth", + "slug": "auth-exchangecodeforsession", + "title": "exchangeCodeForSession", + "type": "function", + }, + { + "id": "auth-getclaims", + "product": "auth", + "slug": "auth-getclaims", + "title": "getClaims", + "type": "function", + }, + { + "id": "auth-getsession", + "product": "auth", + "slug": "auth-getsession", + "title": "getSession", + "type": "function", + }, + { + "id": "auth-getuser", + "product": "auth", + "slug": "auth-getuser", + "title": "getUser", + "type": "function", + }, + { + "id": "auth-getuseridentities", + "product": "auth", + "slug": "auth-getuseridentities", + "title": "getUserIdentities", + "type": "function", + }, + { + "id": "auth-initialize", + "product": "auth", + "slug": "auth-initialize", + "title": "initialize", + "type": "function", + }, + { + "id": "auth-linkidentity", + "product": "auth", + "slug": "auth-linkidentity", + "title": "linkIdentity", + "type": "function", + }, + { + "id": "auth-onauthstatechange", + "product": "auth", + "slug": "auth-onauthstatechange", + "title": "onAuthStateChange", + "type": "function", + }, + { + "id": "auth-reauthenticate", + "product": "auth", + "slug": "auth-reauthenticate", + "title": "reauthenticate", + "type": "function", + }, + { + "id": "auth-refreshsession", + "product": "auth", + "slug": "auth-refreshsession", + "title": "refreshSession", + "type": "function", + }, + { + "id": "auth-registerpasskey", + "product": "auth", + "slug": "auth-registerpasskey", + "title": "registerPasskey", + "type": "function", + }, + { + "id": "auth-resend", + "product": "auth", + "slug": "auth-resend", + "title": "resend", + "type": "function", + }, + { + "id": "auth-resetpasswordforemail", + "product": "auth", + "slug": "auth-resetpasswordforemail", + "title": "resetPasswordForEmail", + "type": "function", + }, + { + "id": "auth-setsession", + "product": "auth", + "slug": "auth-setsession", + "title": "setSession", + "type": "function", + }, + { + "id": "auth-signinanonymously", + "product": "auth", + "slug": "auth-signinanonymously", + "title": "signInAnonymously", + "type": "function", + }, + { + "id": "auth-signinwithidtoken", + "product": "auth", + "slug": "auth-signinwithidtoken", + "title": "signInWithIdToken", + "type": "function", + }, + { + "id": "auth-signinwithoauth", + "product": "auth", + "slug": "auth-signinwithoauth", + "title": "signInWithOAuth", + "type": "function", + }, + { + "id": "auth-signinwithotp", + "product": "auth", + "slug": "auth-signinwithotp", + "title": "signInWithOtp", + "type": "function", + }, + { + "id": "auth-signinwithpasskey", + "product": "auth", + "slug": "auth-signinwithpasskey", + "title": "signInWithPasskey", + "type": "function", + }, + { + "id": "auth-signinwithpassword", + "product": "auth", + "slug": "auth-signinwithpassword", + "title": "signInWithPassword", + "type": "function", + }, + { + "id": "auth-signinwithsso", + "product": "auth", + "slug": "auth-signinwithsso", + "title": "signInWithSSO", + "type": "function", + }, + { + "id": "auth-signinwithweb3", + "product": "auth", + "slug": "auth-signinwithweb3", + "title": "signInWithWeb3", + "type": "function", + }, + { + "id": "auth-signout", + "product": "auth", + "slug": "auth-signout", + "title": "signOut", + "type": "function", + }, + { + "id": "auth-signup", + "product": "auth", + "slug": "auth-signup", + "title": "signUp", + "type": "function", + }, + { + "id": "auth-startautorefresh", + "product": "auth", + "slug": "auth-startautorefresh", + "title": "startAutoRefresh", + "type": "function", + }, + { + "id": "auth-stopautorefresh", + "product": "auth", + "slug": "auth-stopautorefresh", + "title": "stopAutoRefresh", + "type": "function", + }, + { + "id": "auth-unlinkidentity", + "product": "auth", + "slug": "auth-unlinkidentity", + "title": "unlinkIdentity", + "type": "function", + }, + { + "id": "auth-updateuser", + "product": "auth", + "slug": "auth-updateuser", + "title": "updateUser", + "type": "function", + }, + { + "id": "auth-verifyotp", + "product": "auth", + "slug": "auth-verifyotp", + "title": "verifyOtp", + "type": "function", + }, + { + "id": "auth-admin", + "isFunc": false, + "items": [ + { + "id": "auth-admin", + "slug": "auth-admin", + "title": "Overview", + "type": "function", + }, + { + "id": "auth-admin-createprovider", + "product": "auth", + "slug": "auth-admin-createprovider", + "title": "createProvider", + "type": "function", + }, + { + "id": "auth-admin-createuser", + "product": "auth", + "slug": "auth-admin-createuser", + "title": "createUser", + "type": "function", + }, + { + "id": "auth-admin-deletefactor", + "product": "auth", + "slug": "auth-admin-deletefactor", + "title": "deleteFactor", + "type": "function", + }, + { + "id": "auth-admin-deleteprovider", + "product": "auth", + "slug": "auth-admin-deleteprovider", + "title": "deleteProvider", + "type": "function", + }, + { + "id": "auth-admin-deleteuser", + "product": "auth", + "slug": "auth-admin-deleteuser", + "title": "deleteUser", + "type": "function", + }, + { + "id": "auth-admin-generatelink", + "product": "auth", + "slug": "auth-admin-generatelink", + "title": "generateLink", + "type": "function", + }, + { + "id": "auth-admin-getprovider", + "product": "auth", + "slug": "auth-admin-getprovider", + "title": "getProvider", + "type": "function", + }, + { + "id": "auth-admin-getuserbyid", + "product": "auth", + "slug": "auth-admin-getuserbyid", + "title": "getUserById", + "type": "function", + }, + { + "id": "auth-admin-inviteuserbyemail", + "product": "auth", + "slug": "auth-admin-inviteuserbyemail", + "title": "inviteUserByEmail", + "type": "function", + }, + { + "id": "auth-admin-listfactors", + "product": "auth", + "slug": "auth-admin-listfactors", + "title": "listFactors", + "type": "function", + }, + { + "id": "auth-admin-listproviders", + "product": "auth", + "slug": "auth-admin-listproviders", + "title": "listProviders", + "type": "function", + }, + { + "id": "auth-admin-listusers", + "product": "auth", + "slug": "auth-admin-listusers", + "title": "listUsers", + "type": "function", + }, + { + "id": "auth-admin-signout", + "product": "auth", + "slug": "auth-admin-signout", + "title": "signOut", + "type": "function", + }, + { + "id": "auth-admin-updateprovider", + "product": "auth", + "slug": "auth-admin-updateprovider", + "title": "updateProvider", + "type": "function", + }, + { + "id": "auth-admin-updateuserbyid", + "product": "auth", + "slug": "auth-admin-updateuserbyid", + "title": "updateUserById", + "type": "function", + }, + ], + "product": "auth", + "slug": "auth-admin", + "title": "Auth Admin", + "type": "function", + }, + { + "id": "auth-mfa", + "isFunc": false, + "items": [ + { + "id": "auth-mfa", + "slug": "auth-mfa", + "title": "Auth MFA", + "type": "function", + }, + { + "id": "auth-mfa-challenge", + "product": "auth", + "slug": "auth-mfa-challenge", + "title": "challenge", + "type": "function", + }, + { + "id": "auth-mfa-challengeandverify", + "product": "auth", + "slug": "auth-mfa-challengeandverify", + "title": "challengeAndVerify", + "type": "function", + }, + { + "id": "auth-mfa-enroll", + "product": "auth", + "slug": "auth-mfa-enroll", + "title": "enroll", + "type": "function", + }, + { + "id": "auth-mfa-getauthenticatorassurancelevel", + "product": "auth", + "slug": "auth-mfa-getauthenticatorassurancelevel", + "title": "getAuthenticatorAssuranceLevel", + "type": "function", + }, + { + "id": "auth-mfa-listfactors", + "product": "auth", + "slug": "auth-mfa-listfactors", + "title": "listFactors", + "type": "function", + }, + { + "id": "auth-mfa-unenroll", + "product": "auth", + "slug": "auth-mfa-unenroll", + "title": "unenroll", + "type": "function", + }, + { + "id": "auth-mfa-verify", + "product": "auth", + "slug": "auth-mfa-verify", + "title": "verify", + "type": "function", + }, + ], + "product": "auth", + "slug": "auth-mfa", + "title": "Auth MFA", + "type": "function", + }, + { + "id": "auth-passkey", + "isFunc": false, + "items": [ + { + "id": "auth-passkey", + "slug": "auth-passkey", + "title": "Auth Passkey", + "type": "function", + }, + { + "id": "auth-passkey-delete", + "product": "auth", + "slug": "auth-passkey-delete", + "title": "delete", + "type": "function", + }, + { + "id": "auth-passkey-list", + "product": "auth", + "slug": "auth-passkey-list", + "title": "list", + "type": "function", + }, + { + "id": "auth-passkey-startauthentication", + "product": "auth", + "slug": "auth-passkey-startauthentication", + "title": "startAuthentication", + "type": "function", + }, + { + "id": "auth-passkey-startregistration", + "product": "auth", + "slug": "auth-passkey-startregistration", + "title": "startRegistration", + "type": "function", + }, + { + "id": "auth-passkey-update", + "product": "auth", + "slug": "auth-passkey-update", + "title": "update", + "type": "function", + }, + { + "id": "auth-passkey-verifyauthentication", + "product": "auth", + "slug": "auth-passkey-verifyauthentication", + "title": "verifyAuthentication", + "type": "function", + }, + { + "id": "auth-passkey-verifyregistration", + "product": "auth", + "slug": "auth-passkey-verifyregistration", + "title": "verifyRegistration", + "type": "function", + }, + ], + "product": "auth", + "slug": "auth-passkey", + "title": "Auth Passkey", + "type": "function", + }, + { + "id": "oauth-admin", + "isFunc": false, + "items": [ + { + "id": "oauth-admin", + "slug": "oauth-admin", + "title": "OAuth Admin", + "type": "function", + }, + { + "id": "oauth-admin-createclient", + "product": "auth", + "slug": "oauth-admin-createclient", + "title": "createClient", + "type": "function", + }, + { + "id": "oauth-admin-deleteclient", + "product": "auth", + "slug": "oauth-admin-deleteclient", + "title": "deleteClient", + "type": "function", + }, + { + "id": "oauth-admin-getclient", + "product": "auth", + "slug": "oauth-admin-getclient", + "title": "getClient", + "type": "function", + }, + { + "id": "oauth-admin-listclients", + "product": "auth", + "slug": "oauth-admin-listclients", + "title": "listClients", + "type": "function", + }, + { + "id": "oauth-admin-regenerateclientsecret", + "product": "auth", + "slug": "oauth-admin-regenerateclientsecret", + "title": "regenerateClientSecret", + "type": "function", + }, + { + "id": "oauth-admin-updateclient", + "product": "auth", + "slug": "oauth-admin-updateclient", + "title": "updateClient", + "type": "function", + }, + ], + "product": "auth", + "slug": "oauth-admin", + "title": "OAuth Admin", + "type": "function", + }, + { + "id": "oauth-server", + "isFunc": false, + "items": [ + { + "id": "oauth-server", + "slug": "oauth-server", + "title": "OAuth Server", + "type": "function", + }, + { + "id": "oauth-server-approveauthorization", + "product": "auth", + "slug": "oauth-server-approveauthorization", + "title": "approveAuthorization", + "type": "function", + }, + { + "id": "oauth-server-denyauthorization", + "product": "auth", + "slug": "oauth-server-denyauthorization", + "title": "denyAuthorization", + "type": "function", + }, + { + "id": "oauth-server-getauthorizationdetails", + "product": "auth", + "slug": "oauth-server-getauthorizationdetails", + "title": "getAuthorizationDetails", + "type": "function", + }, + { + "id": "oauth-server-listgrants", + "product": "auth", + "slug": "oauth-server-listgrants", + "title": "listGrants", + "type": "function", + }, + { + "id": "oauth-server-revokegrant", + "product": "auth", + "slug": "oauth-server-revokegrant", + "title": "revokeGrant", + "type": "function", + }, + ], + "product": "auth", + "slug": "oauth-server", + "title": "OAuth Server", + "type": "function", + }, + { + "id": "passkey-admin", + "isFunc": false, + "items": [ + { + "id": "passkey-admin", + "slug": "passkey-admin", + "title": "Passkey admin", + "type": "function", + }, + { + "id": "passkey-admin-deletepasskey", + "product": "auth", + "slug": "passkey-admin-deletepasskey", + "title": "deletePasskey", + "type": "function", + }, + { + "id": "passkey-admin-listpasskeys", + "product": "auth", + "slug": "passkey-admin-listpasskeys", + "title": "listPasskeys", + "type": "function", + }, + ], + "product": "auth", + "slug": "passkey-admin", + "title": "Passkey Admin", + "type": "function", + }, + ], + "title": "Auth", + "type": "category", + }, + { + "items": [ + { + "id": "functions-corsheaders", + "product": "edge-functions", + "slug": "functions-corsheaders", + "title": "corsHeaders", + "type": "function", + }, + { + "id": "functions-invoke", + "product": "edge-functions", + "slug": "functions-invoke", + "title": "invoke", + "type": "function", + }, + { + "id": "functions-setauth", + "product": "edge-functions", + "slug": "functions-setauth", + "title": "setAuth", + "type": "function", + }, + ], + "title": "Edge Functions", + "type": "category", + }, + { + "items": [ + { + "id": "channel", + "product": "realtime", + "slug": "channel", + "title": "channel", + "type": "function", + }, + { + "id": "connect", + "product": "realtime", + "slug": "connect", + "title": "connect", + "type": "function", + }, + { + "id": "connectionstate", + "product": "realtime", + "slug": "connectionstate", + "title": "connectionState", + "type": "function", + }, + { + "id": "disconnect", + "product": "realtime", + "slug": "disconnect", + "title": "disconnect", + "type": "function", + }, + { + "id": "endpointurl", + "product": "realtime", + "slug": "endpointurl", + "title": "endpointURL", + "type": "function", + }, + { + "id": "getchannels", + "product": "realtime", + "slug": "getchannels", + "title": "getChannels", + "type": "function", + }, + { + "id": "getwebsocketconstructor", + "product": "realtime", + "slug": "getwebsocketconstructor", + "title": "getWebSocketConstructor", + "type": "function", + }, + { + "id": "httpsend", + "product": "realtime", + "slug": "httpsend", + "title": "httpSend", + "type": "function", + }, + { + "id": "isconnected", + "product": "realtime", + "slug": "isconnected", + "title": "isConnected", + "type": "function", + }, + { + "id": "isconnecting", + "product": "realtime", + "slug": "isconnecting", + "title": "isConnecting", + "type": "function", + }, + { + "id": "isdisconnecting", + "product": "realtime", + "slug": "isdisconnecting", + "title": "isDisconnecting", + "type": "function", + }, + { + "id": "iswebsocketsupported", + "product": "realtime", + "slug": "iswebsocketsupported", + "title": "isWebSocketSupported", + "type": "function", + }, + { + "id": "log", + "product": "realtime", + "slug": "log", + "title": "log", + "type": "function", + }, + { + "id": "on", + "product": "realtime", + "slug": "on", + "title": "on", + "type": "function", + }, + { + "id": "onheartbeat", + "product": "realtime", + "slug": "onheartbeat", + "title": "onHeartbeat", + "type": "function", + }, + { + "id": "presencestate", + "product": "realtime", + "slug": "presencestate", + "title": "presenceState", + "type": "function", + }, + { + "id": "push", + "product": "realtime", + "slug": "push", + "title": "push", + "type": "function", + }, + { + "id": "removeallchannels", + "product": "realtime", + "slug": "removeallchannels", + "title": "removeAllChannels", + "type": "function", + }, + { + "id": "removechannel", + "product": "realtime", + "slug": "removechannel", + "title": "removeChannel", + "type": "function", + }, + { + "id": "send", + "product": "realtime", + "slug": "send", + "title": "send", + "type": "function", + }, + { + "id": "sendheartbeat", + "product": "realtime", + "slug": "sendheartbeat", + "title": "sendHeartbeat", + "type": "function", + }, + { + "id": "setauth", + "product": "realtime", + "slug": "setauth", + "title": "setAuth", + "type": "function", + }, + { + "id": "subscribe", + "product": "realtime", + "slug": "subscribe", + "title": "subscribe", + "type": "function", + }, + { + "id": "teardown", + "product": "realtime", + "slug": "teardown", + "title": "teardown", + "type": "function", + }, + { + "id": "track", + "product": "realtime", + "slug": "track", + "title": "track", + "type": "function", + }, + { + "id": "unsubscribe", + "product": "realtime", + "slug": "unsubscribe", + "title": "unsubscribe", + "type": "function", + }, + { + "id": "untrack", + "product": "realtime", + "slug": "untrack", + "title": "untrack", + "type": "function", + }, + { + "id": "updatejoinpayload", + "product": "realtime", + "slug": "updatejoinpayload", + "title": "updateJoinPayload", + "type": "function", + }, + ], + "title": "Realtime", + "type": "category", + }, + { + "items": [ + { + "id": "analytics-buckets", + "isFunc": false, + "items": [ + { + "id": "analytics-buckets", + "slug": "analytics-buckets", + "title": "Analytics Buckets", + "type": "function", + }, + { + "id": "analytics-buckets-createbucket", + "product": "storage", + "slug": "analytics-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + { + "id": "analytics-buckets-deletebucket", + "product": "storage", + "slug": "analytics-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + { + "id": "analytics-buckets-from", + "product": "storage", + "slug": "analytics-buckets-from", + "title": "from", + "type": "function", + }, + { + "id": "analytics-buckets-listbuckets", + "product": "storage", + "slug": "analytics-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + ], + "product": "storage", + "slug": "analytics-buckets", + "title": "Analytics Buckets", + "type": "function", + }, + { + "id": "file-buckets", + "isFunc": false, + "items": [ + { + "id": "file-buckets", + "slug": "file-buckets", + "title": "File Buckets", + "type": "function", + }, + { + "id": "file-buckets-copy", + "product": "storage", + "slug": "file-buckets-copy", + "title": "copy", + "type": "function", + }, + { + "id": "file-buckets-createbucket", + "product": "storage", + "slug": "file-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + { + "id": "file-buckets-createsigneduploadurl", + "product": "storage", + "slug": "file-buckets-createsigneduploadurl", + "title": "createSignedUploadUrl", + "type": "function", + }, + { + "id": "file-buckets-createsignedurl", + "product": "storage", + "slug": "file-buckets-createsignedurl", + "title": "createSignedUrl", + "type": "function", + }, + { + "id": "file-buckets-createsignedurls", + "product": "storage", + "slug": "file-buckets-createsignedurls", + "title": "createSignedUrls", + "type": "function", + }, + { + "id": "file-buckets-deletebucket", + "product": "storage", + "slug": "file-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + { + "id": "file-buckets-download", + "product": "storage", + "slug": "file-buckets-download", + "title": "download", + "type": "function", + }, + { + "id": "file-buckets-emptybucket", + "product": "storage", + "slug": "file-buckets-emptybucket", + "title": "emptyBucket", + "type": "function", + }, + { + "id": "file-buckets-exists", + "product": "storage", + "slug": "file-buckets-exists", + "title": "exists", + "type": "function", + }, + { + "id": "file-buckets-from", + "product": "storage", + "slug": "file-buckets-from", + "title": "from", + "type": "function", + }, + { + "id": "file-buckets-getbucket", + "product": "storage", + "slug": "file-buckets-getbucket", + "title": "getBucket", + "type": "function", + }, + { + "id": "file-buckets-getpublicurl", + "product": "storage", + "slug": "file-buckets-getpublicurl", + "title": "getPublicUrl", + "type": "function", + }, + { + "id": "file-buckets-info", + "product": "storage", + "slug": "file-buckets-info", + "title": "info", + "type": "function", + }, + { + "id": "file-buckets-list", + "product": "storage", + "slug": "file-buckets-list", + "title": "list", + "type": "function", + }, + { + "id": "file-buckets-listbuckets", + "product": "storage", + "slug": "file-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + { + "id": "file-buckets-listv2", + "product": "storage", + "slug": "file-buckets-listv2", + "title": "listV2", + "type": "function", + }, + { + "id": "file-buckets-move", + "product": "storage", + "slug": "file-buckets-move", + "title": "move", + "type": "function", + }, + { + "id": "file-buckets-remove", + "product": "storage", + "slug": "file-buckets-remove", + "title": "remove", + "type": "function", + }, + { + "id": "file-buckets-update", + "product": "storage", + "slug": "file-buckets-update", + "title": "update", + "type": "function", + }, + { + "id": "file-buckets-updatebucket", + "product": "storage", + "slug": "file-buckets-updatebucket", + "title": "updateBucket", + "type": "function", + }, + { + "id": "file-buckets-upload", + "product": "storage", + "slug": "file-buckets-upload", + "title": "upload", + "type": "function", + }, + { + "id": "file-buckets-uploadtosignedurl", + "product": "storage", + "slug": "file-buckets-uploadtosignedurl", + "title": "uploadToSignedUrl", + "type": "function", + }, + ], + "product": "storage", + "slug": "file-buckets", + "title": "File Buckets", + "type": "function", + }, + { + "id": "vector-buckets", + "isFunc": false, + "items": [ + { + "id": "vector-buckets", + "slug": "vector-buckets", + "title": "Vector Buckets", + "type": "function", + }, + { + "id": "vector-buckets-createbucket", + "product": "storage", + "slug": "vector-buckets-createbucket", + "title": "createBucket", + "type": "function", + }, + { + "id": "vector-buckets-createindex", + "product": "storage", + "slug": "vector-buckets-createindex", + "title": "createIndex", + "type": "function", + }, + { + "id": "vector-buckets-deletebucket", + "product": "storage", + "slug": "vector-buckets-deletebucket", + "title": "deleteBucket", + "type": "function", + }, + { + "id": "vector-buckets-deleteindex", + "product": "storage", + "slug": "vector-buckets-deleteindex", + "title": "deleteIndex", + "type": "function", + }, + { + "id": "vector-buckets-deletevectors", + "product": "storage", + "slug": "vector-buckets-deletevectors", + "title": "deleteVectors", + "type": "function", + }, + { + "id": "vector-buckets-from", + "product": "storage", + "slug": "vector-buckets-from", + "title": "from", + "type": "function", + }, + { + "id": "vector-buckets-getbucket", + "product": "storage", + "slug": "vector-buckets-getbucket", + "title": "getBucket", + "type": "function", + }, + { + "id": "vector-buckets-getindex", + "product": "storage", + "slug": "vector-buckets-getindex", + "title": "getIndex", + "type": "function", + }, + { + "id": "vector-buckets-getvectors", + "product": "storage", + "slug": "vector-buckets-getvectors", + "title": "getVectors", + "type": "function", + }, + { + "id": "vector-buckets-index", + "product": "storage", + "slug": "vector-buckets-index", + "title": "index", + "type": "function", + }, + { + "id": "vector-buckets-listbuckets", + "product": "storage", + "slug": "vector-buckets-listbuckets", + "title": "listBuckets", + "type": "function", + }, + { + "id": "vector-buckets-listindexes", + "product": "storage", + "slug": "vector-buckets-listindexes", + "title": "listIndexes", + "type": "function", + }, + { + "id": "vector-buckets-listvectors", + "product": "storage", + "slug": "vector-buckets-listvectors", + "title": "listVectors", + "type": "function", + }, + { + "id": "vector-buckets-putvectors", + "product": "storage", + "slug": "vector-buckets-putvectors", + "title": "putVectors", + "type": "function", + }, + { + "id": "vector-buckets-queryvectors", + "product": "storage", + "slug": "vector-buckets-queryvectors", + "title": "queryVectors", + "type": "function", + }, + ], + "product": "storage", + "slug": "vector-buckets", + "title": "Vector Buckets", + "type": "function", + }, + ], + "title": "Storage", + "type": "category", + }, + ], + "typeSpec": { + "methods": { + "@supabase/auth-js.AuthApiError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthApiError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "ret": { + "type": { + "name": "AuthApiError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthApiError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthApiError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "status", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "code", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthImplicitGrantRedirectError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthImplicitGrantRedirectError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "details", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "error", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + }, + ], + "ret": { + "type": { + "name": "AuthImplicitGrantRedirectError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthImplicitGrantRedirectError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthImplicitGrantRedirectError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "details", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "error", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthInvalidCredentialsError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthInvalidCredentialsError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "name": "AuthInvalidCredentialsError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthInvalidCredentialsError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthInvalidCredentialsError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthInvalidJwtError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthInvalidJwtError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "name": "AuthInvalidJwtError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthInvalidJwtError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthInvalidJwtError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthInvalidTokenResponseError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthInvalidTokenResponseError.constructor", + "params": [], + "ret": { + "type": { + "name": "AuthInvalidTokenResponseError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthInvalidTokenResponseError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthInvalidTokenResponseError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthOAuthServerApi.approveAuthorization": { + "comment": { + "shortText": "Approves an OAuth authorization request. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +After approval, the user's consent is stored and an authorization code is generated. +The response contains a complete redirect URL with the authorization code and state.", + }, + "name": "@supabase/auth-js.AuthOAuthServerApi.approveAuthorization", + "params": [ + { + "comment": { + "shortText": "The authorization ID to approve", + }, + "name": "authorizationId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Optional parameters", + }, + "isOptional": true, + "name": "options", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling).", + }, + "isOptional": true, + "name": "skipBrowserRedirect", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthOAuthConsentResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "OAuthRedirect", + "properties": [ + { + "comment": { + "shortText": "Complete redirect URL with authorization code and state parameters (e.g., "https://app.com/callback?code=xxx&state=yyy")", + }, + "name": "redirect_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthOAuthServerApi.denyAuthorization": { + "comment": { + "shortText": "Denies an OAuth authorization request. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +After denial, the response contains a redirect URL with an OAuth error +(access_denied) to inform the OAuth client that the user rejected the request.", + }, + "name": "@supabase/auth-js.AuthOAuthServerApi.denyAuthorization", + "params": [ + { + "comment": { + "shortText": "The authorization ID to deny", + }, + "name": "authorizationId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Optional parameters", + }, + "isOptional": true, + "name": "options", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling).", + }, + "isOptional": true, + "name": "skipBrowserRedirect", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthOAuthConsentResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "OAuthRedirect", + "properties": [ + { + "comment": { + "shortText": "Complete redirect URL with authorization code and state parameters (e.g., "https://app.com/callback?code=xxx&state=yyy")", + }, + "name": "redirect_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthOAuthServerApi.getAuthorizationDetails": { + "comment": { + "shortText": "Retrieves details about an OAuth authorization request. +Used to display consent information to the user. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +This method returns one of two response types: +- \`OAuthAuthorizationDetails\`: User needs to consent - show consent page with client info +- \`OAuthRedirect\`: User already consented - redirect immediately to the OAuth client + +Use type narrowing to distinguish between the responses: +\`\`\`typescript +if ('authorization_id' in data) { + // Show consent page +} else { + // Redirect to data.redirect_url +} +\`\`\`", + }, + "name": "@supabase/auth-js.AuthOAuthServerApi.getAuthorizationDetails", + "params": [ + { + "comment": { + "shortText": "The authorization ID from the authorization request", + }, + "name": "authorizationId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthOAuthAuthorizationDetailsResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "OAuthAuthorizationDetails", + "properties": [ + { + "comment": { + "shortText": "The authorization ID used to approve or deny the request", + }, + "name": "authorization_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client requesting authorization", + }, + "name": "client", + "type": { + "name": "OAuthAuthorizationClient", + "properties": [ + { + "comment": { + "shortText": "Unique identifier for the OAuth client (UUID)", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's logo", + }, + "name": "logo_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name of the OAuth client", + }, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's website", + }, + "name": "uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "comment": { + "shortText": "The OAuth client's registered redirect URI (base URI without query parameters)", + }, + "name": "redirect_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Space-separated list of requested scopes (e.g., "openid profile email")", + }, + "name": "scope", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "User object associated with the authorization", + }, + "name": "user", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "User email", + }, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "User ID (UUID)", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + { + "name": "OAuthRedirect", + "properties": [ + { + "comment": { + "shortText": "Complete redirect URL with authorization code and state parameters (e.g., "https://app.com/callback?code=xxx&state=yyy")", + }, + "name": "redirect_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthOAuthServerApi.listGrants": { + "comment": { + "shortText": "Lists all OAuth grants that the authenticated user has authorized. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.", + }, + "name": "@supabase/auth-js.AuthOAuthServerApi.listGrants", + "params": [], + "ret": { + "type": { + "awaited": { + "name": "AuthOAuthGrantsResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "elemType": { + "name": "OAuthGrant", + "properties": [ + { + "comment": { + "shortText": "OAuth client information", + }, + "name": "client", + "type": { + "name": "OAuthAuthorizationClient", + "properties": [ + { + "comment": { + "shortText": "Unique identifier for the OAuth client (UUID)", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's logo", + }, + "name": "logo_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name of the OAuth client", + }, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's website", + }, + "name": "uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "comment": { + "shortText": "Timestamp when the grant was created (ISO 8601 date-time)", + }, + "name": "granted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of scopes granted to this client", + }, + "name": "scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthOAuthServerApi.revokeGrant": { + "comment": { + "shortText": "Revokes a user's OAuth grant for a specific client. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +Revocation marks consent as revoked, deletes active sessions for that OAuth client, +and invalidates associated refresh tokens.", + }, + "name": "@supabase/auth-js.AuthOAuthServerApi.revokeGrant", + "params": [ + { + "comment": { + "shortText": "Revocation options", + }, + "name": "options", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "The OAuth client identifier (UUID) to revoke access for", + }, + "name": "clientId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthOAuthRevokeGrantResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": undefined, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthPKCECodeVerifierMissingError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthPKCECodeVerifierMissingError.constructor", + "params": [], + "ret": { + "type": { + "name": "AuthPKCECodeVerifierMissingError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthPKCECodeVerifierMissingError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthPKCECodeVerifierMissingError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "details", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "error", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + }, + ], + "ret": { + "type": { + "name": "AuthPKCEGrantCodeExchangeError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthPKCEGrantCodeExchangeError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "details", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "error", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthPasskeyApi.delete": { + "comment": { + "shortText": "Deletes a passkey for the currently signed-in user.", + }, + "name": "@supabase/auth-js.AuthPasskeyApi.delete", + "params": [ + { + "name": "params", + "type": { + "name": "PasskeyDeleteParams", + "properties": [ + { + "comment": { + "shortText": "UUID of the passkey to delete", + }, + "name": "passkeyId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyDeleteResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthPasskeyApi.list": { + "comment": { + "shortText": "Lists all passkeys registered for the currently signed-in user.", + }, + "name": "@supabase/auth-js.AuthPasskeyApi.list", + "params": [], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyListResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "elemType": { + "name": "PasskeyListItem", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_used_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthPasskeyApi.startAuthentication": { + "comment": { + "shortText": "Starts the passkey authentication ceremony. Fetches an authentication +challenge and credential request options from the server. Used as the +first step of a two-step sign-in flow when the caller wants to handle +\`navigator.credentials.get()\` themselves.", + }, + "name": "@supabase/auth-js.AuthPasskeyApi.startAuthentication", + "params": [ + { + "isOptional": true, + "name": "params", + "type": { + "name": "StartPasskeyAuthenticationParams", + "properties": [ + { + "isOptional": true, + "name": "options", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "isOptional": true, + "name": "captchaToken", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyAuthenticationOptionsResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "PasskeyAuthenticationOptionsResponse", + "properties": [ + { + "name": "challenge_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "expires_at", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "name": "options", + "type": { + "name": "ServerCredentialRequestOptions", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthPasskeyApi.startRegistration": { + "comment": { + "shortText": "Starts the passkey registration ceremony. Fetches a registration challenge +and credential creation options from the server. Used as the first step of +a two-step registration flow when the caller wants to handle +\`navigator.credentials.create()\` themselves.", + }, + "name": "@supabase/auth-js.AuthPasskeyApi.startRegistration", + "params": [], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyRegistrationOptionsResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "PasskeyRegistrationOptionsResponse", + "properties": [ + { + "name": "challenge_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "expires_at", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "name": "options", + "type": { + "name": "ServerCredentialCreationOptions", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthPasskeyApi.update": { + "comment": { + "shortText": "Updates a passkey's friendly name.", + }, + "name": "@supabase/auth-js.AuthPasskeyApi.update", + "params": [ + { + "name": "params", + "type": { + "name": "PasskeyUpdateParams", + "properties": [ + { + "comment": { + "shortText": "New friendly name (max 120 chars)", + }, + "name": "friendlyName", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "UUID of the passkey to update", + }, + "name": "passkeyId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyUpdateResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "PasskeyListItem", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_used_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthPasskeyApi.verifyAuthentication": { + "comment": { + "shortText": "Verifies a passkey authentication credential against a previously issued +challenge. Used as the second step of a two-step sign-in flow.", + }, + "name": "@supabase/auth-js.AuthPasskeyApi.verifyAuthentication", + "params": [ + { + "name": "params", + "type": { + "name": "VerifyPasskeyAuthenticationParams", + "properties": [ + { + "comment": { + "shortText": "Challenge ID from startAuthentication", + }, + "name": "challengeId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Serialized credential from navigator.credentials.get()", + }, + "name": "credential", + "type": { + "name": "ServerCredentialResponse", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyAuthenticationVerifyResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "session", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Session", + "properties": [ + { + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.", + }, + "name": "access_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed.", + }, + "isOptional": true, + "name": "expires_at", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.", + }, + "name": "expires_in", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. +Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.", + }, + "isOptional": true, + "name": "provider_refresh_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.", + }, + "isOptional": true, + "name": "provider_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "A one-time used refresh token that never expires.", + }, + "name": "refresh_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "token_type", + "type": { + "type": "literal", + "value": "bearer", + }, + }, + { + "comment": { + "shortText": "When using a separate user storage, accessing properties of this object will throw an error.", + }, + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + { + "type": "literal", + "value": null, + }, + ], + "type": "union", + }, + }, + { + "name": "user", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + { + "type": "literal", + "value": null, + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthPasskeyApi.verifyRegistration": { + "comment": { + "shortText": "Verifies a passkey registration credential against a previously issued +challenge. Used as the second step of a two-step registration flow.", + }, + "name": "@supabase/auth-js.AuthPasskeyApi.verifyRegistration", + "params": [ + { + "name": "params", + "type": { + "name": "VerifyPasskeyRegistrationParams", + "properties": [ + { + "comment": { + "shortText": "Challenge ID from startRegistration", + }, + "name": "challengeId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Serialized credential from navigator.credentials.create()", + }, + "name": "credential", + "type": { + "name": "ServerCredentialResponse", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyRegistrationVerifyResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "PasskeyMetadata", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.AuthRefreshDiscardedError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthRefreshDiscardedError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "name": "AuthRefreshDiscardedError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthRefreshDiscardedError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthRefreshDiscardedError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthRetryableFetchError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthRetryableFetchError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "name": "AuthRetryableFetchError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthRetryableFetchError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthRetryableFetchError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthSessionMissingError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthSessionMissingError.constructor", + "params": [], + "ret": { + "type": { + "name": "AuthSessionMissingError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthSessionMissingError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthSessionMissingError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthUnknownError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthUnknownError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "originalError", + "type": { + "name": "unknown", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "name": "AuthUnknownError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthUnknownError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthUnknownError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.AuthWeakPasswordError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.AuthWeakPasswordError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "name": "reasons", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "length", + }, + { + "type": "literal", + "value": "characters", + }, + { + "type": "literal", + "value": "pwned", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "ret": { + "type": { + "name": "AuthWeakPasswordError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.AuthWeakPasswordError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.AuthWeakPasswordError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "reasons", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "length", + }, + { + "type": "literal", + "value": "characters", + }, + { + "type": "literal", + "value": "pwned", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.CustomAuthError.constructor": { + "comment": undefined, + "name": "@supabase/auth-js.CustomAuthError.constructor", + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "ret": { + "type": { + "name": "CustomAuthError", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.CustomAuthError.toJSON": { + "comment": undefined, + "name": "@supabase/auth-js.CustomAuthError.toJSON", + "params": [], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "code", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + undefined, + { + "name": "ErrorCode", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "undefined", + "type": "intrinsic", + }, + { + "name": "number", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.constructor": { + "comment": { + "examples": [ + { + "code": "\`\`\`ts +import { createClient } from '@supabase/supabase-js' + +const supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key') +const { data, error } = await supabase.auth.admin.listUsers() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "using-supabase-js-recommended", + "name": "Using supabase-js (recommended)", + "response": undefined, + }, + { + "code": "\`\`\`ts +import { GoTrueAdminApi } from '@supabase/auth-js' + +const admin = new GoTrueAdminApi({ + url: 'https://xyzcompany.supabase.co/auth/v1', + headers: { Authorization: \`Bearer \${process.env.SUPABASE_SECRET_KEY}\` }, +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "standalone-import-for-bundle-sensitive-environments", + "name": "Standalone import for bundle-sensitive environments", + "response": undefined, + }, + ], + "shortText": "Creates an admin API client that can be used to manage users and OAuth clients.", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.constructor", + "params": [ + { + "name": Symbol(anonymous), + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "isOptional": true, + "name": "experimental", + "type": { + "name": "ExperimentalFeatureFlags", + "properties": [ + { + "comment": { + "shortText": "Enables passkey support: + - \`auth.signInWithPasskey()\`, \`auth.registerPasskey()\` + - \`auth.passkey.*\` + - \`auth.admin.passkey.*\` + +Defaults to \`false\`. Calling any passkey method while this flag is +disabled throws a descriptive error at call time.", + }, + "isOptional": true, + "name": "passkey", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "isOptional": true, + "name": "fetch", + "type": { + "comment": { + "shortText": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)", + }, + "name": Symbol(anonymous), + "params": [ + { + "name": "input", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "URL", + "type": "nameOnly", + }, + { + "name": "RequestInfo", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + { + "isOptional": true, + "name": "init", + "type": { + "name": "RequestInit", + "type": "nameOnly", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "Response", + "type": "nameOnly", + }, + "name": "Promise", + "type": "promise", + }, + }, + "type": "function", + }, + }, + { + "isOptional": true, + "name": "headers", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "name": "url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "name": "GoTrueAdminApi", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.createUser": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.createUser({ + email: 'user@email.com', + password: 'password', + user_metadata: { name: 'Yoda' } +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "with-custom-user-metadata", + "name": "With custom user metadata", + "response": "\`\`\`json +{ + data: { + user: { + id: '1', + aud: 'authenticated', + role: 'authenticated', + email: 'example@email.com', + email_confirmed_at: '2024-01-01T00:00:00Z', + phone: '', + confirmation_sent_at: '2024-01-01T00:00:00Z', + confirmed_at: '2024-01-01T00:00:00Z', + last_sign_in_at: '2024-01-01T00:00:00Z', + app_metadata: {}, + user_metadata: {}, + identities: [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "1", + "user_id": "1", + "identity_data": { + "email": "example@email.com", + "email_verified": true, + "phone_verified": false, + "sub": "1" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "email@example.com" + }, + ], + created_at: '2024-01-01T00:00:00Z', + updated_at: '2024-01-01T00:00:00Z', + is_anonymous: false, + } + } + error: null +} +\`\`\`", + }, + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.createUser({ + email: 'user@email.com', + email_confirm: true +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "auto-confirm-the-user-s-email", + "name": "Auto-confirm the user's email", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.createUser({ + phone: '1234567890', + phone_confirm: true +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "auto-confirm-the-user-s-phone-number", + "name": "Auto-confirm the user's phone number", + "response": undefined, + }, + ], + "shortText": "Creates a new user. +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + "text": "- To confirm the user's email address or phone number, set \`email_confirm\` or \`phone_confirm\` to true. Both arguments default to false. +- \`createUser()\` will not send a confirmation email to the user. You can use [\`inviteUserByEmail()\`](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead. +- If you are sure that the created user's email or phone number is legitimate and verified, you can set the \`email_confirm\` or \`phone_confirm\` param to \`true\`.", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.createUser", + "params": [ + { + "name": "attributes", + "type": { + "name": "AdminUserAttributes", + "properties": [ + { + "comment": { + "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column. + +Only a service role can modify. + +The \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other +access control information.", + }, + "isOptional": true, + "name": "app_metadata", + "type": { + "name": "object", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Determines how long a user is banned for. + +The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix. +Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". + +For example, some possible durations include: '300ms', '2h45m'. + +Setting the ban duration to 'none' lifts the ban on the user.", + }, + "isOptional": true, + "name": "ban_duration", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's current password + +This is only ever present when the user is resetting +their password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true.", + }, + "isOptional": true, + "name": "current_password", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's email.", + }, + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Sets the user's email as confirmed when true, or unconfirmed when false. + +Only a service role can modify.", + }, + "isOptional": true, + "name": "email_confirm", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The \`id\` for the user. + +Allows you to overwrite the default \`id\` set for the user.", + }, + "isOptional": true, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The nonce sent for reauthentication if the user's password is to be updated. + +Call reauthenticate() to obtain the nonce first.", + }, + "isOptional": true, + "name": "nonce", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's password.", + }, + "isOptional": true, + "name": "password", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The \`password_hash\` for the user's password. + +Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service. + +Supports bcrypt, scrypt (firebase), and argon2 password hashes.", + }, + "isOptional": true, + "name": "password_hash", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's phone.", + }, + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Sets the user's phone as confirmed when true, or unconfirmed when false. + +Only a service role can modify.", + }, + "isOptional": true, + "name": "phone_confirm", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The \`role\` claim set in the user's access token JWT. + +When a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database. + +Setting this role to \`service_role\` is not recommended as it grants the user admin privileges.", + }, + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column. + + +The \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name. + +Note: When using the GoTrueAdminApi and wanting to modify a user's metadata, +this attribute is used instead of UserAttributes data.", + }, + "isOptional": true, + "name": "user_metadata", + "type": { + "name": "object", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "UserResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.deleteUser": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.deleteUser( + '715ed5db-f090-4b8c-a067-640ecee36aa0' +) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "removes-a-user", + "name": "Removes a user", + "response": "\`\`\`json +{ + "data": { + "user": {} + }, + "error": null +} +\`\`\`", + }, + ], + "shortText": "Delete a user. Requires a \`service_role\` key.", + "text": "- The \`deleteUser()\` method requires the user's ID, which maps to the \`auth.users.id\` column.", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.deleteUser", + "params": [ + { + "comment": { + "shortText": "The user id you want to remove.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible. +Defaults to false for backward compatibility. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "shouldSoftDelete", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "UserResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.generateLink": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'signup', + email: 'email@example.com', + password: 'secret' +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "generate-a-signup-link", + "name": "Generate a signup link", + "response": "\`\`\`json +{ + "data": { + "properties": { + "action_link": "", + "email_otp": "999999", + "hashed_token": "", + "verification_type": "signup" + }, + "user": { + "id": "11111111-1111-1111-1111-111111111111", + "aud": "authenticated", + "role": "authenticated", + "email": "email@example.com", + "phone": "", + "confirmation_sent_at": "2024-01-01T00:00:00Z", + "app_metadata": { + "provider": "email", + "providers": [ + "email" + ] + }, + "user_metadata": {}, + "identities": [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "11111111-1111-1111-1111-111111111111", + "user_id": "11111111-1111-1111-1111-111111111111", + "identity_data": { + "email": "email@example.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "email@example.com" + } + ], + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "is_anonymous": false + } + }, + "error": null +} +\`\`\`", + }, + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'invite', + email: 'email@example.com' +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "generate-an-invite-link", + "name": "Generate an invite link", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'magiclink', + email: 'email@example.com' +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "generate-a-magic-link", + "name": "Generate a magic link", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'recovery', + email: 'email@example.com' +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "generate-a-recovery-link", + "name": "Generate a recovery link", + "response": undefined, + }, + { + "code": "\`\`\`js +// generate an email change link to be sent to the current email address +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'email_change_current', + email: 'current.email@example.com', + newEmail: 'new.email@example.com' +}) + +// generate an email change link to be sent to the new email address +const { data, error } = await supabase.auth.admin.generateLink({ + type: 'email_change_new', + email: 'current.email@example.com', + newEmail: 'new.email@example.com' +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "generate-links-to-change-current-email-address", + "name": "Generate links to change current email address", + "response": undefined, + }, + ], + "shortText": "Generates email links and OTPs to be sent via a custom email provider.", + "text": "- The following types can be passed into \`generateLink()\`: \`signup\`, \`magiclink\`, \`invite\`, \`recovery\`, \`email_change_current\`, \`email_change_new\`, \`phone_change\`. +- \`generateLink()\` only generates the email link for \`email_change_email\` if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers). +- \`generateLink()\` handles the creation of the user for \`signup\`, \`invite\` and \`magiclink\`.", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.generateLink", + "params": [ + { + "name": "params", + "type": { + "name": "GenerateLinkParams", + "subTypes": [ + { + "name": "GenerateSignupLinkParams", + "properties": [ + { + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "options", + "type": undefined, + }, + { + "name": "password", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "type", + "type": { + "type": "literal", + "value": "signup", + }, + }, + ], + "type": "object", + }, + { + "name": "GenerateInviteOrMagiclinkParams", + "properties": [ + { + "comment": { + "shortText": "The user's email", + }, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "options", + "type": undefined, + }, + { + "name": "type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "invite", + }, + { + "type": "literal", + "value": "magiclink", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + { + "name": "GenerateRecoveryLinkParams", + "properties": [ + { + "comment": { + "shortText": "The user's email", + }, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "options", + "type": undefined, + }, + { + "name": "type", + "type": { + "type": "literal", + "value": "recovery", + }, + }, + ], + "type": "object", + }, + { + "name": "GenerateEmailChangeLinkParams", + "properties": [ + { + "comment": { + "shortText": "The user's email", + }, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'.", + }, + "name": "newEmail", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "options", + "type": undefined, + }, + { + "name": "type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "email_change_current", + }, + { + "type": "literal", + "value": "email_change_new", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "GenerateLinkResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "properties", + "type": { + "name": "GenerateLinkProperties", + "properties": [ + { + "comment": { + "shortText": "The email link to send to the user. +The action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}", + }, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The raw email OTP. +You should send this in the email if you want your users to verify using an OTP instead of the action link.", + }, + "name": "email_otp", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The hashed token appended to the action link.", + }, + "name": "hashed_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The URL appended to the action link.", + }, + "name": "redirect_to", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification type that the email link is associated to.", + }, + "name": "verification_type", + "type": { + "name": "GenerateLinkType", + "subTypes": [ + { + "type": "literal", + "value": "signup", + }, + { + "type": "literal", + "value": "invite", + }, + { + "type": "literal", + "value": "magiclink", + }, + { + "type": "literal", + "value": "recovery", + }, + { + "type": "literal", + "value": "email_change_current", + }, + { + "type": "literal", + "value": "email_change_new", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "properties", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.getUserById": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.getUserById(1) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "fetch-the-user-object-using-the-access-token-jwt", + "name": "Fetch the user object using the access_token jwt", + "response": "\`\`\`json +{ + data: { + user: { + id: '1', + aud: 'authenticated', + role: 'authenticated', + email: 'example@email.com', + email_confirmed_at: '2024-01-01T00:00:00Z', + phone: '', + confirmation_sent_at: '2024-01-01T00:00:00Z', + confirmed_at: '2024-01-01T00:00:00Z', + last_sign_in_at: '2024-01-01T00:00:00Z', + app_metadata: {}, + user_metadata: {}, + identities: [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "1", + "user_id": "1", + "identity_data": { + "email": "example@email.com", + "email_verified": true, + "phone_verified": false, + "sub": "1" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "email@example.com" + }, + ], + created_at: '2024-01-01T00:00:00Z', + updated_at: '2024-01-01T00:00:00Z', + is_anonymous: false, + } + } + error: null +} +\`\`\`", + }, + ], + "shortText": "Get user by id.", + "text": "- Fetches the user object from the database based on the user's id. +- The \`getUserById()\` method requires the user's id which maps to the \`auth.users.id\` column.", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.getUserById", + "params": [ + { + "comment": { + "shortText": "The user's unique identifier + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "uid", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "UserResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.inviteUserByEmail": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com') +\`\`\`", + "data": undefined, + "description": undefined, + "id": "invite-a-user", + "name": "Invite a user", + "response": "\`\`\`json +{ + "data": { + "user": { + "id": "11111111-1111-1111-1111-111111111111", + "aud": "authenticated", + "role": "authenticated", + "email": "example@email.com", + "invited_at": "2024-01-01T00:00:00Z", + "phone": "", + "confirmation_sent_at": "2024-01-01T00:00:00Z", + "app_metadata": { + "provider": "email", + "providers": [ + "email" + ] + }, + "user_metadata": {}, + "identities": [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "11111111-1111-1111-1111-111111111111", + "user_id": "11111111-1111-1111-1111-111111111111", + "identity_data": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "example@email.com" + } + ], + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "is_anonymous": false + } + }, + "error": null +} +\`\`\`", + }, + ], + "shortText": "Sends an invite link to an email address.", + "text": "- Sends an invite link to the user's email address. +- The \`inviteUserByEmail()\` method is typically used by administrators to invite users to join the application. +- Note that PKCE is not supported when using \`inviteUserByEmail\`. This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow.", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.inviteUserByEmail", + "params": [ + { + "comment": { + "shortText": "The email address of the user.", + }, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Additional options to be included when inviting.", + }, + "name": "options", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "A custom data object to store additional metadata about the user. This maps to the \`auth.users.user_metadata\` column.", + }, + "isOptional": true, + "name": "data", + "type": { + "name": "object", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL.", + }, + "isOptional": true, + "name": "redirectTo", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "UserResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.listUsers": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data: { users }, error } = await supabase.auth.admin.listUsers() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "get-a-page-of-users", + "name": "Get a page of users", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data: { users }, error } = await supabase.auth.admin.listUsers({ + page: 1, + perPage: 1000 +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "paginated-list-of-users", + "name": "Paginated list of users", + "response": undefined, + }, + ], + "shortText": "Get a list of users. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + "text": "- Defaults to return 50 users per page.", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.listUsers", + "params": [ + { + "comment": { + "shortText": "An object which supports \`page\` and \`perPage\` as numbers, to alter the paginated results.", + }, + "isOptional": true, + "name": "params", + "type": { + "name": "PageParams", + "properties": [ + { + "comment": { + "shortText": "The page number", + }, + "isOptional": true, + "name": "page", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Number of items returned per page", + }, + "isOptional": true, + "name": "perPage", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": undefined, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "users", + "type": undefined, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.signOut": { + "comment": { + "shortText": "Removes a logged-in session.", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.signOut", + "params": [ + { + "comment": { + "shortText": "A valid, logged-in JWT.", + }, + "name": "jwt", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The logout sope.", + }, + "name": "scope", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "global", + }, + { + "type": "literal", + "value": "local", + }, + { + "type": "literal", + "value": "others", + }, + ], + "type": "union", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "AuthError", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminApi.updateUserById": { + "comment": { + "examples": [ + { + "code": "\`\`\`typescript +// Server-side (Edge Function) +const { data, error } = await supabase.auth.admin.updateUserById( + userId, + { user_metadata: { preferences: { theme: 'dark' } } } +) + +// Client-side (to sync the changes) +const { data, error } = await supabase.auth.refreshSession() +// onAuthStateChange listeners will now be notified with updated user +\`\`\`", + "data": undefined, + "description": undefined, + "id": "example-1", + "name": "Example 1", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data: user, error } = await supabase.auth.admin.updateUserById( + '11111111-1111-1111-1111-111111111111', + { email: 'new@email.com' } +) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "updates-a-user-s-email", + "name": "Updates a user's email", + "response": "\`\`\`json +{ + "data": { + "user": { + "id": "11111111-1111-1111-1111-111111111111", + "aud": "authenticated", + "role": "authenticated", + "email": "new@email.com", + "email_confirmed_at": "2024-01-01T00:00:00Z", + "phone": "", + "confirmed_at": "2024-01-01T00:00:00Z", + "recovery_sent_at": "2024-01-01T00:00:00Z", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "app_metadata": { + "provider": "email", + "providers": [ + "email" + ] + }, + "user_metadata": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "identities": [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "11111111-1111-1111-1111-111111111111", + "user_id": "11111111-1111-1111-1111-111111111111", + "identity_data": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "example@email.com" + } + ], + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "is_anonymous": false + } + }, + "error": null +} +\`\`\`", + }, + { + "code": "\`\`\`js +const { data: user, error } = await supabase.auth.admin.updateUserById( + '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4', + { password: 'new_password' } +) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "updates-a-user-s-password", + "name": "Updates a user's password", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data: user, error } = await supabase.auth.admin.updateUserById( + '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4', + { user_metadata: { hello: 'world' } } +) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "updates-a-user-s-metadata", + "name": "Updates a user's metadata", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data: user, error } = await supabase.auth.admin.updateUserById( + '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4', + { app_metadata: { plan: 'trial' } } +) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "updates-a-user-s-app-metadata", + "name": "Updates a user's app_metadata", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data: user, error } = await supabase.auth.admin.updateUserById( + '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4', + { email_confirm: true } +) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "confirms-a-user-s-email-address", + "name": "Confirms a user's email address", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data: user, error } = await supabase.auth.admin.updateUserById( + '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4', + { phone_confirm: true } +) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "confirms-a-user-s-phone-number", + "name": "Confirms a user's phone number", + "response": undefined, + }, + { + "code": "\`\`\`js +const { data: user, error } = await supabase.auth.admin.updateUserById( + '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4', + { ban_duration: '876000h' } +) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "ban-a-user-for-100-years", + "name": "Ban a user for 100 years", + "response": undefined, + }, + ], + "shortText": "Updates the user data. Changes are applied directly without confirmation flows.", + "text": "**Important:** This is a server-side operation and does **not** trigger client-side +\`onAuthStateChange\` listeners. The admin API has no connection to client state. + +To sync changes to the client after calling this method: +1. On the client, call \`supabase.auth.refreshSession()\` to fetch the updated user data +2. This will trigger the \`TOKEN_REFRESHED\` event and notify all listeners", + }, + "name": "@supabase/auth-js.GoTrueAdminApi.updateUserById", + "params": [ + { + "comment": { + "shortText": "The user's unique identifier", + }, + "name": "uid", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The data you want to update. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "attributes", + "type": { + "name": "AdminUserAttributes", + "properties": [ + { + "comment": { + "shortText": "A custom data object to store the user's application specific metadata. This maps to the \`auth.users.app_metadata\` column. + +Only a service role can modify. + +The \`app_metadata\` should be a JSON object that includes app-specific info, such as identity providers, roles, and other +access control information.", + }, + "isOptional": true, + "name": "app_metadata", + "type": { + "name": "object", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Determines how long a user is banned for. + +The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix. +Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". + +For example, some possible durations include: '300ms', '2h45m'. + +Setting the ban duration to 'none' lifts the ban on the user.", + }, + "isOptional": true, + "name": "ban_duration", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's current password + +This is only ever present when the user is resetting +their password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true.", + }, + "isOptional": true, + "name": "current_password", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's email.", + }, + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Sets the user's email as confirmed when true, or unconfirmed when false. + +Only a service role can modify.", + }, + "isOptional": true, + "name": "email_confirm", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The \`id\` for the user. + +Allows you to overwrite the default \`id\` set for the user.", + }, + "isOptional": true, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The nonce sent for reauthentication if the user's password is to be updated. + +Call reauthenticate() to obtain the nonce first.", + }, + "isOptional": true, + "name": "nonce", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's password.", + }, + "isOptional": true, + "name": "password", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The \`password_hash\` for the user's password. + +Allows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service. + +Supports bcrypt, scrypt (firebase), and argon2 password hashes.", + }, + "isOptional": true, + "name": "password_hash", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The user's phone.", + }, + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Sets the user's phone as confirmed when true, or unconfirmed when false. + +Only a service role can modify.", + }, + "isOptional": true, + "name": "phone_confirm", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The \`role\` claim set in the user's access token JWT. + +When a user signs up, this role is set to \`authenticated\` by default. You should only modify the \`role\` if you need to provision several levels of admin access that have different permissions on individual columns in your database. + +Setting this role to \`service_role\` is not recommended as it grants the user admin privileges.", + }, + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the \`auth.users.raw_user_meta_data\` column. + + +The \`user_metadata\` should be a JSON object that includes user-specific info, such as their first and last name. + +Note: When using the GoTrueAdminApi and wanting to modify a user's metadata, +this attribute is used instead of UserAttributes data.", + }, + "isOptional": true, + "name": "user_metadata", + "type": { + "name": "object", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "UserResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminCustomProvidersApi.createProvider": { + "comment": { + "shortText": "Creates a new custom OIDC/OAuth provider. + +For OIDC providers, the server fetches and validates the OpenID Connect discovery document +from the issuer's well-known endpoint (or the provided \`discovery_url\`) at creation time. +This may return a validation error (\`error_code: "validation_failed"\`) if the discovery +document is unreachable, not valid JSON, missing required fields, or if the issuer +in the document does not match the expected issuer. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.createProvider", + "params": [ + { + "name": "params", + "type": { + "name": "CreateCustomProviderParams", + "properties": [ + { + "comment": { + "shortText": "Additional client IDs accepted during token validation", + }, + "isOptional": true, + "name": "acceptable_client_ids", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Mapping of provider attributes to Supabase user attributes", + }, + "isOptional": true, + "name": "attribute_mapping", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "Additional parameters sent with the authorization request", + }, + "isOptional": true, + "name": "authorization_params", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "OAuth2 authorization URL", + }, + "isOptional": true, + "name": "authorization_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client ID", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client secret (write-only, not returned in responses)", + }, + "name": "client_secret", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC discovery URL", + }, + "isOptional": true, + "name": "discovery_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether email is optional for this provider", + }, + "isOptional": true, + "name": "email_optional", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether the provider is enabled", + }, + "isOptional": true, + "name": "enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider identifier (e.g. \`custom:mycompany\`)", + }, + "name": "identifier", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC issuer URL", + }, + "isOptional": true, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "JWKS URI for token verification", + }, + "isOptional": true, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name", + }, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether PKCE is enabled", + }, + "isOptional": true, + "name": "pkce_enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider type", + }, + "name": "provider_type", + "type": { + "name": "CustomProviderType", + "subTypes": [ + { + "type": "literal", + "value": "oauth2", + }, + { + "type": "literal", + "value": "oidc", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OAuth scopes requested during authorization", + }, + "isOptional": true, + "name": "scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Whether to skip nonce check (OIDC)", + }, + "isOptional": true, + "name": "skip_nonce_check", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 token URL", + }, + "isOptional": true, + "name": "token_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 userinfo URL", + }, + "isOptional": true, + "name": "userinfo_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "CustomProviderResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "CustomOAuthProvider", + "properties": [ + { + "comment": { + "shortText": "Additional client IDs accepted during token validation", + }, + "isOptional": true, + "name": "acceptable_client_ids", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Mapping of provider attributes to Supabase user attributes", + }, + "isOptional": true, + "name": "attribute_mapping", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "Additional parameters sent with the authorization request", + }, + "isOptional": true, + "name": "authorization_params", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "OAuth2 authorization URL", + }, + "isOptional": true, + "name": "authorization_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client ID", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the provider was created", + }, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC discovery document (OIDC providers only)", + }, + "isOptional": true, + "name": "discovery_document", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "OIDCDiscoveryDocument", + "properties": [ + { + "comment": { + "shortText": "URL of the authorization endpoint", + }, + "name": "authorization_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The issuer identifier", + }, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the JSON Web Key Set", + }, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the revocation endpoint", + }, + "isOptional": true, + "name": "revocation_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "List of supported ID token signing algorithms", + }, + "isOptional": true, + "name": "supported_id_token_signing_algs", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported response types", + }, + "isOptional": true, + "name": "supported_response_types", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported scopes", + }, + "isOptional": true, + "name": "supported_scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported subject types", + }, + "isOptional": true, + "name": "supported_subject_types", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URL of the token endpoint", + }, + "name": "token_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the userinfo endpoint", + }, + "isOptional": true, + "name": "userinfo_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "type": "literal", + "value": null, + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OIDC discovery URL", + }, + "isOptional": true, + "name": "discovery_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether email is optional for this provider", + }, + "isOptional": true, + "name": "email_optional", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether the provider is enabled", + }, + "isOptional": true, + "name": "enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Unique identifier (UUID)", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider identifier (e.g. \`custom:mycompany\`)", + }, + "name": "identifier", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC issuer URL", + }, + "isOptional": true, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "JWKS URI for token verification", + }, + "isOptional": true, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name", + }, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether PKCE is enabled", + }, + "isOptional": true, + "name": "pkce_enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider type", + }, + "name": "provider_type", + "type": { + "name": "CustomProviderType", + "subTypes": [ + { + "type": "literal", + "value": "oauth2", + }, + { + "type": "literal", + "value": "oidc", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OAuth scopes requested during authorization", + }, + "isOptional": true, + "name": "scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Whether to skip nonce check (OIDC)", + }, + "isOptional": true, + "name": "skip_nonce_check", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 token URL", + }, + "isOptional": true, + "name": "token_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the provider was last updated", + }, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 userinfo URL", + }, + "isOptional": true, + "name": "userinfo_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminCustomProvidersApi.deleteProvider": { + "comment": { + "shortText": "Deletes a custom provider. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.deleteProvider", + "params": [ + { + "name": "identifier", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "AuthError", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminCustomProvidersApi.getProvider": { + "comment": { + "shortText": "Gets details of a specific custom provider by identifier. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.getProvider", + "params": [ + { + "name": "identifier", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "CustomProviderResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "CustomOAuthProvider", + "properties": [ + { + "comment": { + "shortText": "Additional client IDs accepted during token validation", + }, + "isOptional": true, + "name": "acceptable_client_ids", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Mapping of provider attributes to Supabase user attributes", + }, + "isOptional": true, + "name": "attribute_mapping", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "Additional parameters sent with the authorization request", + }, + "isOptional": true, + "name": "authorization_params", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "OAuth2 authorization URL", + }, + "isOptional": true, + "name": "authorization_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client ID", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the provider was created", + }, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC discovery document (OIDC providers only)", + }, + "isOptional": true, + "name": "discovery_document", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "OIDCDiscoveryDocument", + "properties": [ + { + "comment": { + "shortText": "URL of the authorization endpoint", + }, + "name": "authorization_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The issuer identifier", + }, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the JSON Web Key Set", + }, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the revocation endpoint", + }, + "isOptional": true, + "name": "revocation_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "List of supported ID token signing algorithms", + }, + "isOptional": true, + "name": "supported_id_token_signing_algs", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported response types", + }, + "isOptional": true, + "name": "supported_response_types", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported scopes", + }, + "isOptional": true, + "name": "supported_scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported subject types", + }, + "isOptional": true, + "name": "supported_subject_types", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URL of the token endpoint", + }, + "name": "token_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the userinfo endpoint", + }, + "isOptional": true, + "name": "userinfo_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "type": "literal", + "value": null, + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OIDC discovery URL", + }, + "isOptional": true, + "name": "discovery_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether email is optional for this provider", + }, + "isOptional": true, + "name": "email_optional", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether the provider is enabled", + }, + "isOptional": true, + "name": "enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Unique identifier (UUID)", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider identifier (e.g. \`custom:mycompany\`)", + }, + "name": "identifier", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC issuer URL", + }, + "isOptional": true, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "JWKS URI for token verification", + }, + "isOptional": true, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name", + }, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether PKCE is enabled", + }, + "isOptional": true, + "name": "pkce_enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider type", + }, + "name": "provider_type", + "type": { + "name": "CustomProviderType", + "subTypes": [ + { + "type": "literal", + "value": "oauth2", + }, + { + "type": "literal", + "value": "oidc", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OAuth scopes requested during authorization", + }, + "isOptional": true, + "name": "scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Whether to skip nonce check (OIDC)", + }, + "isOptional": true, + "name": "skip_nonce_check", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 token URL", + }, + "isOptional": true, + "name": "token_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the provider was last updated", + }, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 userinfo URL", + }, + "isOptional": true, + "name": "userinfo_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminCustomProvidersApi.listProviders": { + "comment": { + "shortText": "Lists all custom providers with optional type filter. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.listProviders", + "params": [ + { + "isOptional": true, + "name": "params", + "type": { + "name": "ListCustomProvidersParams", + "properties": [ + { + "comment": { + "shortText": "Filter by provider type", + }, + "isOptional": true, + "name": "type", + "type": { + "name": "CustomProviderType", + "subTypes": [ + { + "type": "literal", + "value": "oauth2", + }, + { + "type": "literal", + "value": "oidc", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "CustomProviderListResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "providers", + "type": { + "elemType": { + "name": "CustomOAuthProvider", + "properties": [ + { + "comment": { + "shortText": "Additional client IDs accepted during token validation", + }, + "isOptional": true, + "name": "acceptable_client_ids", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Mapping of provider attributes to Supabase user attributes", + }, + "isOptional": true, + "name": "attribute_mapping", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "Additional parameters sent with the authorization request", + }, + "isOptional": true, + "name": "authorization_params", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "OAuth2 authorization URL", + }, + "isOptional": true, + "name": "authorization_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client ID", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the provider was created", + }, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC discovery document (OIDC providers only)", + }, + "isOptional": true, + "name": "discovery_document", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "OIDCDiscoveryDocument", + "properties": [ + { + "comment": { + "shortText": "URL of the authorization endpoint", + }, + "name": "authorization_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The issuer identifier", + }, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the JSON Web Key Set", + }, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the revocation endpoint", + }, + "isOptional": true, + "name": "revocation_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "List of supported ID token signing algorithms", + }, + "isOptional": true, + "name": "supported_id_token_signing_algs", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported response types", + }, + "isOptional": true, + "name": "supported_response_types", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported scopes", + }, + "isOptional": true, + "name": "supported_scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported subject types", + }, + "isOptional": true, + "name": "supported_subject_types", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URL of the token endpoint", + }, + "name": "token_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the userinfo endpoint", + }, + "isOptional": true, + "name": "userinfo_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "type": "literal", + "value": null, + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OIDC discovery URL", + }, + "isOptional": true, + "name": "discovery_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether email is optional for this provider", + }, + "isOptional": true, + "name": "email_optional", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether the provider is enabled", + }, + "isOptional": true, + "name": "enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Unique identifier (UUID)", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider identifier (e.g. \`custom:mycompany\`)", + }, + "name": "identifier", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC issuer URL", + }, + "isOptional": true, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "JWKS URI for token verification", + }, + "isOptional": true, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name", + }, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether PKCE is enabled", + }, + "isOptional": true, + "name": "pkce_enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider type", + }, + "name": "provider_type", + "type": { + "name": "CustomProviderType", + "subTypes": [ + { + "type": "literal", + "value": "oauth2", + }, + { + "type": "literal", + "value": "oidc", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OAuth scopes requested during authorization", + }, + "isOptional": true, + "name": "scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Whether to skip nonce check (OIDC)", + }, + "isOptional": true, + "name": "skip_nonce_check", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 token URL", + }, + "isOptional": true, + "name": "token_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the provider was last updated", + }, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 userinfo URL", + }, + "isOptional": true, + "name": "userinfo_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "providers", + "type": undefined, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminCustomProvidersApi.updateProvider": { + "comment": { + "shortText": "Updates an existing custom provider. + +When \`issuer\` or \`discovery_url\` is changed on an OIDC provider, the server re-fetches and +validates the discovery document before persisting. This may return a validation error +(\`error_code: "validation_failed"\`) if the discovery document is unreachable, invalid, or +the issuer does not match. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminCustomProvidersApi.updateProvider", + "params": [ + { + "name": "identifier", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "params", + "type": { + "name": "UpdateCustomProviderParams", + "properties": [ + { + "comment": { + "shortText": "Additional client IDs accepted during token validation", + }, + "isOptional": true, + "name": "acceptable_client_ids", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Mapping of provider attributes to Supabase user attributes", + }, + "isOptional": true, + "name": "attribute_mapping", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "Additional parameters sent with the authorization request", + }, + "isOptional": true, + "name": "authorization_params", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "OAuth2 authorization URL", + }, + "isOptional": true, + "name": "authorization_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client ID", + }, + "isOptional": true, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client secret (write-only, not returned in responses)", + }, + "isOptional": true, + "name": "client_secret", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC discovery URL", + }, + "isOptional": true, + "name": "discovery_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether email is optional for this provider", + }, + "isOptional": true, + "name": "email_optional", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether the provider is enabled", + }, + "isOptional": true, + "name": "enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC issuer URL", + }, + "isOptional": true, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "JWKS URI for token verification", + }, + "isOptional": true, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name", + }, + "isOptional": true, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether PKCE is enabled", + }, + "isOptional": true, + "name": "pkce_enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth scopes requested during authorization", + }, + "isOptional": true, + "name": "scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Whether to skip nonce check (OIDC)", + }, + "isOptional": true, + "name": "skip_nonce_check", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 token URL", + }, + "isOptional": true, + "name": "token_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 userinfo URL", + }, + "isOptional": true, + "name": "userinfo_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "CustomProviderResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "CustomOAuthProvider", + "properties": [ + { + "comment": { + "shortText": "Additional client IDs accepted during token validation", + }, + "isOptional": true, + "name": "acceptable_client_ids", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Mapping of provider attributes to Supabase user attributes", + }, + "isOptional": true, + "name": "attribute_mapping", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "Additional parameters sent with the authorization request", + }, + "isOptional": true, + "name": "authorization_params", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": "Record", + "type": "record", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "OAuth2 authorization URL", + }, + "isOptional": true, + "name": "authorization_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth client ID", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the provider was created", + }, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC discovery document (OIDC providers only)", + }, + "isOptional": true, + "name": "discovery_document", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "OIDCDiscoveryDocument", + "properties": [ + { + "comment": { + "shortText": "URL of the authorization endpoint", + }, + "name": "authorization_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The issuer identifier", + }, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the JSON Web Key Set", + }, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the revocation endpoint", + }, + "isOptional": true, + "name": "revocation_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "List of supported ID token signing algorithms", + }, + "isOptional": true, + "name": "supported_id_token_signing_algs", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported response types", + }, + "isOptional": true, + "name": "supported_response_types", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported scopes", + }, + "isOptional": true, + "name": "supported_scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "List of supported subject types", + }, + "isOptional": true, + "name": "supported_subject_types", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URL of the token endpoint", + }, + "name": "token_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URL of the userinfo endpoint", + }, + "isOptional": true, + "name": "userinfo_endpoint", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "type": "literal", + "value": null, + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OIDC discovery URL", + }, + "isOptional": true, + "name": "discovery_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether email is optional for this provider", + }, + "isOptional": true, + "name": "email_optional", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether the provider is enabled", + }, + "isOptional": true, + "name": "enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Unique identifier (UUID)", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider identifier (e.g. \`custom:mycompany\`)", + }, + "name": "identifier", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OIDC issuer URL", + }, + "isOptional": true, + "name": "issuer", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "JWKS URI for token verification", + }, + "isOptional": true, + "name": "jwks_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name", + }, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Whether PKCE is enabled", + }, + "isOptional": true, + "name": "pkce_enabled", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Provider type", + }, + "name": "provider_type", + "type": { + "name": "CustomProviderType", + "subTypes": [ + { + "type": "literal", + "value": "oauth2", + }, + { + "type": "literal", + "value": "oidc", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OAuth scopes requested during authorization", + }, + "isOptional": true, + "name": "scopes", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Whether to skip nonce check (OIDC)", + }, + "isOptional": true, + "name": "skip_nonce_check", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 token URL", + }, + "isOptional": true, + "name": "token_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the provider was last updated", + }, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "OAuth2 userinfo URL", + }, + "isOptional": true, + "name": "userinfo_url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminMFAApi.deleteFactor": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.mfa.deleteFactor({ + id: '34e770dd-9ff9-416c-87fa-43b31d7ef225', + userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b', +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "delete-a-factor-for-a-user", + "name": "Delete a factor for a user", + "response": "\`\`\`json +{ + data: { + id: '34e770dd-9ff9-416c-87fa-43b31d7ef225' + }, + error: null +} +\`\`\`", + }, + ], + "shortText": "Deletes a factor on a user. This will log the user out of all active +sessions if the deleted factor was verified.", + }, + "name": "@supabase/auth-js.GoTrueAdminMFAApi.deleteFactor", + "params": [ + { + "name": "params", + "type": { + "name": "AuthMFAAdminDeleteFactorParams", + "properties": [ + { + "comment": { + "shortText": "ID of the MFA factor to delete.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the user whose factor is being deleted.", + }, + "name": "userId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthMFAAdminDeleteFactorResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "ID of the factor that was successfully deleted.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminMFAApi.listFactors": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.admin.mfa.listFactors() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "list-all-factors-for-a-user", + "name": "List all factors for a user", + "response": "\`\`\`json +{ + data: { + factors: Factor[ + { + id: '', + friendly_name: 'Auth App Factor', + factor_type: 'totp', + status: 'verified', + created_at: '2024-01-01T00:00:00Z', + updated_at: '2024-01-01T00:00:00Z' + } + ] + }, + error: null +} +\`\`\`", + }, + ], + "shortText": "Lists all factors associated to a user.", + }, + "name": "@supabase/auth-js.GoTrueAdminMFAApi.listFactors", + "params": [ + { + "name": "params", + "type": { + "name": "AuthMFAAdminListFactorsParams", + "properties": [ + { + "comment": { + "shortText": "ID of the user.", + }, + "name": "userId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthMFAAdminListFactorsResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "All factors attached to the user.", + }, + "name": "factors", + "type": { + "elemType": { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": "Type", + "type": "nameOnly", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": "Status", + "type": "nameOnly", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminOAuthApi.createClient": { + "comment": { + "shortText": "Creates a new OAuth client. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminOAuthApi.createClient", + "params": [ + { + "name": "params", + "type": { + "name": "CreateOAuthClientParams", + "properties": [ + { + "comment": { + "shortText": "Human-readable name of the OAuth client", + }, + "name": "client_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client", + }, + "isOptional": true, + "name": "client_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)", + }, + "isOptional": true, + "name": "grant_types", + "type": { + "elemType": { + "name": "OAuthClientGrantType", + "subTypes": [ + { + "type": "literal", + "value": "authorization_code", + }, + { + "type": "literal", + "value": "refresh_token", + }, + undefined, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Array of allowed redirect URIs", + }, + "name": "redirect_uris", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Array of allowed response types (optional, defaults to code)", + }, + "isOptional": true, + "name": "response_types", + "type": { + "elemType": { + "name": "OAuthClientResponseType", + "type": "literal", + "value": "code", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Scope of the OAuth client", + }, + "isOptional": true, + "name": "scope", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Token endpoint authentication method (defaults to server default if not specified)", + }, + "isOptional": true, + "name": "token_endpoint_auth_method", + "type": { + "name": "OAuthClientTokenEndpointAuthMethod", + "subTypes": [ + { + "type": "literal", + "value": "none", + }, + { + "type": "literal", + "value": "client_secret_basic", + }, + { + "type": "literal", + "value": "client_secret_post", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "OAuthClientResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "OAuthClient", + "properties": [ + { + "comment": { + "shortText": "Unique identifier for the OAuth client", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name of the OAuth client", + }, + "name": "client_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Client secret (only returned on registration and regeneration)", + }, + "isOptional": true, + "name": "client_secret", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of OAuth client", + }, + "name": "client_type", + "type": { + "name": "OAuthClientType", + "subTypes": [ + { + "type": "literal", + "value": "public", + }, + { + "type": "literal", + "value": "confidential", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client", + }, + "isOptional": true, + "name": "client_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the client was created", + }, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed grant types", + }, + "name": "grant_types", + "type": { + "elemType": { + "name": "OAuthClientGrantType", + "subTypes": [ + { + "type": "literal", + "value": "authorization_code", + }, + { + "type": "literal", + "value": "refresh_token", + }, + undefined, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's logo", + }, + "isOptional": true, + "name": "logo_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed redirect URIs", + }, + "name": "redirect_uris", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Registration type of the client", + }, + "name": "registration_type", + "type": { + "name": "OAuthClientRegistrationType", + "subTypes": [ + { + "type": "literal", + "value": "dynamic", + }, + { + "type": "literal", + "value": "manual", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Array of allowed response types", + }, + "name": "response_types", + "type": { + "elemType": { + "name": "OAuthClientResponseType", + "type": "literal", + "value": "code", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Scope of the OAuth client", + }, + "isOptional": true, + "name": "scope", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Token endpoint authentication method", + }, + "name": "token_endpoint_auth_method", + "type": { + "name": "OAuthClientTokenEndpointAuthMethod", + "subTypes": [ + { + "type": "literal", + "value": "none", + }, + { + "type": "literal", + "value": "client_secret_basic", + }, + { + "type": "literal", + "value": "client_secret_post", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Timestamp when the client was last updated", + }, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminOAuthApi.deleteClient": { + "comment": { + "shortText": "Deletes an OAuth client. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminOAuthApi.deleteClient", + "params": [ + { + "name": "clientId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "AuthError", + "type": "nameOnly", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminOAuthApi.getClient": { + "comment": { + "shortText": "Gets details of a specific OAuth client. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminOAuthApi.getClient", + "params": [ + { + "name": "clientId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "OAuthClientResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "OAuthClient", + "properties": [ + { + "comment": { + "shortText": "Unique identifier for the OAuth client", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name of the OAuth client", + }, + "name": "client_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Client secret (only returned on registration and regeneration)", + }, + "isOptional": true, + "name": "client_secret", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of OAuth client", + }, + "name": "client_type", + "type": { + "name": "OAuthClientType", + "subTypes": [ + { + "type": "literal", + "value": "public", + }, + { + "type": "literal", + "value": "confidential", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client", + }, + "isOptional": true, + "name": "client_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the client was created", + }, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed grant types", + }, + "name": "grant_types", + "type": { + "elemType": { + "name": "OAuthClientGrantType", + "subTypes": [ + { + "type": "literal", + "value": "authorization_code", + }, + { + "type": "literal", + "value": "refresh_token", + }, + undefined, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's logo", + }, + "isOptional": true, + "name": "logo_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed redirect URIs", + }, + "name": "redirect_uris", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Registration type of the client", + }, + "name": "registration_type", + "type": { + "name": "OAuthClientRegistrationType", + "subTypes": [ + { + "type": "literal", + "value": "dynamic", + }, + { + "type": "literal", + "value": "manual", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Array of allowed response types", + }, + "name": "response_types", + "type": { + "elemType": { + "name": "OAuthClientResponseType", + "type": "literal", + "value": "code", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Scope of the OAuth client", + }, + "isOptional": true, + "name": "scope", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Token endpoint authentication method", + }, + "name": "token_endpoint_auth_method", + "type": { + "name": "OAuthClientTokenEndpointAuthMethod", + "subTypes": [ + { + "type": "literal", + "value": "none", + }, + { + "type": "literal", + "value": "client_secret_basic", + }, + { + "type": "literal", + "value": "client_secret_post", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Timestamp when the client was last updated", + }, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminOAuthApi.listClients": { + "comment": { + "shortText": "Lists all OAuth clients with optional pagination. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminOAuthApi.listClients", + "params": [ + { + "isOptional": true, + "name": "params", + "type": { + "name": "PageParams", + "properties": [ + { + "comment": { + "shortText": "The page number", + }, + "isOptional": true, + "name": "page", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Number of items returned per page", + }, + "isOptional": true, + "name": "perPage", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "OAuthClientListResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": undefined, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "clients", + "type": undefined, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminOAuthApi.regenerateClientSecret": { + "comment": { + "shortText": "Regenerates the secret for an OAuth client. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminOAuthApi.regenerateClientSecret", + "params": [ + { + "name": "clientId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "OAuthClientResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "OAuthClient", + "properties": [ + { + "comment": { + "shortText": "Unique identifier for the OAuth client", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name of the OAuth client", + }, + "name": "client_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Client secret (only returned on registration and regeneration)", + }, + "isOptional": true, + "name": "client_secret", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of OAuth client", + }, + "name": "client_type", + "type": { + "name": "OAuthClientType", + "subTypes": [ + { + "type": "literal", + "value": "public", + }, + { + "type": "literal", + "value": "confidential", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client", + }, + "isOptional": true, + "name": "client_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the client was created", + }, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed grant types", + }, + "name": "grant_types", + "type": { + "elemType": { + "name": "OAuthClientGrantType", + "subTypes": [ + { + "type": "literal", + "value": "authorization_code", + }, + { + "type": "literal", + "value": "refresh_token", + }, + undefined, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's logo", + }, + "isOptional": true, + "name": "logo_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed redirect URIs", + }, + "name": "redirect_uris", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Registration type of the client", + }, + "name": "registration_type", + "type": { + "name": "OAuthClientRegistrationType", + "subTypes": [ + { + "type": "literal", + "value": "dynamic", + }, + { + "type": "literal", + "value": "manual", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Array of allowed response types", + }, + "name": "response_types", + "type": { + "elemType": { + "name": "OAuthClientResponseType", + "type": "literal", + "value": "code", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Scope of the OAuth client", + }, + "isOptional": true, + "name": "scope", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Token endpoint authentication method", + }, + "name": "token_endpoint_auth_method", + "type": { + "name": "OAuthClientTokenEndpointAuthMethod", + "subTypes": [ + { + "type": "literal", + "value": "none", + }, + { + "type": "literal", + "value": "client_secret_basic", + }, + { + "type": "literal", + "value": "client_secret_post", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Timestamp when the client was last updated", + }, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminOAuthApi.updateClient": { + "comment": { + "shortText": "Updates an existing OAuth client. +Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminOAuthApi.updateClient", + "params": [ + { + "name": "clientId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "params", + "type": { + "name": "UpdateOAuthClientParams", + "properties": [ + { + "comment": { + "shortText": "Human-readable name of the OAuth client", + }, + "isOptional": true, + "name": "client_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client", + }, + "isOptional": true, + "name": "client_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed grant types", + }, + "isOptional": true, + "name": "grant_types", + "type": { + "elemType": { + "name": "OAuthClientGrantType", + "subTypes": [ + { + "type": "literal", + "value": "authorization_code", + }, + { + "type": "literal", + "value": "refresh_token", + }, + undefined, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's logo", + }, + "isOptional": true, + "name": "logo_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed redirect URIs", + }, + "isOptional": true, + "name": "redirect_uris", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Token endpoint authentication method", + }, + "isOptional": true, + "name": "token_endpoint_auth_method", + "type": { + "name": "OAuthClientTokenEndpointAuthMethod", + "subTypes": [ + { + "type": "literal", + "value": "none", + }, + { + "type": "literal", + "value": "client_secret_basic", + }, + { + "type": "literal", + "value": "client_secret_post", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "OAuthClientResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": "OAuthClient", + "properties": [ + { + "comment": { + "shortText": "Unique identifier for the OAuth client", + }, + "name": "client_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Human-readable name of the OAuth client", + }, + "name": "client_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Client secret (only returned on registration and regeneration)", + }, + "isOptional": true, + "name": "client_secret", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of OAuth client", + }, + "name": "client_type", + "type": { + "name": "OAuthClientType", + "subTypes": [ + { + "type": "literal", + "value": "public", + }, + { + "type": "literal", + "value": "confidential", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client", + }, + "isOptional": true, + "name": "client_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Timestamp when the client was created", + }, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed grant types", + }, + "name": "grant_types", + "type": { + "elemType": { + "name": "OAuthClientGrantType", + "subTypes": [ + { + "type": "literal", + "value": "authorization_code", + }, + { + "type": "literal", + "value": "refresh_token", + }, + undefined, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "URI of the OAuth client's logo", + }, + "isOptional": true, + "name": "logo_uri", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Array of allowed redirect URIs", + }, + "name": "redirect_uris", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Registration type of the client", + }, + "name": "registration_type", + "type": { + "name": "OAuthClientRegistrationType", + "subTypes": [ + { + "type": "literal", + "value": "dynamic", + }, + { + "type": "literal", + "value": "manual", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Array of allowed response types", + }, + "name": "response_types", + "type": { + "elemType": { + "name": "OAuthClientResponseType", + "type": "literal", + "value": "code", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "comment": { + "shortText": "Scope of the OAuth client", + }, + "isOptional": true, + "name": "scope", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Token endpoint authentication method", + }, + "name": "token_endpoint_auth_method", + "type": { + "name": "OAuthClientTokenEndpointAuthMethod", + "subTypes": [ + { + "type": "literal", + "value": "none", + }, + { + "type": "literal", + "value": "client_secret_basic", + }, + { + "type": "literal", + "value": "client_secret_post", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Timestamp when the client was last updated", + }, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminPasskeyApi.deletePasskey": { + "comment": { + "shortText": "Deletes a specific passkey for a specific user. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminPasskeyApi.deletePasskey", + "params": [ + { + "name": "params", + "type": { + "name": "AuthPasskeyAdminDeleteParams", + "properties": [ + { + "name": "passkeyId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "userId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyDeleteResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueAdminPasskeyApi.listPasskeys": { + "comment": { + "shortText": "Lists all passkeys registered for a specific user. + +This function should only be called on a server. Never expose your \`service_role\` key in the browser.", + }, + "name": "@supabase/auth-js.GoTrueAdminPasskeyApi.listPasskeys", + "params": [ + { + "name": "params", + "type": { + "name": "AuthPasskeyAdminListParams", + "properties": [ + { + "name": "userId", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthPasskeyListResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "elemType": { + "name": "PasskeyListItem", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_used_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": undefined, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.constructor": { + "comment": { + "examples": [ + { + "code": "\`\`\`ts +import { createClient } from '@supabase/supabase-js' + +const supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key') +const { data, error } = await supabase.auth.getUser() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "using-supabase-js-recommended", + "name": "Using supabase-js (recommended)", + "response": undefined, + }, + { + "code": "\`\`\`ts +import { GoTrueClient } from '@supabase/auth-js' + +const auth = new GoTrueClient({ + url: 'https://xyzcompany.supabase.co/auth/v1', + headers: { apikey: 'your-publishable-key' }, + storageKey: 'supabase-auth', +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "standalone-import-for-bundle-sensitive-environments", + "name": "Standalone import for bundle-sensitive environments", + "response": undefined, + }, + ], + "shortText": "Create a new client for use in the browser.", + }, + "name": "@supabase/auth-js.GoTrueClient.constructor", + "params": [ + { + "name": "options", + "type": { + "name": "GoTrueClientOptions", + "properties": [ + { + "isOptional": true, + "name": "autoRefreshToken", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "debug", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "boolean", + "type": "intrinsic", + }, + { + "comment": undefined, + "name": Symbol(anonymous), + "params": [ + { + "name": "message", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "args", + "type": { + "elemType": { + "name": "any", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "ret": { + "type": { + "name": "void", + "type": "intrinsic", + }, + }, + "type": "function", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "examples": [ + { + "code": "\`\`\`ts +detectSessionInUrl: (url, params) => { + // Ignore Facebook OAuth redirects + if (url.pathname === '/facebook/redirect') return false + // Use default detection for other URLs + return Boolean(params.access_token || params.error_description) +} +\`\`\`", + "data": undefined, + "description": undefined, + "id": "example-1", + "name": "Example 1", + "response": undefined, + }, + ], + "shortText": "Set to "true" if you want to automatically detect OAuth grants in the URL and sign in the user. +Set to "false" to disable automatic detection. +Set to a function to provide custom logic for determining if a URL contains a Supabase auth callback. +The function receives the current URL and parsed parameters, and should return true if the URL +should be processed as a Supabase auth callback, or false to ignore it. + +This is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return +access_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth.", + }, + "isOptional": true, + "name": "detectSessionInUrl", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "boolean", + "type": "intrinsic", + }, + { + "comment": undefined, + "name": Symbol(anonymous), + "params": [ + { + "name": "url", + "type": { + "name": "URL", + "type": "nameOnly", + }, + }, + { + "name": "params", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + ], + "ret": { + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + "type": "function", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Opt-in flags for experimental features. These APIs may change without +notice and are disabled by default.", + "tags": [ + { + "tag": "experimental", + "text": "", + }, + ], + }, + "isOptional": true, + "name": "experimental", + "type": { + "name": "ExperimentalFeatureFlags", + "properties": [ + { + "comment": { + "shortText": "Enables passkey support: + - \`auth.signInWithPasskey()\`, \`auth.registerPasskey()\` + - \`auth.passkey.*\` + - \`auth.admin.passkey.*\` + +Defaults to \`false\`. Calling any passkey method while this flag is +disabled throws a descriptive error at call time.", + }, + "isOptional": true, + "name": "passkey", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "isOptional": true, + "name": "fetch", + "type": { + "name": "Fetch", + "type": "nameOnly", + }, + }, + { + "isOptional": true, + "name": "flowType", + "type": { + "name": "AuthFlowType", + "subTypes": [ + { + "type": "literal", + "value": "implicit", + }, + { + "type": "literal", + "value": "pkce", + }, + undefined, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Set to "true" if there is a custom authorization header set globally.", + "tags": [ + { + "tag": "experimental", + "text": "", + }, + ], + }, + "isOptional": true, + "name": "hasCustomAuthorizationHeader", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "headers", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "Provide your own locking mechanism based on the environment. By default +the client coordinates refreshes itself (single-flight via +\`refreshingDeferred\` + commit guard) and relies on the GoTrue server to +resolve cross-tab refresh races. Passing a custom lock opts into a +legacy path that wraps every auth operation in your supplied lock — this +path is preserved for backwards compatibility (typically React Native +\`processLock\` or Node multi-process setups).", + }, + "isOptional": true, + "name": "lock", + "type": { + "comment": undefined, + "name": "LockFunc", + "params": [ + { + "comment": { + "shortText": "Name of the lock to be acquired.", + }, + "name": "name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "If negative, no timeout should occur. If positive it + should throw an Error with an \`isAcquireTimeout\` + property set to true if the operation fails to be + acquired after this much time (ms).", + }, + "name": "acquireTimeout", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The operation to execute when the lock is acquired.", + }, + "name": "fn", + "type": { + "comment": undefined, + "name": Symbol(anonymous), + "params": [], + "ret": { + "type": { + "awaited": { + "name": "R", + "type": "nameOnly", + }, + "name": "Promise", + "type": "promise", + }, + }, + "type": "function", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "R", + "type": "nameOnly", + }, + "name": "Promise", + "type": "promise", + }, + }, + "type": "function", + }, + }, + { + "comment": { + "shortText": "The maximum time in milliseconds to wait for acquiring the custom lock +supplied via the \`lock\` option. Only consulted when a custom \`lock\` is +passed — the default lockless path doesn't use this timeout.", + }, + "isOptional": true, + "name": "lockAcquireTimeout", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "persistSession", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "If true, skips automatic initialization in constructor. Useful for SSR +contexts where initialization timing must be controlled to prevent race +conditions with HTTP response generation.", + }, + "isOptional": true, + "name": "skipAutoInitialize", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "storage", + "type": { + "name": "SupportedStorage", + "type": "nameOnly", + }, + }, + { + "isOptional": true, + "name": "storageKey", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "If there is an error with the query, throwOnError will reject the promise by +throwing the error instead of returning it as part of a successful response.", + }, + "isOptional": true, + "name": "throwOnError", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Stores the user object in a separate storage location from the rest of the session data. When non-null, \`storage\` will only store a JSON object containing the access and refresh token and some adjacent metadata, while \`userStorage\` will only contain the user object under the key \`storageKey + '-user'\`. + +When this option is set and cookie storage is used, \`getSession()\` and other functions that load a session from the cookie store might not return back a user. It's very important to always use \`getUser()\` to fetch a user object in those scenarios.", + "tags": [ + { + "tag": "experimental", + "text": "", + }, + ], + }, + "isOptional": true, + "name": "userStorage", + "type": { + "name": "SupportedStorage", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "name": "GoTrueClient", + "type": "nameOnly", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.dispose": { + "comment": { + "examples": [ + { + "code": "\`\`\`ts +useEffect(() => { + const client = createClient(...) + return () => { client.auth.dispose() } +}, []) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "cleanup-on-react-unmount", + "name": "Cleanup on React unmount", + "response": undefined, + }, + ], + "shortText": "Tears down the client's background work: stops the auto-refresh interval, +removes the \`visibilitychange\` listener, closes the cross-tab +\`BroadcastChannel\`, and clears registered \`onAuthStateChange\` subscribers. + +Call this from cleanup hooks when the client is being replaced before +its JS realm is destroyed. React Strict Mode and HMR are the common +cases. Any in-flight \`fetch\` calls continue to completion and may still +write to storage; dispose doesn't abort them or erase storage. + +Lifecycle caveat: because in-flight refreshes are not aborted, a +disposed instance can still persist a rotated session to storage after +\`dispose()\` returns. A subsequent \`createClient\` against the same +\`storageKey\` will pick up that session on its next read. If you need +strict isolation between client lifecycles, await any pending auth +operation before calling \`dispose()\` (or change the \`storageKey\` for +the replacement client). + +Safe to call repeatedly.", + }, + "name": "@supabase/auth-js.GoTrueClient.dispose", + "params": [], + "ret": { + "type": { + "awaited": { + "name": "void", + "type": "intrinsic", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.exchangeCodeForSession": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +supabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225') +\`\`\`", + "data": undefined, + "description": undefined, + "id": "exchange-auth-code", + "name": "Exchange Auth Code", + "response": "\`\`\`json +{ + "data": { + session: { + access_token: '', + token_type: 'bearer', + expires_in: 3600, + expires_at: 1700000000, + refresh_token: '', + user: { + id: '11111111-1111-1111-1111-111111111111', + aud: 'authenticated', + role: 'authenticated', + email: 'example@email.com' + email_confirmed_at: '2024-01-01T00:00:00Z', + phone: '', + confirmation_sent_at: '2024-01-01T00:00:00Z', + confirmed_at: '2024-01-01T00:00:00Z', + last_sign_in_at: '2024-01-01T00:00:00Z', + app_metadata: { + "provider": "email", + "providers": [ + "email", + "" + ] + }, + user_metadata: { + email: 'email@email.com', + email_verified: true, + full_name: 'User Name', + iss: '', + name: 'User Name', + phone_verified: false, + provider_id: '', + sub: '' + }, + identities: [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "11111111-1111-1111-1111-111111111111", + "user_id": "11111111-1111-1111-1111-111111111111", + "identity_data": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "email@example.com" + }, + { + "identity_id": "33333333-3333-3333-3333-333333333333", + "id": "", + "user_id": "", + "identity_data": { + "email": "example@email.com", + "email_verified": true, + "full_name": "User Name", + "iss": "", + "name": "User Name", + "phone_verified": false, + "provider_id": "", + "sub": "" + }, + "provider": "", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "example@email.com" + } + ], + created_at: '2024-01-01T00:00:00Z', + updated_at: '2024-01-01T00:00:00Z', + is_anonymous: false + }, + provider_token: '', + provider_refresh_token: '' + }, + user: { + id: '11111111-1111-1111-1111-111111111111', + aud: 'authenticated', + role: 'authenticated', + email: 'example@email.com', + email_confirmed_at: '2024-01-01T00:00:00Z', + phone: '', + confirmation_sent_at: '2024-01-01T00:00:00Z', + confirmed_at: '2024-01-01T00:00:00Z', + last_sign_in_at: '2024-01-01T00:00:00Z', + app_metadata: { + provider: 'email', + providers: [ + "email", + "" + ] + }, + user_metadata: { + email: 'email@email.com', + email_verified: true, + full_name: 'User Name', + iss: '', + name: 'User Name', + phone_verified: false, + provider_id: '', + sub: '' + }, + identities: [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "11111111-1111-1111-1111-111111111111", + "user_id": "11111111-1111-1111-1111-111111111111", + "identity_data": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "email@example.com" + }, + { + "identity_id": "33333333-3333-3333-3333-333333333333", + "id": "", + "user_id": "", + "identity_data": { + "email": "example@email.com", + "email_verified": true, + "full_name": "User Name", + "iss": "", + "name": "User Name", + "phone_verified": false, + "provider_id": "", + "sub": "" + }, + "provider": "", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "example@email.com" + } + ], + created_at: '2024-01-01T00:00:00Z', + updated_at: '2024-01-01T00:00:00Z', + is_anonymous: false + }, + redirectType: null + }, + "error": null +} +\`\`\`", + }, + ], + "shortText": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow.", + "text": "- Used when \`flowType\` is set to \`pkce\` in client options.", + }, + "name": "@supabase/auth-js.GoTrueClient.exchangeCodeForSession", + "params": [ + { + "name": "authCode", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthTokenResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "session", + "type": { + "name": "Session", + "properties": [ + { + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.", + }, + "name": "access_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed.", + }, + "isOptional": true, + "name": "expires_at", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.", + }, + "name": "expires_in", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. +Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.", + }, + "isOptional": true, + "name": "provider_refresh_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.", + }, + "isOptional": true, + "name": "provider_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "A one-time used refresh token that never expires.", + }, + "name": "refresh_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "token_type", + "type": { + "type": "literal", + "value": "bearer", + }, + }, + { + "comment": { + "shortText": "When using a separate user storage, accessing properties of this object will throw an error.", + }, + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "session", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.getClaims": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.getClaims() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "get-jwt-claims-header-and-signature", + "name": "Get JWT claims, header and signature", + "response": "\`\`\`json +{ + "data": { + "claims": { + "aal": "aal1", + "amr": [{ + "method": "email", + "timestamp": 1715766000 + }], + "app_metadata": {}, + "aud": "authenticated", + "email": "example@email.com", + "exp": 1715769600, + "iat": 1715766000, + "is_anonymous": false, + "iss": "https://project-id.supabase.co/auth/v1", + "phone": "+13334445555", + "role": "authenticated", + "session_id": "11111111-1111-1111-1111-111111111111", + "sub": "11111111-1111-1111-1111-111111111111", + "user_metadata": {} + }, + "header": { + "alg": "RS256", + "typ": "JWT", + "kid": "11111111-1111-1111-1111-111111111111" + }, + "signature": [/** Uint8Array */], + }, + "error": null +} +\`\`\`", + }, + ], + "shortText": "Extracts the JWT claims present in the access token by first verifying the +JWT against the server's JSON Web Key Set endpoint +\`/.well-known/jwks.json\` which is often cached, resulting in significantly +faster responses. Prefer this method over #getUser which always +sends a request to the Auth server for each JWT. + +If the project is not using an asymmetric JWT signing key (like ECC or +RSA) it always sends a request to the Auth server (similar to #getUser) to verify the JWT.", + "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired. +- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API). +- A network request is sent to your project's JWT signing key discovery endpoint \`https://project-id.supabase.co/auth/v1/.well-known/jwks.json\`, which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations. +- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT. +- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to \`getUser()\` to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations. +- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook).", + }, + "name": "@supabase/auth-js.GoTrueClient.getClaims", + "params": [ + { + "comment": { + "shortText": "An optional specific JWT you wish to verify, not the one you + can obtain from #getSession.", + }, + "isOptional": true, + "name": "jwt", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Various additional options that allow you to customize the + behavior of this method.", + }, + "name": "options", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "If set to \`true\` the \`exp\` claim will not be validated against the current time.", + }, + "isOptional": true, + "name": "allowExpired", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server.", + }, + "isOptional": true, + "name": "jwks", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "keys", + "type": { + "elemType": { + "name": "JWK", + "properties": [ + { + "isOptional": true, + "name": "alg", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "key_ops", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "kid", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "kty", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + undefined, + { + "type": "literal", + "value": "RSA", + }, + { + "type": "literal", + "value": "EC", + }, + { + "type": "literal", + "value": "oct", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "comment": { + "shortText": "", + }, + "isOptional": true, + "name": "keys", + "type": { + "elemType": { + "name": "JWK", + "properties": [ + { + "isOptional": true, + "name": "alg", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "key_ops", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "kid", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "kty", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + undefined, + { + "type": "literal", + "value": "RSA", + }, + { + "type": "literal", + "value": "EC", + }, + { + "type": "literal", + "value": "oct", + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "claims", + "type": { + "name": "JwtPayload", + "properties": [ + { + "name": "aal", + "type": { + "name": "AuthenticatorAssuranceLevels", + "subTypes": [ + { + "type": "literal", + "value": "aal1", + }, + { + "type": "literal", + "value": "aal2", + }, + undefined, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Authentication Method References. +Supports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]). +- String format: ['password', 'otp'] - RFC-8176 compliant +- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps", + }, + "isOptional": true, + "name": "amr", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + { + "elemType": { + "name": "AMREntry", + "properties": [ + { + "comment": { + "shortText": "Authentication method name.", + }, + "name": "method", + "type": { + "name": "AMRMethod", + "subTypes": [ + { + "name": "['number']", + "type": "nameOnly", + }, + undefined, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Timestamp when the method was successfully used. Represents number of +seconds since 1st January 1970 (UNIX epoch) in UTC.", + }, + "name": "timestamp", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + ], + "type": "union", + }, + }, + { + "isOptional": true, + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "string", + "type": "intrinsic", + }, + { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + ], + "type": "union", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "exp", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "name": "iat", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "name": "iss", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "jti", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "nbf", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "ref", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "session_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "sub", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "header", + "type": { + "name": "JwtHeader", + "properties": [ + { + "name": "alg", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "RS256", + }, + { + "type": "literal", + "value": "ES256", + }, + { + "type": "literal", + "value": "HS256", + }, + undefined, + ], + "type": "union", + }, + }, + { + "name": "kid", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "typ", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "signature", + "type": { + "name": "Uint8Array", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.getSession": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.getSession() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "get-the-session-data", + "name": "Get the session data", + "response": "\`\`\`json +{ + "data": { + "session": { + "access_token": "", + "token_type": "bearer", + "expires_in": 3600, + "expires_at": 1700000000, + "refresh_token": "", + "user": { + "id": "11111111-1111-1111-1111-111111111111", + "aud": "authenticated", + "role": "authenticated", + "email": "example@email.com", + "email_confirmed_at": "2024-01-01T00:00:00Z", + "phone": "", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "app_metadata": { + "provider": "email", + "providers": [ + "email" + ] + }, + "user_metadata": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "identities": [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "11111111-1111-1111-1111-111111111111", + "user_id": "11111111-1111-1111-1111-111111111111", + "identity_data": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "example@email.com" + } + ], + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "is_anonymous": false + } + } + }, + "error": null +} +\`\`\`", + }, + ], + "shortText": "Returns the session, refreshing it if necessary. + +The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out. + +**IMPORTANT:** This method loads values directly from the storage attached +to the client. If that storage is based on request cookies for example, +the values in it may not be authentic and therefore it's strongly advised +against using this method and its results in such circumstances. A warning +will be emitted if this is detected. Use #getUser() instead.", + "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use \`getClaims()\` or \`getUser()\` instead. +- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies). +- The session contains an access token (signed JWT), a refresh token and the user object. +- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session. +- When using in a browser, or you've called \`startAutoRefresh()\` in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast. +- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using \`getClaims()\` or your own JWT verification library to securely establish the user's identity and access. You can also use \`getUser()\` to fetch the user object directly from the Auth server for this purpose. +- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed.", + }, + "name": "@supabase/auth-js.GoTrueClient.getSession", + "params": [], + "ret": { + "type": { + "awaited": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "session", + "type": { + "name": "Session", + "properties": [ + { + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.", + }, + "name": "access_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed.", + }, + "isOptional": true, + "name": "expires_at", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.", + }, + "name": "expires_in", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. +Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.", + }, + "isOptional": true, + "name": "provider_refresh_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.", + }, + "isOptional": true, + "name": "provider_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "A one-time used refresh token that never expires.", + }, + "name": "refresh_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "token_type", + "type": { + "type": "literal", + "value": "bearer", + }, + }, + { + "comment": { + "shortText": "When using a separate user storage, accessing properties of this object will throw an error.", + }, + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "session", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "session", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.getUser": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data: { user } } = await supabase.auth.getUser() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "get-the-logged-in-user-with-the-current-existing-session", + "name": "Get the logged in user with the current existing session", + "response": "\`\`\`json +{ + "data": { + "user": { + "id": "11111111-1111-1111-1111-111111111111", + "aud": "authenticated", + "role": "authenticated", + "email": "example@email.com", + "email_confirmed_at": "2024-01-01T00:00:00Z", + "phone": "", + "confirmed_at": "2024-01-01T00:00:00Z", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "app_metadata": { + "provider": "email", + "providers": [ + "email" + ] + }, + "user_metadata": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "identities": [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "11111111-1111-1111-1111-111111111111", + "user_id": "11111111-1111-1111-1111-111111111111", + "identity_data": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "example@email.com" + } + ], + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "is_anonymous": false + } + }, + "error": null +} +\`\`\`", + }, + { + "code": "\`\`\`js +const { data: { user } } = await supabase.auth.getUser(jwt) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "get-the-logged-in-user-with-a-custom-access-token-jwt", + "name": "Get the logged in user with a custom access token jwt", + "response": undefined, + }, + ], + "shortText": "Gets the current user details if there is an existing session. This method +performs a network request to the Supabase Auth server, so the returned +value is authentic and can be used to base authorization rules on.", + "text": "- This method fetches the user object from the database instead of local session. +- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server. +- Should always be used when checking for user authorization on the server. On the client, you can instead use \`getSession().session.user\` for faster results. \`getSession\` is insecure on the server.", + }, + "name": "@supabase/auth-js.GoTrueClient.getUser", + "params": [ + { + "comment": { + "shortText": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used.", + }, + "isOptional": true, + "name": "jwt", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "UserResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.getUserIdentities": { + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.getUserIdentities() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "returns-a-list-of-identities-linked-to-the-user", + "name": "Returns a list of identities linked to the user", + "response": "\`\`\`json +{ + "data": { + "identities": [ + { + "identity_id": "22222222-2222-2222-2222-222222222222", + "id": "2024-01-01T00:00:00Z", + "user_id": "2024-01-01T00:00:00Z", + "identity_data": { + "email": "example@email.com", + "email_verified": false, + "phone_verified": false, + "sub": "11111111-1111-1111-1111-111111111111" + }, + "provider": "email", + "last_sign_in_at": "2024-01-01T00:00:00Z", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "email": "example@email.com" + } + ] + }, + "error": null +} +\`\`\`", + }, + ], + "shortText": "Gets all the identities linked to a user.", + "text": "- The user needs to be signed in to call \`getUserIdentities()\`.", + }, + "name": "@supabase/auth-js.GoTrueClient.getUserIdentities", + "params": [], + "ret": { + "type": { + "awaited": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.initialize": { + "comment": { + "shortText": "Initializes the client session either from the url or from storage. +This method is automatically called when instantiating the client, but should also be called +manually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc).", + }, + "name": "@supabase/auth-js.GoTrueClient.initialize", + "params": [], + "ret": { + "type": { + "awaited": { + "name": "InitializeResult", + "properties": [ + { + "name": "error", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "AuthError", + "type": "nameOnly", + }, + { + "type": "literal", + "value": null, + }, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.isThrowOnErrorEnabled": { + "comment": { + "shortText": "Returns whether error throwing mode is enabled for this client.", + }, + "name": "@supabase/auth-js.GoTrueClient.isThrowOnErrorEnabled", + "params": [], + "ret": { + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.linkIdentity": { + "altSignatures": [ + { + "params": [ + { + "name": "credentials", + "type": { + "name": "SignInWithIdTokenCredentials", + "properties": [ + { + "comment": { + "shortText": "If the ID token contains an \`at_hash\` claim, then the hash of this value is compared to the value in the ID token.", + }, + "isOptional": true, + "name": "access_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "If the ID token contains a \`nonce\` claim, then the hash of this value is compared to the value in the ID token.", + }, + "isOptional": true, + "name": "nonce", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "options", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.", + }, + "isOptional": true, + "name": "captchaToken", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "comment": { + "shortText": "Provider name or OIDC \`iss\` value identifying which provider should be used to verify the provided token. Supported names: \`google\`, \`apple\`, \`azure\`, \`facebook\`, \`kakao\`. Use the \`custom:\` prefix for custom OIDC providers (e.g. \`custom:my-oidc-provider\`).", + }, + "name": "provider", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "google", + }, + { + "type": "literal", + "value": "apple", + }, + { + "type": "literal", + "value": "azure", + }, + { + "type": "literal", + "value": "facebook", + }, + { + "type": "literal", + "value": "kakao", + }, + undefined, + undefined, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "OIDC ID token issued by the specified provider. The \`iss\` claim in the ID token must match the supplied provider. Some ID tokens contain an \`at_hash\` which require that you provide an \`access_token\` value to be accepted properly. If the token contains a \`nonce\` claim you must supply the nonce used to obtain the ID token.", + }, + "name": "token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "AuthTokenResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "session", + "type": { + "name": "Session", + "properties": [ + { + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.", + }, + "name": "access_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed.", + }, + "isOptional": true, + "name": "expires_at", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.", + }, + "name": "expires_in", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. +Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.", + }, + "isOptional": true, + "name": "provider_refresh_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.", + }, + "isOptional": true, + "name": "provider_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "A one-time used refresh token that never expires.", + }, + "name": "refresh_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "token_type", + "type": { + "type": "literal", + "value": "bearer", + }, + }, + { + "comment": { + "shortText": "When using a separate user storage, accessing properties of this object will throw an error.", + }, + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "properties": [ + { + "name": "session", + "type": { + "type": "literal", + "value": null, + }, + }, + { + "name": "user", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + ], + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data, error } = await supabase.auth.linkIdentity({ + provider: 'github' +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "link-an-identity-to-a-user", + "name": "Link an identity to a user", + "response": "\`\`\`json +{ + data: { + provider: 'github', + url: + }, + error: null +} +\`\`\`", + }, + ], + "shortText": "Links an oauth identity to an existing user. +This method supports the PKCE flow.", + "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers). +- The user needs to be signed in to call \`linkIdentity()\`. +- If the candidate identity is already linked to the existing user or another user, \`linkIdentity()\` will fail. +- If \`linkIdentity\` is run in the browser, the user is automatically redirected to the returned URL. On the server, you should handle the redirect.", + }, + "name": "@supabase/auth-js.GoTrueClient.linkIdentity", + "params": [ + { + "name": "credentials", + "type": { + "name": "SignInWithOAuthCredentials", + "properties": [ + { + "isOptional": true, + "name": "options", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "comment": { + "shortText": "An object of query params", + }, + "isOptional": true, + "name": "queryParams", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "string", + "type": "intrinsic", + }, + }, + }, + { + "comment": { + "shortText": "A URL to send the user to after they are confirmed.", + }, + "isOptional": true, + "name": "redirectTo", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A space-separated list of scopes granted to the OAuth application.", + }, + "isOptional": true, + "name": "scopes", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider.", + }, + "isOptional": true, + "name": "skipBrowserRedirect", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "comment": { + "shortText": "One of the providers supported by GoTrue.", + }, + "name": "provider", + "type": { + "name": "Provider", + "subTypes": [ + { + "type": "literal", + "value": "apple", + }, + { + "type": "literal", + "value": "azure", + }, + { + "type": "literal", + "value": "bitbucket", + }, + { + "type": "literal", + "value": "discord", + }, + { + "type": "literal", + "value": "facebook", + }, + { + "type": "literal", + "value": "figma", + }, + { + "type": "literal", + "value": "github", + }, + { + "type": "literal", + "value": "gitlab", + }, + { + "type": "literal", + "value": "google", + }, + { + "type": "literal", + "value": "kakao", + }, + { + "type": "literal", + "value": "keycloak", + }, + { + "type": "literal", + "value": "linkedin", + }, + { + "type": "literal", + "value": "linkedin_oidc", + }, + { + "type": "literal", + "value": "notion", + }, + { + "type": "literal", + "value": "slack", + }, + { + "type": "literal", + "value": "slack_oidc", + }, + { + "type": "literal", + "value": "spotify", + }, + { + "type": "literal", + "value": "twitch", + }, + { + "type": "literal", + "value": "twitter", + }, + { + "type": "literal", + "value": "x", + }, + { + "type": "literal", + "value": "workos", + }, + { + "type": "literal", + "value": "zoom", + }, + { + "type": "literal", + "value": "fly", + }, + undefined, + ], + "type": "union", + }, + }, + ], + "type": "object", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "OAuthResponse", + "subTypes": [ + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "provider", + "type": { + "name": "Provider", + "subTypes": [ + { + "type": "literal", + "value": "apple", + }, + { + "type": "literal", + "value": "azure", + }, + { + "type": "literal", + "value": "bitbucket", + }, + { + "type": "literal", + "value": "discord", + }, + { + "type": "literal", + "value": "facebook", + }, + { + "type": "literal", + "value": "figma", + }, + { + "type": "literal", + "value": "github", + }, + { + "type": "literal", + "value": "gitlab", + }, + { + "type": "literal", + "value": "google", + }, + { + "type": "literal", + "value": "kakao", + }, + { + "type": "literal", + "value": "keycloak", + }, + { + "type": "literal", + "value": "linkedin", + }, + { + "type": "literal", + "value": "linkedin_oidc", + }, + { + "type": "literal", + "value": "notion", + }, + { + "type": "literal", + "value": "slack", + }, + { + "type": "literal", + "value": "slack_oidc", + }, + { + "type": "literal", + "value": "spotify", + }, + { + "type": "literal", + "value": "twitch", + }, + { + "type": "literal", + "value": "twitter", + }, + { + "type": "literal", + "value": "x", + }, + { + "type": "literal", + "value": "workos", + }, + { + "type": "literal", + "value": "zoom", + }, + { + "type": "literal", + "value": "fly", + }, + undefined, + ], + "type": "union", + }, + }, + { + "name": "url", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "provider", + "type": { + "name": "Provider", + "subTypes": [ + { + "type": "literal", + "value": "apple", + }, + { + "type": "literal", + "value": "azure", + }, + { + "type": "literal", + "value": "bitbucket", + }, + { + "type": "literal", + "value": "discord", + }, + { + "type": "literal", + "value": "facebook", + }, + { + "type": "literal", + "value": "figma", + }, + { + "type": "literal", + "value": "github", + }, + { + "type": "literal", + "value": "gitlab", + }, + { + "type": "literal", + "value": "google", + }, + { + "type": "literal", + "value": "kakao", + }, + { + "type": "literal", + "value": "keycloak", + }, + { + "type": "literal", + "value": "linkedin", + }, + { + "type": "literal", + "value": "linkedin_oidc", + }, + { + "type": "literal", + "value": "notion", + }, + { + "type": "literal", + "value": "slack", + }, + { + "type": "literal", + "value": "slack_oidc", + }, + { + "type": "literal", + "value": "spotify", + }, + { + "type": "literal", + "value": "twitch", + }, + { + "type": "literal", + "value": "twitter", + }, + { + "type": "literal", + "value": "x", + }, + { + "type": "literal", + "value": "workos", + }, + { + "type": "literal", + "value": "zoom", + }, + { + "type": "literal", + "value": "fly", + }, + undefined, + ], + "type": "union", + }, + }, + { + "name": "url", + "type": { + "type": "literal", + "value": null, + }, + }, + ], + "type": "object", + }, + }, + { + "name": "error", + "type": { + "name": "AuthError", + "type": "nameOnly", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": "Promise", + "type": "promise", + }, + }, + }, + "@supabase/auth-js.GoTrueClient.onAuthStateChange": { + "altSignatures": [ + { + "params": [ + { + "comment": { + "shortText": "A callback function to be invoked when an auth event happens.", + }, + "name": "callback", + "type": { + "comment": undefined, + "name": Symbol(anonymous), + "params": [ + { + "name": "event", + "type": { + "name": "AuthChangeEvent", + "subTypes": [ + { + "type": "literal", + "value": "INITIAL_SESSION", + }, + { + "type": "literal", + "value": "PASSWORD_RECOVERY", + }, + { + "type": "literal", + "value": "SIGNED_IN", + }, + { + "type": "literal", + "value": "SIGNED_OUT", + }, + { + "type": "literal", + "value": "TOKEN_REFRESHED", + }, + { + "type": "literal", + "value": "USER_UPDATED", + }, + { + "name": "AuthChangeEventMFA", + "type": "literal", + "value": "MFA_CHALLENGE_VERIFIED", + }, + ], + "type": "union", + }, + }, + { + "name": "session", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "Session", + "properties": [ + { + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.", + }, + "name": "access_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed.", + }, + "isOptional": true, + "name": "expires_at", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.", + }, + "name": "expires_in", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. +Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.", + }, + "isOptional": true, + "name": "provider_refresh_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.", + }, + "isOptional": true, + "name": "provider_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "A one-time used refresh token that never expires.", + }, + "name": "refresh_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "token_type", + "type": { + "type": "literal", + "value": "bearer", + }, + }, + { + "comment": { + "shortText": "When using a separate user storage, accessing properties of this object will throw an error.", + }, + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + }, + ], + "ret": { + "type": { + "awaited": { + "name": "void", + "type": "intrinsic", + }, + "name": "Promise", + "type": "promise", + }, + }, + "type": "function", + }, + }, + ], + "ret": { + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "data", + "type": { + "name": Symbol(anonymous), + "properties": [ + { + "name": "subscription", + "type": { + "name": "Subscription", + "properties": [ + { + "comment": { + "shortText": "The function to call every time there is an event. eg: (eventName) => {}", + }, + "name": "callback", + "type": { + "comment": undefined, + "name": Symbol(anonymous), + "params": [ + { + "name": "event", + "type": { + "name": "AuthChangeEvent", + "subTypes": [ + { + "type": "literal", + "value": "INITIAL_SESSION", + }, + { + "type": "literal", + "value": "PASSWORD_RECOVERY", + }, + { + "type": "literal", + "value": "SIGNED_IN", + }, + { + "type": "literal", + "value": "SIGNED_OUT", + }, + { + "type": "literal", + "value": "TOKEN_REFRESHED", + }, + { + "type": "literal", + "value": "USER_UPDATED", + }, + { + "name": "AuthChangeEventMFA", + "type": "literal", + "value": "MFA_CHALLENGE_VERIFIED", + }, + ], + "type": "union", + }, + }, + { + "name": "session", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "Session", + "properties": [ + { + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value.", + }, + "name": "access_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed.", + }, + "isOptional": true, + "name": "expires_at", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed.", + }, + "name": "expires_in", + "type": { + "name": "number", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API. +Not all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token.", + }, + "isOptional": true, + "name": "provider_refresh_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used.", + }, + "isOptional": true, + "name": "provider_token", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": null, + }, + { + "name": "string", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "A one-time used refresh token that never expires.", + }, + "name": "refresh_token", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "token_type", + "type": { + "type": "literal", + "value": "bearer", + }, + }, + { + "comment": { + "shortText": "When using a separate user storage, accessing properties of this object will throw an error.", + }, + "name": "user", + "type": { + "name": "User", + "properties": [ + { + "isOptional": true, + "name": "action_link", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "app_metadata", + "type": { + "name": "UserAppMetadata", + "properties": [ + { + "comment": { + "shortText": "The first provider that the user used to sign up with.", + }, + "isOptional": true, + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "A list of all providers that the user has linked to their account.", + }, + "isOptional": true, + "name": "providers", + "type": { + "elemType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + ], + "type": "object", + }, + }, + { + "name": "aud", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "banned_until", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmation_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "deleted_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_change_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "email_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "factors", + "type": { + "elemType": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + { + "name": "Factor", + "properties": [ + { + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "Type of factor. \`totp\` and \`phone\` supported with this version", + }, + "name": "factor_type", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors.", + }, + "isOptional": true, + "name": "friendly_name", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "ID of the factor.", + }, + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_challenged_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "comment": { + "shortText": "The verification status of the factor, default is \`unverified\` after \`.enroll()\`, then \`verified\` after the user verifies it with \`.verify()\`", + }, + "name": "status", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "type": "literal", + "value": "totp", + }, + { + "type": "literal", + "value": "phone", + }, + { + "type": "literal", + "value": "webauthn", + }, + ], + "type": "union", + }, + }, + { + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identities", + "type": { + "elemType": { + "name": "UserIdentity", + "properties": [ + { + "isOptional": true, + "name": "created_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "identity_data", + "type": { + "keyType": { + "name": "string", + "type": "intrinsic", + }, + "name": Symbol(anonymous), + "type": "index signature", + "valueType": { + "name": "any", + "type": "intrinsic", + }, + }, + }, + { + "name": "identity_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "provider", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_id", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + ], + "type": "object", + }, + "name": Symbol(anonymous), + "type": "array", + }, + }, + { + "isOptional": true, + "name": "invited_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_anonymous", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "is_sso_user", + "type": { + "name": "boolean", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "last_sign_in_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_email", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "new_phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "phone_confirmed_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "recovery_sent_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "role", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "isOptional": true, + "name": "updated_at", + "type": { + "name": "string", + "type": "intrinsic", + }, + }, + { + "name": "user_metadata", + "type": { + "name": "UserMetadata", + "properties": [], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + ], + "type": "union", + }, + }, + ], + "ret": { + "type": { + "name": "void", + "type": "intrinsic", + }, + }, + "type": "function", + }, + }, + { + "comment": { + "shortText": "A unique identifier for this subscription, set by the client. +This is an internal identifier used for managing callbacks and should not be +relied upon by application code. Use the unsubscribe() method to remove listeners.", + }, + "name": "id", + "type": { + "name": Symbol(anonymous), + "subTypes": [ + { + "name": "string", + "type": "intrinsic", + }, + { + "name": "symbol", + "type": "intrinsic", + }, + ], + "type": "union", + }, + }, + { + "comment": { + "shortText": "Call this to remove the listener.", + }, + "name": "unsubscribe", + "type": { + "comment": undefined, + "name": Symbol(anonymous), + "params": [], + "ret": { + "type": { + "name": "void", + "type": "intrinsic", + }, + }, + "type": "function", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + ], + "type": "object", + }, + }, + }, + ], + "comment": { + "examples": [ + { + "code": "\`\`\`js +const { data } = supabase.auth.onAuthStateChange((event, session) => { + console.log(event, session) + + if (event === 'INITIAL_SESSION') { + // handle initial session + } else if (event === 'SIGNED_IN') { + // handle sign in event + } else if (event === 'SIGNED_OUT') { + // handle sign out event + } else if (event === 'PASSWORD_RECOVERY') { + // handle password recovery event + } else if (event === 'TOKEN_REFRESHED') { + // handle token refreshed event + } else if (event === 'USER_UPDATED') { + // handle user updated event + } +}) + +// call unsubscribe to remove the callback +data.subscription.unsubscribe() +\`\`\`", + "data": undefined, + "description": undefined, + "id": "listen-to-auth-changes", + "name": "Listen to auth changes", + "response": undefined, + }, + { + "code": "\`\`\`js +supabase.auth.onAuthStateChange((event, session) => { + if (event === 'SIGNED_OUT') { + console.log('SIGNED_OUT', session) + + // clear local and session storage + [ + window.localStorage, + window.sessionStorage, + ].forEach((storage) => { + Object.entries(storage) + .forEach(([key]) => { + storage.removeItem(key) + }) + }) + } +}) +\`\`\`", + "data": undefined, + "description": "Make sure you clear out any local data, such as local and session storage, after the client library has detected the user's sign out.", + "id": "listen-to-sign-out", + "name": "Listen to sign out", + "response": undefined, + }, + { + "code": "\`\`\`js +// Register this immediately after calling createClient! +// Because signInWithOAuth causes a redirect, you need to fetch the +// provider tokens from the callback. +supabase.auth.onAuthStateChange((event, session) => { + if (session && session.provider_token) { + window.localStorage.setItem('oauth_provider_token', session.provider_token) + } + + if (session && session.provider_refresh_token) { + window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token) + } + + if (event === 'SIGNED_OUT') { + window.localStorage.removeItem('oauth_provider_token') + window.localStorage.removeItem('oauth_provider_refresh_token') + } +}) +\`\`\`", + "data": undefined, + "description": "When using [OAuth (Social Login)](/docs/guides/auth/social-login) you sometimes wish to get access to the provider's access token and refresh token, in order to call provider APIs in the name of the user. + +For example, if you are using [Sign in with Google](/docs/guides/auth/social-login/auth-google) you may want to use the provider token to call Google APIs on behalf of the user. Supabase Auth does not keep track of the provider access and refresh token, but does return them for you once, immediately after sign in. You can use the \`onAuthStateChange\` method to listen for the presence of the provider tokens and store them in local storage. You can further send them to your server's APIs for use on the backend. + +Finally, make sure you remove them from local storage on the \`SIGNED_OUT\` event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend.", + "id": "store-oauth-provider-tokens-on-sign-in", + "name": "Store OAuth provider tokens on sign in", + "response": undefined, + }, + { + "code": "\`\`\`js +const SessionContext = React.createContext(null) + +function main() { + const [session, setSession] = React.useState(null) + + React.useEffect(() => { + const {data: { subscription }} = supabase.auth.onAuthStateChange( + (event, session) => { + if (event === 'SIGNED_OUT') { + setSession(null) + } else if (session) { + setSession(session) + } + }) + + return () => { + subscription.unsubscribe() + } + }, []) + + return ( + + + + ) +} +\`\`\`", + "data": undefined, + "description": "Instead of relying on \`supabase.auth.getSession()\` within your React components, you can use a [React Context](https://react.dev/reference/react/createContext) to store the latest session information from the \`onAuthStateChange\` callback and access it that way.", + "id": "use-react-context-for-the-user-s-session", + "name": "Use React Context for the User's session", + "response": undefined, + }, + { + "code": "\`\`\`js +supabase.auth.onAuthStateChange((event, session) => { + if (event === 'PASSWORD_RECOVERY') { + console.log('PASSWORD_RECOVERY', session) + // show screen to update user's password + showPasswordResetScreen(true) + } +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "listen-to-password-recovery-events", + "name": "Listen to password recovery events", + "response": undefined, + }, + { + "code": "\`\`\`js +supabase.auth.onAuthStateChange((event, session) => { + if (event === 'SIGNED_IN') console.log('SIGNED_IN', session) +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "listen-to-sign-in", + "name": "Listen to sign in", + "response": undefined, + }, + { + "code": "\`\`\`js +supabase.auth.onAuthStateChange((event, session) => { + if (event === 'TOKEN_REFRESHED') console.log('TOKEN_REFRESHED', session) +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "listen-to-token-refresh", + "name": "Listen to token refresh", + "response": undefined, + }, + { + "code": "\`\`\`js +supabase.auth.onAuthStateChange((event, session) => { + if (event === 'USER_UPDATED') console.log('USER_UPDATED', session) +}) +\`\`\`", + "data": undefined, + "description": undefined, + "id": "listen-to-user-updates", + "name": "Listen to user updates", + "response": undefined, + }, + ], + "shortText": "Receive a notification every time an auth event happens. +Safe to use without an async function as callback.", + "text": "- Subscribes to important events occurring on the user's session. +- Use on the frontend/client. It is less useful on the server. +- Events are emitted across tabs to keep your application's UI up-to-date. Some events can fire very frequently, based on the number of tabs open. Use a quick and efficient callback function, and defer or debounce as many operations as you can to be performed outside of the callback. +- Callbacks can be \`async\` and can safely call other Supabase auth methods (\`getUser\`, \`setSession\`, etc.) from inside the callback. +- Keep callbacks quick. Events are awaited in order, so a slow callback delays subsequent events to subscribers in this tab. +- Emitted events: + - \`INITIAL_SESSION\` + - Emitted right after the Supabase client is constructed and the initial session from storage is loaded. + - \`SIGNED_IN\` + - Emitted each time a user session is confirmed or re-established, including on user sign in and when refocusing a tab. + - Avoid making assumptions as to when this event is fired, this may occur even when the user is already signed in. Instead, check the user object attached to the event to see if a new user has signed in and update your application's UI. + - This event can fire very frequently depending on the number of tabs open in your application. + - \`SIGNED_OUT\` + - Emitted when the user signs out. This can be after: + - A call to \`supabase.auth.signOut()\`. + - After the user's session has expired for any reason: + - User has signed out on another device. + - The session has reached its timebox limit or inactivity timeout. + - User has signed in on another device with single session per user enabled. + - Check the [User Sessions](/docs/guides/auth/sessions) docs for more information. + - Use this to clean up any local storage your application has associated with the user. + - \`TOKEN_REFRESHED\` + - Emitted each time a new access and refresh token are fetched for the signed in user. + - It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application. + - Avoid frequent calls to \`supabase.auth.getSession()\` for the same purpose. + - There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event. + - The frequency of this event is related to the JWT expiry limit configured on your project. + - \`USER_UPDATED\` + - Emitted each time the \`supabase.auth.updateUser()\` method finishes successfully. Listen to it to update your application's UI based on new profile information. + - \`PASSWORD_RECOVERY\` + - Emitted instead of the \`SIGNED_IN\` event when the user lands on a page that includes a password recovery link in the URL. + - Use it to show a UI to the user where they can [reset their password](/docs/guides/auth/passwords#resetting-a-users-password-forgot-password).", + }, + "name": "@supabase/auth-js.GoTrueClient.onAuthStateChange", + "params": [Array], + "ret": [Object], + }, + "@supabase/auth-js.GoTrueClient.reauthenticate": [Object], + "@supabase/auth-js.GoTrueClient.refreshSession": [Object], + "@supabase/auth-js.GoTrueClient.registerPasskey": [Object], + "@supabase/auth-js.GoTrueClient.resend": [Object], + "@supabase/auth-js.GoTrueClient.resetPasswordForEmail": [Object], + "@supabase/auth-js.GoTrueClient.setSession": [Object], + "@supabase/auth-js.GoTrueClient.signInAnonymously": [Object], + "@supabase/auth-js.GoTrueClient.signInWithIdToken": [Object], + "@supabase/auth-js.GoTrueClient.signInWithOAuth": [Object], + "@supabase/auth-js.GoTrueClient.signInWithOtp": [Object], + "@supabase/auth-js.GoTrueClient.signInWithPasskey": [Object], + "@supabase/auth-js.GoTrueClient.signInWithPassword": [Object], + "@supabase/auth-js.GoTrueClient.signInWithSSO": [Object], + "@supabase/auth-js.GoTrueClient.signInWithWeb3": [Object], + "@supabase/auth-js.GoTrueClient.signOut": [Object], + "@supabase/auth-js.GoTrueClient.signUp": [Object], + "@supabase/auth-js.GoTrueClient.startAutoRefresh": [Object], + "@supabase/auth-js.GoTrueClient.stopAutoRefresh": [Object], + "@supabase/auth-js.GoTrueClient.unlinkIdentity": [Object], + "@supabase/auth-js.GoTrueClient.updateUser": [Object], + "@supabase/auth-js.GoTrueClient.verifyOtp": [Object], + "@supabase/auth-js.GoTrueMFAApi.challenge": [Object], + "@supabase/auth-js.GoTrueMFAApi.challengeAndVerify": [Object], + "@supabase/auth-js.GoTrueMFAApi.enroll": [Object], + "@supabase/auth-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel": [Object], + "@supabase/auth-js.GoTrueMFAApi.listFactors": [Object], + "@supabase/auth-js.GoTrueMFAApi.unenroll": [Object], + "@supabase/auth-js.GoTrueMFAApi.verify": [Object], + "@supabase/auth-js.NavigatorLockAcquireTimeoutError.constructor": [Object], + "@supabase/auth-js.isAuthApiError": [Object], + "@supabase/auth-js.isAuthError": [Object], + "@supabase/auth-js.isAuthImplicitGrantRedirectError": [Object], + "@supabase/auth-js.isAuthPKCECodeVerifierMissingError": [Object], + "@supabase/auth-js.isAuthRefreshDiscardedError": [Object], + "@supabase/auth-js.isAuthRetryableFetchError": [Object], + "@supabase/auth-js.isAuthSessionMissingError": [Object], + "@supabase/auth-js.isAuthWeakPasswordError": [Object], + "@supabase/auth-js.navigatorLock": [Object], + "@supabase/auth-js.processLock": [Object], + "@supabase/functions-js.FunctionsClient.constructor": [Object], + "@supabase/functions-js.FunctionsClient.invoke": [Object], + "@supabase/functions-js.FunctionsClient.setAuth": [Object], + "@supabase/functions-js.FunctionsError.constructor": [Object], + "@supabase/functions-js.FunctionsError.toJSON": [Object], + "@supabase/functions-js.FunctionsFetchError.constructor": [Object], + "@supabase/functions-js.FunctionsFetchError.toJSON": [Object], + "@supabase/functions-js.FunctionsHttpError.constructor": [Object], + "@supabase/functions-js.FunctionsHttpError.toJSON": [Object], + "@supabase/functions-js.FunctionsRelayError.constructor": [Object], + "@supabase/functions-js.FunctionsRelayError.toJSON": [Object], + "@supabase/postgrest-js.PostgrestBuilder.constructor": [Object], + "@supabase/postgrest-js.PostgrestBuilder.overrideTypes": [Object], + "@supabase/postgrest-js.PostgrestBuilder.retry": [Object], + "@supabase/postgrest-js.PostgrestBuilder.returns": [Object], + "@supabase/postgrest-js.PostgrestBuilder.setHeader": [Object], + "@supabase/postgrest-js.PostgrestBuilder.stripNulls": [Object], + "@supabase/postgrest-js.PostgrestBuilder.then": [Object], + "@supabase/postgrest-js.PostgrestBuilder.throwOnError": [Object], + "@supabase/postgrest-js.PostgrestClient.constructor": [Object], + "@supabase/postgrest-js.PostgrestClient.from": [Object], + "@supabase/postgrest-js.PostgrestClient.rpc": [Object], + "@supabase/postgrest-js.PostgrestClient.schema": [Object], + "@supabase/postgrest-js.PostgrestError.constructor": [Object], + "@supabase/postgrest-js.PostgrestError.toJSON": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.abortSignal": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.constructor": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.containedBy": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.contains": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.csv": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.eq": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.explain": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.filter": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.geojson": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.gt": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.gte": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.ilike": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.ilikeAllOf": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.ilikeAnyOf": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.in": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.is": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.isDistinct": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.like": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.likeAllOf": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.likeAnyOf": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.limit": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.lt": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.lte": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.match": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.maxAffected": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.maybeSingle": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.neq": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.not": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.notIn": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.or": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.order": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.overlaps": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.overrideTypes": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.range": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.rangeAdjacent": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.rangeGt": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.rangeGte": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.rangeLt": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.rangeLte": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.regexIMatch": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.regexMatch": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.retry": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.returns": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.rollback": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.select": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.setHeader": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.single": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.stripNulls": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.textSearch": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.then": [Object], + "@supabase/postgrest-js.PostgrestFilterBuilder.throwOnError": [Object], + "@supabase/postgrest-js.PostgrestQueryBuilder.constructor": [Object], + "@supabase/postgrest-js.PostgrestQueryBuilder.delete": [Object], + "@supabase/postgrest-js.PostgrestQueryBuilder.insert": [Object], + "@supabase/postgrest-js.PostgrestQueryBuilder.select": [Object], + "@supabase/postgrest-js.PostgrestQueryBuilder.update": [Object], + "@supabase/postgrest-js.PostgrestQueryBuilder.upsert": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.abortSignal": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.constructor": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.csv": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.explain": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.geojson": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.limit": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.maxAffected": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.maybeSingle": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.order": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.overrideTypes": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.range": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.retry": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.returns": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.rollback": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.select": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.setHeader": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.single": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.stripNulls": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.then": [Object], + "@supabase/postgrest-js.PostgrestTransformBuilder.throwOnError": [Object], + "@supabase/realtime-js.RealtimeChannel.constructor": [Object], + "@supabase/realtime-js.RealtimeChannel.copyBindings": [Object], + "@supabase/realtime-js.RealtimeChannel.httpSend": [Object], + "@supabase/realtime-js.RealtimeChannel.on": [Object], + "@supabase/realtime-js.RealtimeChannel.presenceState": [Object], + "@supabase/realtime-js.RealtimeChannel.send": [Object], + "@supabase/realtime-js.RealtimeChannel.subscribe": [Object], + "@supabase/realtime-js.RealtimeChannel.teardown": [Object], + "@supabase/realtime-js.RealtimeChannel.track": [Object], + "@supabase/realtime-js.RealtimeChannel.unsubscribe": [Object], + "@supabase/realtime-js.RealtimeChannel.untrack": [Object], + "@supabase/realtime-js.RealtimeChannel.updateJoinPayload": [Object], + "@supabase/realtime-js.RealtimeClient.channel": [Object], + "@supabase/realtime-js.RealtimeClient.connect": [Object], + "@supabase/realtime-js.RealtimeClient.connectionState": [Object], + "@supabase/realtime-js.RealtimeClient.constructor": [Object], + "@supabase/realtime-js.RealtimeClient.disconnect": [Object], + "@supabase/realtime-js.RealtimeClient.endpointURL": [Object], + "@supabase/realtime-js.RealtimeClient.getChannels": [Object], + "@supabase/realtime-js.RealtimeClient.isConnected": [Object], + "@supabase/realtime-js.RealtimeClient.isConnecting": [Object], + "@supabase/realtime-js.RealtimeClient.isDisconnecting": [Object], + "@supabase/realtime-js.RealtimeClient.log": [Object], + "@supabase/realtime-js.RealtimeClient.onHeartbeat": [Object], + "@supabase/realtime-js.RealtimeClient.push": [Object], + "@supabase/realtime-js.RealtimeClient.removeAllChannels": [Object], + "@supabase/realtime-js.RealtimeClient.removeChannel": [Object], + "@supabase/realtime-js.RealtimeClient.sendHeartbeat": [Object], + "@supabase/realtime-js.RealtimeClient.setAuth": [Object], + "@supabase/realtime-js.RealtimePresence.constructor": [Object], + "@supabase/realtime-js.WebSocketFactory.getWebSocketConstructor": [Object], + "@supabase/realtime-js.WebSocketFactory.isWebSocketSupported": [Object], + "@supabase/realtime-js.WebSocketLike.addEventListener": [Object], + "@supabase/realtime-js.WebSocketLike.close": [Object], + "@supabase/realtime-js.WebSocketLike.removeEventListener": [Object], + "@supabase/realtime-js.WebSocketLike.send": [Object], + "@supabase/realtime-js.WebSocketLikeConstructor.constructor": [Object], + "@supabase/storage-js.StorageApiError.constructor": [Object], + "@supabase/storage-js.StorageApiError.toJSON": [Object], + "@supabase/storage-js.StorageClient.constructor": [Object], + "@supabase/storage-js.StorageClient.createBucket": [Object], + "@supabase/storage-js.StorageClient.deleteBucket": [Object], + "@supabase/storage-js.StorageClient.emptyBucket": [Object], + "@supabase/storage-js.StorageClient.from": [Object], + "@supabase/storage-js.StorageClient.getBucket": [Object], + "@supabase/storage-js.StorageClient.listBuckets": [Object], + "@supabase/storage-js.StorageClient.setHeader": [Object], + "@supabase/storage-js.StorageClient.throwOnError": [Object], + "@supabase/storage-js.StorageClient.updateBucket": [Object], + "@supabase/storage-js.StorageError.constructor": [Object], + "@supabase/storage-js.StorageError.toJSON": [Object], + "@supabase/storage-js.StorageUnknownError.constructor": [Object], + "@supabase/storage-js.StorageUnknownError.toJSON": [Object], + "@supabase/storage-js.StorageVectorsApiError.constructor": [Object], + "@supabase/storage-js.StorageVectorsApiError.toJSON": [Object], + "@supabase/storage-js.StorageVectorsError.constructor": [Object], + "@supabase/storage-js.StorageVectorsError.toJSON": [Object], + "@supabase/storage-js.StorageVectorsUnknownError.constructor": [Object], + "@supabase/storage-js.StorageVectorsUnknownError.toJSON": [Object], + "@supabase/storage-js.isStorageError": [Object], + "@supabase/storage-js.isStorageVectorsError": [Object], + "@supabase/storage-js.packages/BlobDownloadBuilder.default.asStream": [Object], + "@supabase/storage-js.packages/BlobDownloadBuilder.default.catch": [Object], + "@supabase/storage-js.packages/BlobDownloadBuilder.default.constructor": [Object], + "@supabase/storage-js.packages/BlobDownloadBuilder.default.finally": [Object], + "@supabase/storage-js.packages/BlobDownloadBuilder.default.then": [Object], + "@supabase/storage-js.packages/StorageAnalyticsClient.default.constructor": [Object], + "@supabase/storage-js.packages/StorageAnalyticsClient.default.createBucket": [Object], + "@supabase/storage-js.packages/StorageAnalyticsClient.default.deleteBucket": [Object], + "@supabase/storage-js.packages/StorageAnalyticsClient.default.from": [Object], + "@supabase/storage-js.packages/StorageAnalyticsClient.default.listBuckets": [Object], + "@supabase/storage-js.packages/StorageAnalyticsClient.default.setHeader": [Object], + "@supabase/storage-js.packages/StorageAnalyticsClient.default.throwOnError": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.constructor": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.createBucket": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.deleteBucket": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.emptyBucket": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.getBucket": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.listBuckets": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.setHeader": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.throwOnError": [Object], + "@supabase/storage-js.packages/StorageBucketApi.default.updateBucket": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.constructor": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.copy": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.createSignedUploadUrl": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.createSignedUrl": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.createSignedUrls": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.download": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.exists": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.getPublicUrl": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.info": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.list": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.listV2": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.move": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.remove": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.setHeader": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.throwOnError": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.toBase64": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.update": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.upload": [Object], + "@supabase/storage-js.packages/StorageFileApi.default.uploadToSignedUrl": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.constructor": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.createBucket": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.deleteBucket": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.from": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.getBucket": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.listBuckets": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.setHeader": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.StorageVectorsClient.throwOnError": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.constructor": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.createIndex": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.deleteIndex": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.getIndex": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.listIndexes": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.setHeader": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorBucketScope.throwOnError": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.constructor": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.deleteVectors": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.getVectors": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.listVectors": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.putVectors": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.queryVectors": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.setHeader": [Object], + "@supabase/storage-js.packages/StorageVectorsClient.VectorIndexScope.throwOnError": [Object], + "@supabase/storage-js.packages/StreamDownloadBuilder.default.catch": [Object], + "@supabase/storage-js.packages/StreamDownloadBuilder.default.constructor": [Object], + "@supabase/storage-js.packages/StreamDownloadBuilder.default.finally": [Object], + "@supabase/storage-js.packages/StreamDownloadBuilder.default.then": [Object], + "@supabase/supabase-js.AuthApiError.constructor": [Object], + "@supabase/supabase-js.AuthApiError.toJSON": [Object], + "@supabase/supabase-js.AuthError.constructor": [Object], + "@supabase/supabase-js.AuthError.toJSON": [Object], + "@supabase/supabase-js.AuthImplicitGrantRedirectError.constructor": [Object], + "@supabase/supabase-js.AuthImplicitGrantRedirectError.toJSON": [Object], + "@supabase/supabase-js.AuthInvalidCredentialsError.constructor": [Object], + "@supabase/supabase-js.AuthInvalidCredentialsError.toJSON": [Object], + "@supabase/supabase-js.AuthInvalidJwtError.constructor": [Object], + "@supabase/supabase-js.AuthInvalidJwtError.toJSON": [Object], + "@supabase/supabase-js.AuthInvalidTokenResponseError.constructor": [Object], + "@supabase/supabase-js.AuthInvalidTokenResponseError.toJSON": [Object], + "@supabase/supabase-js.AuthOAuthServerApi.approveAuthorization": [Object], + "@supabase/supabase-js.AuthOAuthServerApi.denyAuthorization": [Object], + "@supabase/supabase-js.AuthOAuthServerApi.getAuthorizationDetails": [Object], + "@supabase/supabase-js.AuthOAuthServerApi.listGrants": [Object], + "@supabase/supabase-js.AuthOAuthServerApi.revokeGrant": [Object], + "@supabase/supabase-js.AuthPKCECodeVerifierMissingError.constructor": [Object], + "@supabase/supabase-js.AuthPKCECodeVerifierMissingError.toJSON": [Object], + "@supabase/supabase-js.AuthPKCEGrantCodeExchangeError.constructor": [Object], + "@supabase/supabase-js.AuthPKCEGrantCodeExchangeError.toJSON": [Object], + "@supabase/supabase-js.AuthPasskeyApi.delete": [Object], + "@supabase/supabase-js.AuthPasskeyApi.list": [Object], + "@supabase/supabase-js.AuthPasskeyApi.startAuthentication": [Object], + "@supabase/supabase-js.AuthPasskeyApi.startRegistration": [Object], + "@supabase/supabase-js.AuthPasskeyApi.update": [Object], + "@supabase/supabase-js.AuthPasskeyApi.verifyAuthentication": [Object], + "@supabase/supabase-js.AuthPasskeyApi.verifyRegistration": [Object], + "@supabase/supabase-js.AuthRefreshDiscardedError.constructor": [Object], + "@supabase/supabase-js.AuthRefreshDiscardedError.toJSON": [Object], + "@supabase/supabase-js.AuthRetryableFetchError.constructor": [Object], + "@supabase/supabase-js.AuthRetryableFetchError.toJSON": [Object], + "@supabase/supabase-js.AuthSessionMissingError.constructor": [Object], + "@supabase/supabase-js.AuthSessionMissingError.toJSON": [Object], + "@supabase/supabase-js.AuthUnknownError.constructor": [Object], + "@supabase/supabase-js.AuthUnknownError.toJSON": [Object], + "@supabase/supabase-js.AuthWeakPasswordError.constructor": [Object], + "@supabase/supabase-js.AuthWeakPasswordError.toJSON": [Object], + "@supabase/supabase-js.CustomAuthError.constructor": [Object], + "@supabase/supabase-js.CustomAuthError.toJSON": [Object], + "@supabase/supabase-js.FunctionsError.constructor": [Object], + "@supabase/supabase-js.FunctionsError.toJSON": [Object], + "@supabase/supabase-js.FunctionsFetchError.constructor": [Object], + "@supabase/supabase-js.FunctionsFetchError.toJSON": [Object], + "@supabase/supabase-js.FunctionsHttpError.constructor": [Object], + "@supabase/supabase-js.FunctionsHttpError.toJSON": [Object], + "@supabase/supabase-js.FunctionsRelayError.constructor": [Object], + "@supabase/supabase-js.FunctionsRelayError.toJSON": [Object], + "@supabase/supabase-js.GoTrueAdminApi.constructor": [Object], + "@supabase/supabase-js.GoTrueAdminApi.createUser": [Object], + "@supabase/supabase-js.GoTrueAdminApi.deleteUser": [Object], + "@supabase/supabase-js.GoTrueAdminApi.generateLink": [Object], + "@supabase/supabase-js.GoTrueAdminApi.getUserById": [Object], + "@supabase/supabase-js.GoTrueAdminApi.inviteUserByEmail": [Object], + "@supabase/supabase-js.GoTrueAdminApi.listUsers": [Object], + "@supabase/supabase-js.GoTrueAdminApi.signOut": [Object], + "@supabase/supabase-js.GoTrueAdminApi.updateUserById": [Object], + "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.createProvider": [Object], + "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.deleteProvider": [Object], + "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.getProvider": [Object], + "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.listProviders": [Object], + "@supabase/supabase-js.GoTrueAdminCustomProvidersApi.updateProvider": [Object], + "@supabase/supabase-js.GoTrueAdminMFAApi.deleteFactor": [Object], + "@supabase/supabase-js.GoTrueAdminMFAApi.listFactors": [Object], + "@supabase/supabase-js.GoTrueAdminOAuthApi.createClient": [Object], + "@supabase/supabase-js.GoTrueAdminOAuthApi.deleteClient": [Object], + "@supabase/supabase-js.GoTrueAdminOAuthApi.getClient": [Object], + "@supabase/supabase-js.GoTrueAdminOAuthApi.listClients": [Object], + "@supabase/supabase-js.GoTrueAdminOAuthApi.regenerateClientSecret": [Object], + "@supabase/supabase-js.GoTrueAdminOAuthApi.updateClient": [Object], + "@supabase/supabase-js.GoTrueAdminPasskeyApi.deletePasskey": [Object], + "@supabase/supabase-js.GoTrueAdminPasskeyApi.listPasskeys": [Object], + "@supabase/supabase-js.GoTrueClient._refreshSession": [Object], + "@supabase/supabase-js.GoTrueClient._setSession": [Object], + "@supabase/supabase-js.GoTrueClient._signOut": [Object], + "@supabase/supabase-js.GoTrueClient._updateUser": [Object], + "@supabase/supabase-js.GoTrueClient.constructor": [Object], + "@supabase/supabase-js.GoTrueClient.dispose": [Object], + "@supabase/supabase-js.GoTrueClient.exchangeCodeForSession": [Object], + "@supabase/supabase-js.GoTrueClient.getClaims": [Object], + "@supabase/supabase-js.GoTrueClient.getSession": [Object], + "@supabase/supabase-js.GoTrueClient.getUser": [Object], + "@supabase/supabase-js.GoTrueClient.getUserIdentities": [Object], + "@supabase/supabase-js.GoTrueClient.initialize": [Object], + "@supabase/supabase-js.GoTrueClient.isThrowOnErrorEnabled": [Object], + "@supabase/supabase-js.GoTrueClient.linkIdentity": [Object], + "@supabase/supabase-js.GoTrueClient.onAuthStateChange": [Object], + "@supabase/supabase-js.GoTrueClient.reauthenticate": [Object], + "@supabase/supabase-js.GoTrueClient.refreshSession": [Object], + "@supabase/supabase-js.GoTrueClient.registerPasskey": [Object], + "@supabase/supabase-js.GoTrueClient.resend": [Object], + "@supabase/supabase-js.GoTrueClient.resetPasswordForEmail": [Object], + "@supabase/supabase-js.GoTrueClient.setSession": [Object], + "@supabase/supabase-js.GoTrueClient.signInAnonymously": [Object], + "@supabase/supabase-js.GoTrueClient.signInWithIdToken": [Object], + "@supabase/supabase-js.GoTrueClient.signInWithOAuth": [Object], + "@supabase/supabase-js.GoTrueClient.signInWithOtp": [Object], + "@supabase/supabase-js.GoTrueClient.signInWithPasskey": [Object], + "@supabase/supabase-js.GoTrueClient.signInWithPassword": [Object], + "@supabase/supabase-js.GoTrueClient.signInWithSSO": [Object], + "@supabase/supabase-js.GoTrueClient.signInWithWeb3": [Object], + "@supabase/supabase-js.GoTrueClient.signOut": [Object], + "@supabase/supabase-js.GoTrueClient.signUp": [Object], + "@supabase/supabase-js.GoTrueClient.startAutoRefresh": [Object], + "@supabase/supabase-js.GoTrueClient.stopAutoRefresh": [Object], + "@supabase/supabase-js.GoTrueClient.unlinkIdentity": [Object], + "@supabase/supabase-js.GoTrueClient.updateUser": [Object], + "@supabase/supabase-js.GoTrueClient.verifyOtp": [Object], + "@supabase/supabase-js.GoTrueMFAApi.challenge": [Object], + "@supabase/supabase-js.GoTrueMFAApi.challengeAndVerify": [Object], + "@supabase/supabase-js.GoTrueMFAApi.enroll": [Object], + "@supabase/supabase-js.GoTrueMFAApi.getAuthenticatorAssuranceLevel": [Object], + "@supabase/supabase-js.GoTrueMFAApi.listFactors": [Object], + "@supabase/supabase-js.GoTrueMFAApi.unenroll": [Object], + "@supabase/supabase-js.GoTrueMFAApi.verify": [Object], + "@supabase/supabase-js.NavigatorLockAcquireTimeoutError.constructor": [Object], + "@supabase/supabase-js.PostgrestBuilder.constructor": [Object], + "@supabase/supabase-js.PostgrestBuilder.overrideTypes": [Object], + "@supabase/supabase-js.PostgrestBuilder.retry": [Object], + "@supabase/supabase-js.PostgrestBuilder.returns": [Object], + "@supabase/supabase-js.PostgrestBuilder.setHeader": [Object], + "@supabase/supabase-js.PostgrestBuilder.stripNulls": [Object], + "@supabase/supabase-js.PostgrestBuilder.then": [Object], + "@supabase/supabase-js.PostgrestBuilder.throwOnError": [Object], + "@supabase/supabase-js.PostgrestError.constructor": [Object], + "@supabase/supabase-js.PostgrestError.toJSON": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.abortSignal": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.constructor": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.containedBy": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.contains": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.csv": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.eq": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.explain": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.filter": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.geojson": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.gt": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.gte": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.ilike": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.ilikeAllOf": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.ilikeAnyOf": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.in": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.is": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.isDistinct": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.like": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.likeAllOf": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.likeAnyOf": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.limit": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.lt": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.lte": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.match": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.maxAffected": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.maybeSingle": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.neq": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.not": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.notIn": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.or": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.order": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.overlaps": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.overrideTypes": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.range": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.rangeAdjacent": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.rangeGt": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.rangeGte": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.rangeLt": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.rangeLte": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.regexIMatch": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.regexMatch": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.retry": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.returns": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.rollback": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.select": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.setHeader": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.single": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.stripNulls": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.textSearch": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.then": [Object], + "@supabase/supabase-js.PostgrestFilterBuilder.throwOnError": [Object], + "@supabase/supabase-js.PostgrestQueryBuilder.constructor": [Object], + "@supabase/supabase-js.PostgrestQueryBuilder.delete": [Object], + "@supabase/supabase-js.PostgrestQueryBuilder.insert": [Object], + "@supabase/supabase-js.PostgrestQueryBuilder.select": [Object], + "@supabase/supabase-js.PostgrestQueryBuilder.update": [Object], + "@supabase/supabase-js.PostgrestQueryBuilder.upsert": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.abortSignal": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.constructor": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.csv": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.explain": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.geojson": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.limit": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.maxAffected": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.maybeSingle": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.order": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.overrideTypes": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.range": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.retry": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.returns": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.rollback": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.select": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.setHeader": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.single": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.stripNulls": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.then": [Object], + "@supabase/supabase-js.PostgrestTransformBuilder.throwOnError": [Object], + "@supabase/supabase-js.RealtimeChannel.constructor": [Object], + "@supabase/supabase-js.RealtimeChannel.copyBindings": [Object], + "@supabase/supabase-js.RealtimeChannel.httpSend": [Object], + "@supabase/supabase-js.RealtimeChannel.on": [Object], + "@supabase/supabase-js.RealtimeChannel.presenceState": [Object], + "@supabase/supabase-js.RealtimeChannel.send": [Object], + "@supabase/supabase-js.RealtimeChannel.subscribe": [Object], + "@supabase/supabase-js.RealtimeChannel.teardown": [Object], + "@supabase/supabase-js.RealtimeChannel.track": [Object], + "@supabase/supabase-js.RealtimeChannel.unsubscribe": [Object], + "@supabase/supabase-js.RealtimeChannel.untrack": [Object], + "@supabase/supabase-js.RealtimeChannel.updateJoinPayload": [Object], + "@supabase/supabase-js.RealtimeClient.channel": [Object], + "@supabase/supabase-js.RealtimeClient.connect": [Object], + "@supabase/supabase-js.RealtimeClient.connectionState": [Object], + "@supabase/supabase-js.RealtimeClient.constructor": [Object], + "@supabase/supabase-js.RealtimeClient.disconnect": [Object], + "@supabase/supabase-js.RealtimeClient.endpointURL": [Object], + "@supabase/supabase-js.RealtimeClient.getChannels": [Object], + "@supabase/supabase-js.RealtimeClient.isConnected": [Object], + "@supabase/supabase-js.RealtimeClient.isConnecting": [Object], + "@supabase/supabase-js.RealtimeClient.isDisconnecting": [Object], + "@supabase/supabase-js.RealtimeClient.log": [Object], + "@supabase/supabase-js.RealtimeClient.onHeartbeat": [Object], + "@supabase/supabase-js.RealtimeClient.push": [Object], + "@supabase/supabase-js.RealtimeClient.removeAllChannels": [Object], + "@supabase/supabase-js.RealtimeClient.removeChannel": [Object], + "@supabase/supabase-js.RealtimeClient.sendHeartbeat": [Object], + "@supabase/supabase-js.RealtimeClient.setAuth": [Object], + "@supabase/supabase-js.RealtimePresence.constructor": [Object], + "@supabase/supabase-js.StorageApiError.constructor": [Object], + "@supabase/supabase-js.StorageApiError.toJSON": [Object], + "@supabase/supabase-js.SupabaseClient.channel": [Object], + "@supabase/supabase-js.SupabaseClient.constructor": [Object], + "@supabase/supabase-js.SupabaseClient.from": [Object], + "@supabase/supabase-js.SupabaseClient.getChannels": [Object], + "@supabase/supabase-js.SupabaseClient.removeAllChannels": [Object], + "@supabase/supabase-js.SupabaseClient.removeChannel": [Object], + "@supabase/supabase-js.SupabaseClient.rpc": [Object], + "@supabase/supabase-js.SupabaseClient.schema": [Object], + "@supabase/supabase-js.WebSocketFactory.getWebSocketConstructor": [Object], + "@supabase/supabase-js.WebSocketFactory.isWebSocketSupported": [Object], + "@supabase/supabase-js.WebSocketLike.addEventListener": [Object], + "@supabase/supabase-js.WebSocketLike.close": [Object], + "@supabase/supabase-js.WebSocketLike.removeEventListener": [Object], + "@supabase/supabase-js.WebSocketLike.send": [Object], + "@supabase/supabase-js.WebSocketLikeConstructor.constructor": [Object], + "@supabase/supabase-js.createClient": [Object], + "@supabase/supabase-js.isAuthApiError": [Object], + "@supabase/supabase-js.isAuthError": [Object], + "@supabase/supabase-js.isAuthImplicitGrantRedirectError": [Object], + "@supabase/supabase-js.isAuthPKCECodeVerifierMissingError": [Object], + "@supabase/supabase-js.isAuthRefreshDiscardedError": [Object], + "@supabase/supabase-js.isAuthRetryableFetchError": [Object], + "@supabase/supabase-js.isAuthSessionMissingError": [Object], + "@supabase/supabase-js.isAuthWeakPasswordError": [Object], + "@supabase/supabase-js.navigatorLock": [Object], + "@supabase/supabase-js.processLock": [Object], + }, + "variables": [Object], + }, +} +`; diff --git a/apps/docs/scripts/build-reference-content.test.ts b/apps/docs/scripts/build-reference-content.test.ts new file mode 100644 index 00000000000..0fa79f9f9a6 --- /dev/null +++ b/apps/docs/scripts/build-reference-content.test.ts @@ -0,0 +1,22 @@ +import { describe, expect, it } from 'vitest' + +import { collectReferenceContent } from './build-reference-content' + +/** + * Regression guard for the new reference-content pipeline. Snapshots the five + * derived artifacts produced for `javascript/v2` so that any change in the + * extraction logic (or in the upstream supabase-js TypeDoc output) shows up + * as a snapshot diff in CI rather than silently shifting what the renderer + * sees. When the supabase-js `make` workflow lands a new release in + * `spec/reference/javascript/v2/`, re-run with `--update` to refresh the + * baseline as part of the same PR. + */ +describe('build-reference-content — javascript/v2', () => { + it('matches snapshot', async () => { + const { bySlug, flat, sections, functionsList, typeSpec } = await collectReferenceContent( + 'javascript', + 'v2' + ) + expect({ bySlug, flat, sections, functionsList, typeSpec }).toMatchSnapshot() + }) +}) diff --git a/apps/docs/scripts/build-reference-content.ts b/apps/docs/scripts/build-reference-content.ts new file mode 100644 index 00000000000..3fe27d4a053 --- /dev/null +++ b/apps/docs/scripts/build-reference-content.ts @@ -0,0 +1,696 @@ +/** + * Build reference content files (bySlug.json, etc.) from TypeDoc spec output. + * + * Scans `spec/reference/[library]/[version]/*.json` (TypeDoc output) and writes + * `content/reference/[library]/[version]/{bySlug,flat,sections,functions,typeSpec}.json`. + * + * Library and version names are inferred from the directory layout. An optional + * `config.json` in each version directory may declare `excludeCategories` and + * `categoryOrder` to filter and order the output. + * + * Usage: pnpm tsx scripts/build-reference-content.ts + */ + +import { mkdir, readdir, readFile, writeFile } from 'node:fs/promises' +import { dirname, extname, join } from 'node:path' +import { fileURLToPath } from 'node:url' +import matter from 'gray-matter' + +import { + buildMap, + KIND_VARIABLE, + normalizeComment, + parseSignature, + parseType, + type MethodTypes, + type VariableTypes, +} from '../features/docs/Reference.typeSpec' + +const __dirname = dirname(fileURLToPath(import.meta.url)) +const DOCS_DIR = join(__dirname, '..') +const SPEC_DIR = join(DOCS_DIR, 'spec/reference') +const OUTPUT_DIR = join(DOCS_DIR, 'content/reference') +const REF_DOCS_DIR = join(DOCS_DIR, 'docs/ref') + +type ContentPart = { kind: string; text?: string } + +interface BlockTag { + tag: string + name?: string + content: ContentPart[] +} + +interface Comment { + summary?: ContentPart[] + blockTags?: BlockTag[] +} + +interface Param { + name: string + type: unknown + flags?: { isOptional?: boolean } +} + +interface Declaration { + id?: number + name?: string + variant?: string + kind?: number + comment?: Comment + signatures?: Declaration[] + children?: Declaration[] + // signature-only / variable-only fields: + parameters?: Param[] + type?: unknown + flags?: { isOptional?: boolean; isConst?: boolean } +} + +interface FunctionEntry { + name: string + category: string + subcategory: string | null + $ref: string +} + +interface FunctionsEntry { + id: string + // Either a `$ref` (points at a typeSpec entry) OR rich inline content + // (description, examples, …) shovelled in from a .json partial body. + $ref?: string + [key: string]: unknown +} + +/** + * Per-lib typeSpec.json shape. Keys are normalised `$ref`s; values mirror the + * legacy `MethodTypes` / `VariableTypes` so the renderer in + * `Reference.sections.tsx` can consume the new file without changes. + */ +interface TypeSpec { + methods: Record + variables: Record +} + +interface BySlugFunction { + id: string + title: string + slug: string + product?: string + type: 'function' + isFunc?: false +} + +interface BySlugCategory { + type: 'category' + title: string +} + +interface BySlugMarkdown { + id: string + title: string + slug: string + type: 'markdown' +} + +type BySlugEntry = BySlugFunction | BySlugCategory | BySlugMarkdown + +/** A bySlug entry that may additionally carry nested children — used by sections.json. */ +type SectionEntry = BySlugEntry & { items?: SectionEntry[] } + +interface VersionConfig { + excludeCategories?: string[] + excludeDefinitions?: string[] + categoryOrder?: string[] + partialsOrder?: string[] + /** + * Customizes the navigation slug used as a prefix for a category or + * subcategory (matched on the literal `@category` / `@subcategory` text). + * - `string` → use that value as the prefix (e.g. `"Edge Functions": "functions"` + * turns `edge-functions-invoke` into `functions-invoke`). + * - `false` → drop the prefix entirely for child function slugs (e.g. + * `"Using modifiers": false` turns `using-modifiers-explain` into + * `explain`). The category/subcategory header itself still needs a slug, + * so its entry slug falls back to the slugified title. + * - missing → default to the slugified title. + */ + navigationPrefixes?: Record +} + +interface PartialEntry { + name: string + title: string + ref?: string + /** + * `kind` distinguishes how the partial contributes to the build: + * - `markdown`: an `.md`/`.mdx` partial. Rendered as a `type: 'markdown'` + * section (or `type: 'function'` when a frontmatter `ref` is present). + * - `function`: a `.json` partial whose body (description, examples, …) + * is appended to functions.json so the renderer can display it. + */ + kind: 'markdown' | 'function' + /** Raw parsed JSON body for `kind === 'function'` partials. */ + body?: Record + /** Raw frontmatter + body for `kind === 'markdown'` partials. */ + mdxRaw?: string +} + +/** Lowercases a string and collapses internal whitespace to hyphens for use as a URL slug. */ +function slugifyTag(value: string): string { + return value.toLowerCase().trim().replace(/\s+/g, '-') +} + +type NavigationPrefixes = Record | undefined + +/** + * The slug used for a category or subcategory **entry** (the header that + * appears in the navigation). `navigationPrefixes[title] = string` overrides + * the default; `false` and `undefined` both fall back to the slugified title + * because the entry still needs a stable, navigable slug. + */ +function entrySlug(title: string, navigationPrefixes: NavigationPrefixes): string { + const override = navigationPrefixes?.[title] + return typeof override === 'string' ? override : slugifyTag(title) +} + +/** + * The prefix segment used in front of a function's name. `false` means "no + * prefix" — the function slug becomes just its lowercased name. `string` + * overrides the default; `undefined` falls back to the slugified title. + */ +function functionPrefix(title: string, navigationPrefixes: NavigationPrefixes): string | null { + const override = navigationPrefixes?.[title] + if (override === false) return null + if (typeof override === 'string') return override + return slugifyTag(title) +} + +/** + * Stably reorders `items` so entries whose key appears in `order` come first in + * that order; unranked items keep their original relative order. Returns `items` + * unchanged when `order` is empty or undefined. + */ +function reorder(items: T[], order: string[] | undefined, key: (item: T) => string): T[] { + if (!order?.length) return items + const idx = new Map(order.map((n, i) => [n, i])) + return [...items].sort((a, b) => (idx.get(key(a)) ?? Infinity) - (idx.get(key(b)) ?? Infinity)) +} + +/** + * Builds a bySlug entry for a partial file: + * - `.json` partials always render as `type: 'function'` (their body feeds + * functions.json). + * - `.md`/`.mdx` partials with a frontmatter `ref` render as `type: 'function'` + * (linked to TypeDoc-derived code via the ref). + * - All other `.md`/`.mdx` partials render as plain `type: 'markdown'`. + */ +const partialEntry = (p: PartialEntry): BySlugMarkdown | BySlugFunction => + p.kind === 'function' || p.ref + ? { id: p.name, title: p.title, slug: p.name, type: 'function' } + : { id: p.name, title: p.title, slug: p.name, type: 'markdown' } + +/** Builds a category-type bySlug entry from a category title. */ +const categoryEntry = (title: string): BySlugCategory => ({ type: 'category', title }) + +/** Builds a subcategory bySlug entry — shaped like a function with `isFunc: false`. */ +const subcategoryEntry = (slug: string, title: string, product: string): BySlugFunction => ({ + id: slug, + isFunc: false, + title, + slug, + product, + type: 'function', +}) + +/** + * Builds a function bySlug entry. The slug is `${prefix}-${name}` where + * `prefix` comes from the function's nearest container — its `@subcategory` + * if present, otherwise its `@category`. `navigationPrefixes` in `config.json` + * can rename that prefix or drop it entirely (false). `id` always equals + * `slug` so the renderer's `fns.find(f => f.id === section.id)` resolves. + * + * `product` keeps the literal slugified category (independent of any + * navigation prefix) because the renderer uses it for feature filtering + * (e.g. hiding `auth` sections when the SDK Auth flag is disabled). + */ +const functionEntry = ( + fn: FunctionEntry, + product: string, + navigationPrefixes: NavigationPrefixes +): BySlugFunction => { + const prefix = functionPrefix(fn.subcategory ?? fn.category, navigationPrefixes) + const nameLower = fn.name.toLowerCase() + const slug = prefix === null ? nameLower : `${prefix}-${nameLower}` + return { id: slug, title: fn.name, slug, product, type: 'function' } +} + +/** + * Reads a named TSDoc block tag (e.g. `@category`) from a comment and returns + * its first line trimmed, or `null` if absent. + */ +function readBlockTag(comment: Comment | undefined, tagName: string): string | null { + if (!comment?.blockTags) return null + const tag = comment.blockTags.find((t) => t.tag === tagName) + if (!tag) return null + const text = tag.content + .map((c) => c.text ?? '') + .join('') + .split('\n')[0] + .trim() + return text || null +} + +/** + * Reads a block tag from a declaration's comment, falling back to its signature + * comments. TypeDoc emits tags in either place depending on the source style. + */ +function readTagFromDeclOrSignature(decl: Declaration, tagName: string): string | null { + const fromDecl = readBlockTag(decl.comment, tagName) + if (fromDecl) return fromDecl + if (decl.signatures) { + for (const sig of decl.signatures) { + const fromSig = readBlockTag(sig.comment, tagName) + if (fromSig) return fromSig + } + } + return null +} + +/** Strips redundant `.index.` segments and collapses consecutive dots in a ref. */ +function normalizeRefPath(path: string): string { + return path.replace(/\.index(?=\.|$)/g, '').replace(/\.+/g, '.') +} + +/** + * Recursively walks a TypeDoc declaration tree. Builds two outputs in one pass: + * - `functions`: declarations carrying an `@category` tag (with optional + * `@subcategory`) plus a constructed `$ref` of the form + * `...` (normalized to strip `.index.`). + * - `typeSpec`: separate `methods` and `variables` maps keyed by the same + * `$ref`. Methods carry every signature (first → primary, rest → + * `altSignatures`) with params, return type, and normalised comment + * (shortText, text, tags, examples). Variables (kind 32) carry their + * parsed type and `isConst` flag. Type-tree normalisation and comment + * extraction are delegated to the shared helpers in + * `~/features/docs/Reference.typeSpec` so the renderer can consume the + * output without any shape translation. + * + * Not filtered by category or `excludeDefinitions`, so partials that link + * to "hidden" methods (e.g. a constructor) can still resolve. + * + * Context is threaded down through container nodes: + * - kind 1 (project) sets the package name and resets the path. + * - kinds 2 (module), 4 (namespace), 128 (class), 256 (interface) all + * append their name to the path. Modules are required because some + * packages (storage-js, supabase-js) wrap each source file in a module + * like `packages/StorageFileApi`, and a class named `default` (TypeDoc's + * fallback for default-exported classes) is ambiguous without the module + * segment. Interfaces hold many of the auth admin APIs whose methods + * would otherwise lack a class segment in the ref. + */ +const PATH_CONTAINER_KINDS = new Set([2, 4, 128, 256]) + +function collectFunctions( + node: Declaration, + out: { functions: FunctionEntry[]; typeSpec: TypeSpec }, + idMap: Map, + ctx: { pkg: string | null; path: string[] } = { pkg: null, path: [] } +): void { + let nextCtx = ctx + if (node.kind === 1 && node.name) { + nextCtx = { pkg: node.name, path: [] } + } else if (node.kind && PATH_CONTAINER_KINDS.has(node.kind) && node.name) { + nextCtx = { ...ctx, path: [...ctx.path, node.name] } + } + + if (ctx.pkg && node.name) { + const ref = normalizeRefPath([ctx.pkg, ...ctx.path, node.name].join('.')) + if (node.signatures?.length) { + const firstSig = node.signatures[0] + const { params, ret, comment: sigComment } = parseSignature(firstSig, idMap) + + // Some overloaded methods carry shared JSDoc (e.g. @remarks, @example) + // on the declaration node rather than any individual signature. Merge + // node-level tags as a base so they aren't lost when the first + // signature only has a summary. + let comment = sigComment + if (node.comment) { + const nodeComment = normalizeComment(node.comment as any) + if (nodeComment) { + comment = { ...nodeComment, ...sigComment } + } + } + + const methodEntry: MethodTypes = { name: ref, params, ret, comment } + if (node.signatures.length > 1) { + methodEntry.altSignatures = node.signatures.slice(1).map((sig) => { + const { params: altParams, ret: altRet } = parseSignature(sig, idMap) + return { params: altParams, ret: altRet } + }) as MethodTypes['altSignatures'] + } + out.typeSpec.methods[ref] = methodEntry + } else if (node.kind === KIND_VARIABLE && node.type) { + const variableEntry: VariableTypes = { + name: ref, + type: parseType(node.type, idMap), + comment: node.comment ? normalizeComment(node.comment as any) : undefined, + isConst: node.flags?.isConst ?? false, + } + out.typeSpec.variables[ref] = variableEntry + } + } + + if (ctx.pkg && node.name && node.variant === 'declaration') { + const category = readTagFromDeclOrSignature(node, '@category') + if (category) { + const subcategory = readTagFromDeclOrSignature(node, '@subcategory') + const $ref = normalizeRefPath([ctx.pkg, ...ctx.path, node.name].join('.')) + out.functions.push({ name: node.name, category, subcategory, $ref }) + } + } + + if (node.children) { + for (const child of node.children) { + collectFunctions(child, out, idMap, nextCtx) + } + } +} + +/** Reads `config.json` from a version directory, returning `{}` if the file is missing. */ +async function readConfig(versionDir: string): Promise { + try { + const raw = await readFile(join(versionDir, 'config.json'), 'utf-8') + return JSON.parse(raw) as VersionConfig + } catch (err) { + if ((err as NodeJS.ErrnoException).code === 'ENOENT') return {} + throw err + } +} + +/** + * Reads every `.mdx` / `.md` / `.json` file from the `partials/` subdirectory. + * Markdown partials (`.md`, `.mdx`) have their frontmatter parsed for `title` + * and `ref`; JSON partials are parsed as objects and their full body kept so + * it can be emitted into functions.json. Returns alphabetically-sorted entries + * (case-insensitive); returns `[]` if `partials/` doesn't exist. + */ +async function readPartials(versionDir: string): Promise { + const partialsDir = join(versionDir, 'partials') + let files: string[] + try { + files = await readdir(partialsDir) + } catch (err) { + if ((err as NodeJS.ErrnoException).code === 'ENOENT') return [] + throw err + } + + const partials: PartialEntry[] = [] + for (const file of files) { + const ext = extname(file) + const name = file.slice(0, -ext.length) + const raw = await readFile(join(partialsDir, file), 'utf-8') + + if (ext === '.mdx' || ext === '.md') { + // `trimStart()` so frontmatter is parsed even when the file accidentally + // starts with blank lines before `---`. + const trimmed = raw.trimStart() + const { data } = matter(trimmed) + const title = typeof data.title === 'string' ? data.title : name + const ref = typeof data.ref === 'string' ? data.ref : undefined + partials.push({ name, title, ref, kind: 'markdown', mdxRaw: trimmed }) + } else if (ext === '.json') { + const body = JSON.parse(raw) as Record + const title = typeof body.title === 'string' ? body.title : name + partials.push({ name, title, kind: 'function', body }) + } + } + + // Default to alphabetical so `reorder` can place ranked items first and leave + // the rest in a deterministic order (Array.sort is stable since ES2019). + return partials.sort((a, b) => a.name.localeCompare(b.name)) +} + +/** + * Builds bySlug (a flat slug→entry map), sections (the same data shaped as a + * nested tree: partials, then each category containing its functions and + * subcategories), and a functions list (id→$ref pairs for functions.json) in + * a single pass. Categories are filtered by `excludeCategories` and ordered by + * `categoryOrder`; individual declarations are filtered by `excludeDefinitions` + * (matched on the source name, case-sensitive). Partials with a `ref` in + * frontmatter are emitted as `type: 'function'` entries and contribute to + * the functions list. + */ +function buildBySlug( + functions: FunctionEntry[], + partials: PartialEntry[], + config: VersionConfig +): { + bySlug: Record + sections: SectionEntry[] + functionsList: FunctionsEntry[] +} { + const bySlug: Record = {} + const sections: SectionEntry[] = [] + const functionsList: FunctionsEntry[] = [] + + const excludeCats = new Set(config.excludeCategories ?? []) + const excludeDefs = new Set(config.excludeDefinitions ?? []) + const filtered = functions.filter( + ({ name, category }) => !excludeCats.has(category) && !excludeDefs.has(name) + ) + + // Bucket partials by where they belong. A partial filename that matches a + // category title slug (e.g. `database.md`) attaches to that category; one + // that matches a subcategory title slug (e.g. `using-filters.json`) attaches + // to that subcategory; everything else stays at the top level. + const categorySlugs = new Set(filtered.map(({ category }) => slugifyTag(category))) + const subcategorySlugs = new Set( + filtered.filter((f) => f.subcategory).map((f) => slugifyTag(f.subcategory!)) + ) + const partialsByCategory = new Map() + const partialsBySubcategory = new Map() + const topLevelPartials: PartialEntry[] = [] + for (const p of partials) { + if (subcategorySlugs.has(p.name)) partialsBySubcategory.set(p.name, p) + else if (categorySlugs.has(p.name)) partialsByCategory.set(p.name, p) + else topLevelPartials.push(p) + } + + const writePartial = (p: PartialEntry, items: SectionEntry[]) => { + const entry = partialEntry(p) + bySlug[p.name] = entry + items.push(entry) + if (p.kind === 'function') functionsList.push({ id: p.name, ...p.body }) + else if (p.ref) functionsList.push({ id: p.name, $ref: p.ref }) + } + + for (const p of reorder(topLevelPartials, config.partialsOrder, (x) => x.name)) { + writePartial(p, sections) + } + + type CategoryGroup = { + title: string + withoutSub: FunctionEntry[] + bySub: Map + } + const groups = new Map() + + for (const fn of filtered) { + let group = groups.get(fn.category) + if (!group) { + group = { title: fn.category, withoutSub: [], bySub: new Map() } + groups.set(fn.category, group) + } + if (fn.subcategory) { + const bucket = group.bySub.get(fn.subcategory) ?? [] + bucket.push(fn) + group.bySub.set(fn.subcategory, bucket) + } else { + group.withoutSub.push(fn) + } + } + + const orderedCategories = reorder(Array.from(groups.keys()), config.categoryOrder, (c) => c) + + const writeFunction = (fn: FunctionEntry, product: string, items: SectionEntry[]) => { + const entry = functionEntry(fn, product, config.navigationPrefixes) + // Spec files can re-declare same-named methods on different classes; the + // slug collides, so only emit each unique slug once (first wins). + if (entry.slug in bySlug) return + bySlug[entry.slug] = entry + items.push(entry) + // functions.json `id` must match the bySlug entry's `id` (not the slug) — + // the renderer in Reference.sections.tsx does `fns.find(f => f.id === section.id)`. + functionsList.push({ id: entry.id, $ref: fn.$ref }) + } + + // Sort items alphabetically (case-insensitive) within categories and within + // subcategories. Subcategories still appear at the end of each category (the + // order they are pushed below preserves that: withoutSub entries first, then + // each subcategory block). + const byName = (a: { name: string }, b: { name: string }) => + a.name.toLowerCase().localeCompare(b.name.toLowerCase()) + + for (const category of orderedCategories) { + const group = groups.get(category)! + // `product` keeps the literal slugified category for feature filtering and + // for partial-filename matching, even when navigationPrefixes renames the + // category's navigation slug. + const product = slugifyTag(category) + const categorySlug = entrySlug(category, config.navigationPrefixes) + + const cat = categoryEntry(group.title) + const catItems: SectionEntry[] = [] + bySlug[categorySlug] = cat + sections.push({ ...cat, items: catItems }) + + const categoryPartial = partialsByCategory.get(product) + if (categoryPartial) writePartial(categoryPartial, catItems) + + for (const fn of [...group.withoutSub].sort(byName)) writeFunction(fn, product, catItems) + + const sortedSubs = [...group.bySub.entries()].sort(([a], [b]) => + a.toLowerCase().localeCompare(b.toLowerCase()) + ) + for (const [subcategory, fns] of sortedSubs) { + const subKey = slugifyTag(subcategory) + const subSlug = entrySlug(subcategory, config.navigationPrefixes) + const sub = subcategoryEntry(subSlug, subcategory, product) + const subItems: SectionEntry[] = [] + bySlug[subSlug] = sub + catItems.push({ ...sub, items: subItems }) + + const subcategoryPartial = partialsBySubcategory.get(subKey) + if (subcategoryPartial) writePartial(subcategoryPartial, subItems) + + for (const fn of [...fns].sort(byName)) writeFunction(fn, product, subItems) + } + } + + return { bySlug, sections, functionsList } +} + +/** + * For each markdown-kind partial without a `ref`, writes its raw body + * (frontmatter + content) to `docs/ref//.mdx` if that file + * does not already exist. The renderer's `getRefMarkdown` loads body text + * from this location, so new partials added under `spec/reference/.../partials/` + * become renderable without manual file shuffling. Existing files are left + * alone to preserve hand-maintained frontmatter (e.g. `hideTitle`). + */ +async function writeNewMarkdownPartials(library: string, partials: PartialEntry[]): Promise { + const markdownPartials = partials.filter((p) => p.kind === 'markdown' && p.mdxRaw && !p.ref) + if (markdownPartials.length === 0) return + + const outDir = join(REF_DOCS_DIR, library) + await mkdir(outDir, { recursive: true }) + + await Promise.all( + markdownPartials.map(async (p) => { + const target = join(outDir, `${p.name}.mdx`) + try { + // `wx` flag fails with EEXIST if the file is already there. + await writeFile(target, p.mdxRaw!, { flag: 'wx' }) + } catch (err) { + if ((err as NodeJS.ErrnoException).code !== 'EEXIST') throw err + } + }) + ) +} + +/** + * In-memory computation for a single `[library]/[version]`: reads spec files, + * partials, and config, walks every TypeDoc declaration, and returns the five + * derived artifacts (`bySlug`, `flat`, `sections`, `functionsList`, + * `typeSpec`) plus the partial list needed for downstream `.mdx` seeding. + * + * Exported so tests can snapshot the output shape without going through the + * filesystem. + */ +export async function collectReferenceContent(library: string, version: string) { + const versionDir = join(SPEC_DIR, library, version) + const files = (await readdir(versionDir)).filter( + (f) => f.endsWith('.json') && f !== 'config.json' + ) + + const config = await readConfig(versionDir) + const partials = await readPartials(versionDir) + + const collected = { + functions: [] as FunctionEntry[], + typeSpec: { methods: {}, variables: {} } as TypeSpec, + } + for (const file of files) { + const raw = await readFile(join(versionDir, file), 'utf-8') + const spec = JSON.parse(raw) as Declaration + // Build a numeric id → node map per package file so `parseType`'s reference + // resolution can walk dereferenced types and aliased declarations. + const idMap = new Map() + buildMap(spec, idMap) + collectFunctions(spec, collected, idMap) + } + + const { bySlug, sections, functionsList } = buildBySlug(collected.functions, partials, config) + const flat = Object.values(bySlug) + return { bySlug, flat, sections, functionsList, typeSpec: collected.typeSpec, partials } +} + +/** + * Processes one `[library]/[version]` directory: reads spec files, partials, + * and config, then writes all five output files (`bySlug.json`, `flat.json`, + * `sections.json`, `functions.json`, `typeSpec.json`) in parallel. + */ +async function processVersion(library: string, version: string): Promise { + const { bySlug, flat, sections, functionsList, typeSpec, partials } = + await collectReferenceContent(library, version) + + const counts = { markdown: 0, function: 0, subcategory: 0, category: 0 } + for (const v of flat) { + if (v.type === 'markdown') counts.markdown++ + else if (v.type === 'category') counts.category++ + else if ('isFunc' in v && v.isFunc === false) counts.subcategory++ + else counts.function++ + } + + const outputDir = join(OUTPUT_DIR, library, version) + await mkdir(outputDir, { recursive: true }) + await Promise.all([ + writeFile(join(outputDir, 'bySlug.json'), JSON.stringify(bySlug)), + writeFile(join(outputDir, 'flat.json'), JSON.stringify(flat)), + writeFile(join(outputDir, 'sections.json'), JSON.stringify(sections)), + writeFile(join(outputDir, 'functions.json'), JSON.stringify(functionsList)), + writeFile(join(outputDir, 'typeSpec.json'), JSON.stringify(typeSpec)), + ]) + + // The page renderer's `MarkdownSection` loads body text by id from + // `docs/ref//.mdx`. Seed that file from any markdown partial + // whose runtime counterpart doesn't already exist (we don't overwrite + // hand-maintained legacy partials like introduction.mdx). + await writeNewMarkdownPartials(library, partials) + + const typeSpecMethods = Object.keys(typeSpec.methods).length + const typeSpecVariables = Object.keys(typeSpec.variables).length + console.log( + `[${library}/${version}] wrote 5 files — ${counts.markdown} partials, ${counts.function} function slugs, ${counts.subcategory} subcategories, ${counts.category} categories, ${functionsList.length} functions.json entries, ${typeSpecMethods} typeSpec methods, ${typeSpecVariables} typeSpec variables` + ) +} + +/** Entry point: discovers every `[library]/[version]` pair under `spec/reference` and processes each. */ +async function main(): Promise { + const libraries = await readdir(SPEC_DIR, { withFileTypes: true }) + for (const lib of libraries) { + if (!lib.isDirectory()) continue + const versions = await readdir(join(SPEC_DIR, lib.name), { withFileTypes: true }) + for (const version of versions) { + if (!version.isDirectory()) continue + await processVersion(lib.name, version.name) + } + } +} + +// Only run `main()` when invoked as a script (via `tsx`). Importing this +// module from a test should not trigger the side-effecting walk. +if (import.meta.url === `file://${process.argv[1]}`) { + main().catch((err) => { + console.error(err) + process.exit(1) + }) +} diff --git a/apps/docs/scripts/find-undocumented.ts b/apps/docs/scripts/find-undocumented.ts deleted file mode 100644 index c2524cab2a1..00000000000 --- a/apps/docs/scripts/find-undocumented.ts +++ /dev/null @@ -1,259 +0,0 @@ -/** - * Find methods in typeSpec.json that are NOT documented in supabase_js_v2.yml - * - * Usage: pnpm tsx scripts/find-undocumented.ts - * - * Note: Run `pnpm prebuild` first to generate typeSpec.json - */ - -import { existsSync, readFileSync } from 'fs' -import yaml from 'js-yaml' -import { dirname, join } from 'path' -import { fileURLToPath } from 'url' - -const __dirname = dirname(fileURLToPath(import.meta.url)) -const SPEC_DIR = join(__dirname, '../spec') -const GENERATED_DIR = join(__dirname, '../features/docs/generated') - -interface YamlFunction { - id: string - $ref?: string -} - -interface YamlSpec { - functions: YamlFunction[] -} - -interface TypeSpecModule { - name: string - methods: Record -} - -// Same normalization as Reference.typeSpec.ts -function normalizeRefPath(path: string) { - return path.replace(/\.index(?=\.|$)/g, '').replace(/\.+/g, '.') -} - -// Categorize a method path -function categorizeMethod(methodPath: string): 'public' | 'constructor' | 'error' | 'internal' { - const parts = methodPath.split('.') - const methodName = parts[parts.length - 1] - const className = parts[parts.length - 2] - - // Internal/private methods start with _ - if (methodName.startsWith('_')) { - return 'internal' - } - - // Error class constructors - if (className?.endsWith('Error') && methodName === 'constructor') { - return 'error' - } - - // Other constructors - if (methodName === 'constructor') { - return 'constructor' - } - - return 'public' -} - -// Dynamically detect re-exports from typeSpec data -// If a class exists in both @supabase/supabase-js and another @supabase/* package, -// prefer the other package (which is the original source) -function buildReexportMap(typeSpecModules: TypeSpecModule[]): Map { - const classToPackages = new Map>() - - for (const mod of typeSpecModules) { - for (const methodPath of Object.keys(mod.methods)) { - const parts = methodPath.split('.') - const pkg = parts[0] - const className = parts[1] - if (pkg?.startsWith('@supabase/') && className) { - if (!classToPackages.has(className)) { - classToPackages.set(className, new Set()) - } - classToPackages.get(className)!.add(pkg) - } - } - } - - // For classes in multiple packages, map supabase-js to the original package - const reexportMap = new Map() - for (const [className, packages] of classToPackages) { - if (packages.has('@supabase/supabase-js') && packages.size > 1) { - // Find the original package (not supabase-js) - for (const pkg of packages) { - if (pkg !== '@supabase/supabase-js') { - reexportMap.set(className, pkg) - break - } - } - } - } - return reexportMap -} - -// Get the "canonical" path (prefer original package over supabase-js re-exports) -function getCanonicalPath(methodPath: string, reexportMap: Map): string { - if (methodPath.startsWith('@supabase/supabase-js.')) { - const parts = methodPath.split('.') - const className = parts[1] - const originalPkg = reexportMap.get(className) - if (originalPkg) { - return methodPath.replace('@supabase/supabase-js', originalPkg) - } - } - return methodPath -} - -// Check if typeSpec.json exists -const typeSpecPath = join(GENERATED_DIR, 'typeSpec.json') -if (!existsSync(typeSpecPath)) { - console.error('ERROR: typeSpec.json not found!') - console.error('Run `pnpm prebuild` first to generate it.') - process.exit(1) -} - -// Load typeSpec.json and get all method paths -const typeSpecModules: TypeSpecModule[] = JSON.parse(readFileSync(typeSpecPath, 'utf8')) -const allMethods: string[] = [] - -for (const mod of typeSpecModules) { - for (const methodPath of Object.keys(mod.methods)) { - allMethods.push(methodPath) - } -} - -// Build re-export map dynamically from typeSpec data -const reexportMap = buildReexportMap(typeSpecModules) - -// Load YAML and get all documented $ref values (normalized) -const yamlPath = join(SPEC_DIR, 'supabase_js_v2.yml') -const spec = yaml.load(readFileSync(yamlPath, 'utf8')) as YamlSpec - -const documentedRefs = new Set() -for (const fn of spec.functions) { - if (fn.$ref) { - // Store both raw and normalized versions - documentedRefs.add(fn.$ref) - documentedRefs.add(normalizeRefPath(fn.$ref)) - } -} - -// Find undocumented methods and deduplicate -const seenCanonical = new Set() -const undocumented: string[] = [] - -for (const method of allMethods) { - // Get canonical path first (prefer original packages over supabase-js re-exports) - const canonical = getCanonicalPath(method, reexportMap) - - // Skip if already processed this canonical path - if (seenCanonical.has(canonical)) { - continue - } - seenCanonical.add(canonical) - - // Check if documented - check both raw path AND canonical path - if ( - documentedRefs.has(method) || - documentedRefs.has(normalizeRefPath(method)) || - documentedRefs.has(canonical) || - documentedRefs.has(normalizeRefPath(canonical)) - ) { - continue - } - - // Use canonical path for output - undocumented.push(canonical) -} - -// Categorize -const publicMethods: string[] = [] -const constructors: string[] = [] -const errorConstructors: string[] = [] -const internalMethods: string[] = [] - -for (const method of undocumented) { - switch (categorizeMethod(method)) { - case 'public': - publicMethods.push(method) - break - case 'constructor': - constructors.push(method) - break - case 'error': - errorConstructors.push(method) - break - case 'internal': - internalMethods.push(method) - break - } -} - -// Group public methods by package -const publicByPackage = new Map() -for (const method of publicMethods) { - const pkg = method.split('.')[0] - if (!publicByPackage.has(pkg)) { - publicByPackage.set(pkg, []) - } - publicByPackage.get(pkg)!.push(method) -} - -// Output public methods (the interesting ones) -console.log('╔═══════════════════════════════════════════════════════════════╗') -console.log('║ UNDOCUMENTED PUBLIC METHODS ║') -console.log('╚═══════════════════════════════════════════════════════════════╝') - -for (const [pkg, methods] of publicByPackage) { - console.log(`\n=== ${pkg} ===`) - methods.sort().forEach((m) => { - const shortName = m.replace(pkg + '.', '') - console.log(` - ${shortName}`) - }) -} - -// Summary sections for other categories -console.log('\n╔═══════════════════════════════════════════════════════════════╗') -console.log('║ SKIPPED CATEGORIES ║') -console.log('╚═══════════════════════════════════════════════════════════════╝') - -console.log(`\n[Constructors] (${constructors.length} items)`) -constructors - .sort() - .slice(0, 5) - .forEach((m) => console.log(` - ${m}`)) -if (constructors.length > 5) console.log(` ... and ${constructors.length - 5} more`) - -console.log(`\n[Error Constructors] (${errorConstructors.length} items)`) -errorConstructors - .sort() - .slice(0, 5) - .forEach((m) => console.log(` - ${m}`)) -if (errorConstructors.length > 5) console.log(` ... and ${errorConstructors.length - 5} more`) - -console.log(`\n[Internal/Private Methods] (${internalMethods.length} items)`) -internalMethods - .sort() - .slice(0, 5) - .forEach((m) => console.log(` - ${m}`)) -if (internalMethods.length > 5) console.log(` ... and ${internalMethods.length - 5} more`) - -// Final summary -const totalUndocumented = undocumented.length -const documentedCount = allMethods.length - totalUndocumented -const percentage = ((documentedCount / allMethods.length) * 100).toFixed(1) - -console.log('\n╔═══════════════════════════════════════════════════════════════╗') -console.log('║ SUMMARY ║') -console.log('╚═══════════════════════════════════════════════════════════════╝') -console.log(` Total methods in TypeSpec: ${allMethods.length}`) -console.log(` Documented in YAML: ${documentedCount}`) -console.log(` Undocumented (deduplicated): ${totalUndocumented}`) -console.log(` - Public methods: ${publicMethods.length} ← focus here`) -console.log(` - Constructors: ${constructors.length}`) -console.log(` - Error constructors: ${errorConstructors.length}`) -console.log(` - Internal methods: ${internalMethods.length}`) -console.log(` Coverage: ${percentage}%`) diff --git a/apps/docs/scripts/search/sources/index.ts b/apps/docs/scripts/search/sources/index.ts index e62f320f371..e8fb408c0c5 100644 --- a/apps/docs/scripts/search/sources/index.ts +++ b/apps/docs/scripts/search/sources/index.ts @@ -2,13 +2,14 @@ import { type GuideModel } from '../../../resources/guide/guideModel.js' import { GuideModelLoader } from '../../../resources/guide/guideModelLoader.js' import { LintWarningsGuideLoader, type LintWarningsGuideSource } from './lint-warnings-guide.js' import { MarkdownLoader, type MarkdownSource } from './markdown.js' -import { IntegrationLoader, type IntegrationSource, fetchPartners } from './partner-integrations.js' +import { fetchPartners, IntegrationLoader, type IntegrationSource } from './partner-integrations.js' import { - CliReferenceLoader, - type CliReferenceSource, ClientLibReferenceLoader, - type ClientLibReferenceSource, + CliReferenceLoader, + loadClientLibReferenceFromNewPipeline, OpenApiReferenceLoader, + type ClientLibReferenceSource, + type CliReferenceSource, type OpenApiReferenceSource, } from './reference-doc.js' import { fetchTroubleshootingSources, type TroubleshootingSource } from './troubleshooting.js' @@ -39,13 +40,15 @@ export async function fetchOpenApiReferenceSource() { } export async function fetchJsLibReferenceSource() { - return new ClientLibReferenceLoader( - 'js-lib', - '/reference/javascript', - { title: 'JavaScript Reference', language: 'JavaScript' }, - 'spec/supabase_js_v2.yml', - 'spec/common-client-libs-sections.json' - ).load() + // JS v2 is driven by the new reference pipeline. Ingest search sources from + // the generated `content/reference/javascript/v2/` outputs so embeddings + // never drift from what the renderer shows. + return loadClientLibReferenceFromNewPipeline({ + source: 'js-lib', + path: '/reference/javascript', + meta: { title: 'JavaScript Reference', language: 'JavaScript' }, + contentDir: 'content/reference/javascript/v2', + }) } export async function fetchDartLibReferenceSource() { diff --git a/apps/docs/scripts/search/sources/reference-doc.ts b/apps/docs/scripts/search/sources/reference-doc.ts index 68a28e5e418..2e433746fe7 100644 --- a/apps/docs/scripts/search/sources/reference-doc.ts +++ b/apps/docs/scripts/search/sources/reference-doc.ts @@ -2,10 +2,12 @@ import { createHash } from 'crypto' import { readFile } from 'fs/promises' import yaml from 'js-yaml' import type { OpenAPIV3 } from 'openapi-types' + import type { ICommonItem, ICommonSection, IFunctionDefinition, + IFunctionExample, ISpec, } from '../../../components/reference/Reference.types.js' import { getApiEndpointById } from '../../../features/docs/Reference.generated.singleton.js' @@ -276,6 +278,76 @@ export class ClientLibReferenceLoader extends ReferenceLoader//{sections,functions,typeSpec}.json`) instead + * of the legacy YAML. + * + * Each function entry in `functions.json` either has rich content inline + * (partial-authored entries like subcategory overviews) or just an `id` + + * `$ref` pointing into `typeSpec.json`'s `methods` map for the TSDoc-extracted + * description and examples. We merge those into the `IFunctionDefinition` + * shape `ClientLibReferenceSource` already knows how to render, so no + * downstream changes are needed. + */ +export async function loadClientLibReferenceFromNewPipeline({ + source, + path, + meta, + contentDir, +}: { + source: string + path: string + meta: Record + contentDir: string +}): Promise { + const [sectionsRaw, functionsRaw, typeSpecRaw] = await Promise.all([ + readFile(`${contentDir}/sections.json`, 'utf8'), + readFile(`${contentDir}/functions.json`, 'utf8'), + readFile(`${contentDir}/typeSpec.json`, 'utf8'), + ]) + + const refSections = JSON.parse(sectionsRaw) as ICommonItem[] + const functions = JSON.parse(functionsRaw) as Array<{ + id: string + $ref?: string + title?: string + description?: string + examples?: IFunctionExample[] + }> + const typeSpec = JSON.parse(typeSpecRaw) as { + methods: Record + } + + const enriched: IFunctionDefinition[] = functions.map((fn) => { + const typeSpecEntry = fn.$ref ? typeSpec.methods[fn.$ref] : undefined + return { + id: fn.id, + $ref: fn.$ref ?? '', + title: fn.title ?? '', + description: fn.description ?? typeSpecEntry?.comment?.shortText ?? '', + examples: fn.examples ?? typeSpecEntry?.comment?.examples, + } + }) + + const flattened = flattenSections(refSections) + + return flattened + .map((refSection) => { + const specSection = enriched.find((e) => e.id === refSection.id) + if (!specSection) return undefined + const titleForMeta = specSection.title || refSection.title + return new ClientLibReferenceSource( + source, + `${path}/${refSection.slug}`, + refSection, + specSection, + { ...meta, slug: specSection.id, methodName: titleForMeta } + ) + }) + .filter((s): s is ClientLibReferenceSource => s !== undefined) +} + export class ClientLibReferenceSource extends ReferenceSource { formatSection(functionDefinition: IFunctionDefinition, refSection: ICommonItem): string { const { title } = refSection diff --git a/apps/docs/scripts/validate-references.ts b/apps/docs/scripts/validate-references.ts deleted file mode 100644 index aeb411d8a9e..00000000000 --- a/apps/docs/scripts/validate-references.ts +++ /dev/null @@ -1,103 +0,0 @@ -/** - * Cross-check IDs between common-client-libs-sections.json and supabase_js_v2.yml - * - * Reports: - * 1. Functions in sections but NOT in YAML - * 2. Groups (isFunc: false) in sections but NOT in YAML - * 3. IDs in YAML but NOT in sections - * - * Usage: pnpm tsx scripts/validate-references.ts - */ - -import { readFileSync } from 'fs' -import yaml from 'js-yaml' -import { dirname, join } from 'path' -import { fileURLToPath } from 'url' - -const __dirname = dirname(fileURLToPath(import.meta.url)) -const SPEC_DIR = join(__dirname, '../spec') - -interface Section { - id?: string - type: string - isFunc?: boolean - items?: Section[] -} - -interface YamlSpec { - functions: Array<{ id: string }> -} - -// Flatten sections, extracting all function-type entries -function flattenSections(sections: Section[]): { functions: string[]; groups: string[] } { - const functions: string[] = [] - const groups: string[] = [] - - function recurse(items: Section[]) { - for (const item of items) { - if (item.type === 'function' && item.id) { - if (item.isFunc === false) { - groups.push(item.id) - } else { - functions.push(item.id) - } - } - if (item.items) { - recurse(item.items) - } - } - } - - recurse(sections) - return { functions, groups } -} - -// Main -const sectionsPath = join(SPEC_DIR, 'common-client-libs-sections.json') -const yamlPath = join(SPEC_DIR, 'supabase_js_v2.yml') - -const sections: Section[] = JSON.parse(readFileSync(sectionsPath, 'utf8')) -const spec = yaml.load(readFileSync(yamlPath, 'utf8')) as YamlSpec - -const { functions: sectionFunctions, groups: sectionGroups } = flattenSections(sections) -const yamlIds = new Set(spec.functions.map((f) => f.id)) - -const sectionFunctionSet = new Set(sectionFunctions) -const sectionGroupSet = new Set(sectionGroups) -const allSectionIds = new Set([...sectionFunctions, ...sectionGroups]) - -// Find mismatches -const functionsNotInYaml = sectionFunctions.filter((id) => !yamlIds.has(id)) -const groupsNotInYaml = sectionGroups.filter((id) => !yamlIds.has(id)) -const yamlNotInSections = [...yamlIds].filter((id) => !allSectionIds.has(id)) - -// Output -console.log('=== Functions in sections but NOT in YAML ===') -if (functionsNotInYaml.length === 0) { - console.log('(none)') -} else { - functionsNotInYaml.forEach((id) => console.log(`- ${id}`)) -} - -console.log('\n=== Groups (isFunc: false) in sections but NOT in YAML ===') -if (groupsNotInYaml.length === 0) { - console.log('(none)') -} else { - groupsNotInYaml.forEach((id) => console.log(`- ${id}`)) -} - -console.log('\n=== IDs in YAML but NOT in sections ===') -if (yamlNotInSections.length === 0) { - console.log('(none)') -} else { - yamlNotInSections.forEach((id) => console.log(`- ${id}`)) -} - -console.log( - `\nSummary: ${functionsNotInYaml.length} functions missing, ${groupsNotInYaml.length} groups missing, ${yamlNotInSections.length} orphaned` -) - -// Exit with error code if any mismatches -if (functionsNotInYaml.length > 0 || groupsNotInYaml.length > 0 || yamlNotInSections.length > 0) { - process.exit(1) -} diff --git a/apps/docs/scripts/validate-typespec-refs.ts b/apps/docs/scripts/validate-typespec-refs.ts deleted file mode 100644 index 3184056dec3..00000000000 --- a/apps/docs/scripts/validate-typespec-refs.ts +++ /dev/null @@ -1,87 +0,0 @@ -/** - * Validate that YAML $ref values exist in typeSpec.json - * - * Checks: supabase_js_v2.yml $ref → typeSpec.json (generated from combined.json) - * - * Usage: pnpm tsx scripts/validate-typespec-refs.ts - * - * Note: Run `pnpm prebuild` first to generate typeSpec.json - */ - -import { existsSync, readFileSync } from 'fs' -import yaml from 'js-yaml' -import { dirname, join } from 'path' -import { fileURLToPath } from 'url' - -const __dirname = dirname(fileURLToPath(import.meta.url)) -const SPEC_DIR = join(__dirname, '../spec') -const GENERATED_DIR = join(__dirname, '../features/docs/generated') - -interface YamlFunction { - id: string - $ref?: string -} - -interface YamlSpec { - functions: YamlFunction[] -} - -interface TypeSpecModule { - name: string - methods: Record -} - -// Same normalization as Reference.typeSpec.ts -function normalizeRefPath(path: string) { - return path.replace(/\.index(?=\.|$)/g, '').replace(/\.+/g, '.') -} - -// Check if typeSpec.json exists -const typeSpecPath = join(GENERATED_DIR, 'typeSpec.json') -if (!existsSync(typeSpecPath)) { - console.error('ERROR: typeSpec.json not found!') - console.error('Run `pnpm prebuild` first to generate it.') - process.exit(1) -} - -// Load typeSpec.json and extract all valid method paths -const typeSpecModules: TypeSpecModule[] = JSON.parse(readFileSync(typeSpecPath, 'utf8')) -const validRefs = new Set() - -for (const mod of typeSpecModules) { - for (const methodPath of Object.keys(mod.methods)) { - validRefs.add(methodPath) - } -} - -// Load YAML and extract $ref values -const yamlPath = join(SPEC_DIR, 'supabase_js_v2.yml') -const spec = yaml.load(readFileSync(yamlPath, 'utf8')) as YamlSpec - -const yamlRefs: Array<{ id: string; ref: string }> = [] -for (const fn of spec.functions) { - if (fn.$ref) { - yamlRefs.push({ id: fn.id, ref: fn.$ref }) - } -} - -// Find invalid refs - check both raw and normalized (matches runtime behavior) -const invalidRefs = yamlRefs.filter( - ({ ref }) => !validRefs.has(ref) && !validRefs.has(normalizeRefPath(ref)) -) -const validCount = yamlRefs.length - invalidRefs.length - -// Output -console.log('=== YAML $ref NOT found in TypeSpec ===') -if (invalidRefs.length === 0) { - console.log('(none)') -} else { - invalidRefs.forEach(({ id, ref }) => console.log(`- ${ref} (id: ${id})`)) -} - -console.log(`\n=== Valid refs: ${validCount} | Invalid refs: ${invalidRefs.length} ===`) - -// Exit with error code if any invalid refs -if (invalidRefs.length > 0) { - process.exit(1) -} diff --git a/apps/docs/spec/Makefile b/apps/docs/spec/Makefile index 64a91ebd119..cb598870827 100644 --- a/apps/docs/spec/Makefile +++ b/apps/docs/spec/Makefile @@ -37,12 +37,12 @@ download.storage.v1: # curl -sS https://supabase.github.io/functions-js/v1/spec.json > $(REPO_DIR)/enrichments/tsdoc_v1/functions.json download.tsdoc.v2: - curl -sS https://supabase.github.io/supabase-js/supabase-js/v2/spec.json > $(REPO_DIR)/enrichments/tsdoc_v2/supabase.json - curl -sS https://supabase.github.io/supabase-js/auth-js/v2/spec.json > $(REPO_DIR)/enrichments/tsdoc_v2/gotrue.json - curl -sS https://supabase.github.io/supabase-js/postgrest-js/v2/spec.json > $(REPO_DIR)/enrichments/tsdoc_v2/postgrest.json - curl -sS https://supabase.github.io/supabase-js/realtime-js/v2/spec.json > $(REPO_DIR)/enrichments/tsdoc_v2/realtime.json - curl -sS https://supabase.github.io/supabase-js/storage-js/v2/spec.json > $(REPO_DIR)/enrichments/tsdoc_v2/storage.json - curl -sS https://supabase.github.io/supabase-js/functions-js/v2/spec.json > $(REPO_DIR)/enrichments/tsdoc_v2/functions.json + curl -sS https://supabase.github.io/supabase-js/supabase-js/v2/spec.json > $(REPO_DIR)/reference/javascript/v2/supabase.json + curl -sS https://supabase.github.io/supabase-js/auth-js/v2/spec.json > $(REPO_DIR)/reference/javascript/v2/gotrue.json + curl -sS https://supabase.github.io/supabase-js/postgrest-js/v2/spec.json > $(REPO_DIR)/reference/javascript/v2/postgrest.json + curl -sS https://supabase.github.io/supabase-js/realtime-js/v2/spec.json > $(REPO_DIR)/reference/javascript/v2/realtime.json + curl -sS https://supabase.github.io/supabase-js/storage-js/v2/spec.json > $(REPO_DIR)/reference/javascript/v2/storage.json + curl -sS https://supabase.github.io/supabase-js/functions-js/v2/spec.json > $(REPO_DIR)/reference/javascript/v2/functions.json download.analytics.v0: curl -sS https://logflare.app/api/openapi > $(REPO_DIR)/analytics_v0_openapi.json @@ -50,7 +50,11 @@ download.analytics.v0: ############################################################################### # Transform docs into working files ############################################################################### -transform: dereference.api.v1 dereference.auth.v1 dereference.storage.v0 dereference.tsdoc.v2 combine.tsdoc.v2 +# `download.tsdoc.v2` now writes raw TypeDoc JSON directly under +# `reference/javascript/v2/` — the new pipeline (`scripts/build-reference-content.ts`, +# wired into `predev`/`prebuild` via `codegen:references:new`) walks those files +# at build time, so no separate `dereference` / `combine` step is needed. +transform: dereference.api.v1 dereference.auth.v1 dereference.storage.v0 dereference.api.v1: pnpm exec redocly bundle --dereferenced -o $(REPO_DIR)/transforms/api_v1_openapi_deparsed.json $(REPO_DIR)/api_v1_openapi.json @@ -64,54 +68,6 @@ dereference.storage.v0: dereference.analytics.v0: pnpm exec redocly bundle --dereferenced -o $(REPO_DIR)/transforms/analytics_v0_openapi_deparsed.json $(REPO_DIR)/analytics_v0_openapi.json -# No longer updated -# dereference.tsdoc.v1: -# cd $(GENERATOR_DIR) && npm run tsdoc:dereference:functions:v1 -# cd $(GENERATOR_DIR) && npm run tsdoc:dereference:gotrue:v1 -# cd $(GENERATOR_DIR) && npm run tsdoc:dereference:postgrest:v1 -# cd $(GENERATOR_DIR) && npm run tsdoc:dereference:realtime:v1 -# cd $(GENERATOR_DIR) && npm run tsdoc:dereference:storage:v1 -# cd $(GENERATOR_DIR) && npm run tsdoc:dereference:supabase:v1 - -dereference.tsdoc.v2: - cd $(GENERATOR_DIR) && pnpm run tsdoc:dereference:functions:v2 - cd $(GENERATOR_DIR) && pnpm run tsdoc:dereference:gotrue:v2 - cd $(GENERATOR_DIR) && pnpm run tsdoc:dereference:postgrest:v2 - cd $(GENERATOR_DIR) && pnpm run tsdoc:dereference:realtime:v2 - cd $(GENERATOR_DIR) && pnpm run tsdoc:dereference:storage:v2 - cd $(GENERATOR_DIR) && pnpm run tsdoc:dereference:supabase:v2 - -# No longer updated -# combine.tsdoc.v1: -# jq -s '{ name: "Combined Specs", children: [.[0], .[1], .[2], .[3], .[4], .[5]] }' \ -# $(REPO_DIR)/enrichments/tsdoc_v1/supabase_dereferenced.json \ -# $(REPO_DIR)/enrichments/tsdoc_v1/gotrue_dereferenced.json \ -# $(REPO_DIR)/enrichments/tsdoc_v1/postgrest_dereferenced.json \ -# $(REPO_DIR)/enrichments/tsdoc_v1/realtime_dereferenced.json \ -# $(REPO_DIR)/enrichments/tsdoc_v1/storage_dereferenced.json \ -# $(REPO_DIR)/enrichments/tsdoc_v1/functions_dereferenced.json \ -# > $(REPO_DIR)/enrichments/tsdoc_v1/combined.json - -combine.tsdoc.v2: - jq -s '{ name: "Combined Specs", children: [.[0], .[1], .[2], .[3], .[4], .[5]] }' \ - $(REPO_DIR)/enrichments/tsdoc_v2/supabase_dereferenced.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/gotrue_dereferenced.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/postgrest_dereferenced.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/realtime_dereferenced.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/storage_dereferenced.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/functions_dereferenced.json \ - > $(REPO_DIR)/enrichments/tsdoc_v2/combined.json - -combine-raw.tsdoc.v2: - jq -s '{ name: "Combined Specs", children: [.[0], .[1], .[2], .[3], .[4], .[5]] }' \ - $(REPO_DIR)/enrichments/tsdoc_v2/supabase.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/gotrue.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/postgrest.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/realtime.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/storage.json \ - $(REPO_DIR)/enrichments/tsdoc_v2/functions.json \ - > $(REPO_DIR)/enrichments/tsdoc_v2/combined_raw.json - ############################################################################### # Generate sections from OpenAPI 3.0 ############################################################################### diff --git a/apps/docs/spec/enrichments/tsdoc_v2/combined.json b/apps/docs/spec/enrichments/tsdoc_v2/combined.json deleted file mode 100644 index c0cb78f90b2..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/combined.json +++ /dev/null @@ -1,260672 +0,0 @@ -{ - "name": "Combined Specs", - "children": [ - { - "id": 0, - "name": "@supabase/supabase-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 12, - "name": "cors", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Canonical CORS configuration for Supabase Edge Functions\n\nThis module exports CORS headers that stay synchronized with the Supabase SDK.\nWhen new headers are added to the SDK, they are automatically included here,\npreventing CORS errors in Edge Functions." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Basic usage", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { corsHeaders } from '@supabase/supabase-js/cors'\n\nDeno.serve(async (req) => {\n if (req.method === 'OPTIONS') {\n return new Response('ok', { headers: corsHeaders })\n }\n\n return new Response(\n JSON.stringify({ data: 'Hello' }),\n { headers: { ...corsHeaders, 'Content-Type': 'application/json' } }\n )\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 13, - "name": "CorsHeaders", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type representing CORS headers as a record of header names to values" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 54, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L54" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 14, - "name": "corsHeaders", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default CORS headers for Supabase Edge Functions.\n\nIncludes all headers sent by Supabase client libraries and allows all standard HTTP methods.\nUse this for simple CORS configurations with wildcard origin." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Basic usage", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { corsHeaders } from '@supabase/supabase-js/cors'\n\nDeno.serve(async (req) => {\n if (req.method === 'OPTIONS') {\n return new Response('ok', { headers: corsHeaders })\n }\n\n return new Response(\n JSON.stringify({ data: 'Hello' }),\n { headers: { ...corsHeaders, 'Content-Type': 'application/json' } }\n )\n})\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 80, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L80" - } - ], - "type": { - "type": "reference", - "target": 13, - "name": "CorsHeaders", - "package": "@supabase/supabase-js" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Type Aliases", - "children": [13] - }, - { - "title": "Variables", - "children": [14] - } - ], - "categories": [ - { - "title": "Edge Functions", - "children": [14] - }, - { - "title": "Other", - "children": [13] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L1" - } - ] - }, - { - "id": 1, - "name": "index", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 925, - "name": "FunctionRegion", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 926, - "name": "Any", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "any" - } - }, - { - "id": 927, - "name": "ApNortheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-1" - } - }, - { - "id": 928, - "name": "ApNortheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 79, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-2" - } - }, - { - "id": 929, - "name": "ApSouth1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 80, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-south-1" - } - }, - { - "id": 930, - "name": "ApSoutheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 81, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-1" - } - }, - { - "id": 931, - "name": "ApSoutheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 82, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-2" - } - }, - { - "id": 932, - "name": "CaCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 83, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ca-central-1" - } - }, - { - "id": 933, - "name": "EuCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 84, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-central-1" - } - }, - { - "id": 934, - "name": "EuWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 85, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-1" - } - }, - { - "id": 935, - "name": "EuWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 86, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-2" - } - }, - { - "id": 936, - "name": "EuWest3", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 87, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-3" - } - }, - { - "id": 937, - "name": "SaEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 88, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "sa-east-1" - } - }, - { - "id": 938, - "name": "UsEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 89, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-east-1" - } - }, - { - "id": 939, - "name": "UsWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 90, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-west-1" - } - }, - { - "id": 940, - "name": "UsWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 91, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-west-2" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 926, 927, 928, 929, 930, 931, 932, 933, 934, 935, 936, 937, 938, 939, 940 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 76, - "character": 20 - } - ] - }, - { - "id": 3393, - "name": "REALTIME_LISTEN_TYPES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3394, - "name": "BROADCAST", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 123, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3396, - "name": "POSTGRES_CHANGES", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 125, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 3395, - "name": "PRESENCE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 124, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 3397, - "name": "SYSTEM", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 126, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "system" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3394, 3396, 3395, 3397] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 122, - "character": 20 - } - ] - }, - { - "id": 3398, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3399, - "name": "ALL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 117, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "*" - } - }, - { - "id": 3402, - "name": "DELETE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 120, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "DELETE" - } - }, - { - "id": 3400, - "name": "INSERT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 118, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "INSERT" - } - }, - { - "id": 3401, - "name": "UPDATE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 119, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3399, 3402, 3400, 3401] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 116, - "character": 20 - } - ] - }, - { - "id": 3403, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3405, - "name": "JOIN", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "join" - } - }, - { - "id": 3406, - "name": "LEAVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - }, - { - "id": 3404, - "name": "SYNC", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3405, 3406, 3404] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 28, - "character": 20 - } - ] - }, - { - "id": 3407, - "name": "REALTIME_SUBSCRIBE_STATES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3411, - "name": "CHANNEL_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 132, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - } - }, - { - "id": 3410, - "name": "CLOSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 131, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - } - }, - { - "id": 3408, - "name": "SUBSCRIBED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 129, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - } - }, - { - "id": 3409, - "name": "TIMED_OUT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 130, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3411, 3410, 3408, 3409] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 128, - "character": 20 - } - ] - }, - { - "id": 2561, - "name": "AuthApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error returned directly from the GoTrue REST API." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthApiError } from '@supabase/auth-js'\n\nthrow new AuthApiError('Invalid credentials', 400, 'invalid_credentials')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2562, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 45, - "character": 4 - } - ], - "signatures": [ - { - "id": 2563, - "name": "AuthApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 45, - "character": 4 - } - ], - "parameters": [ - { - "id": 2564, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2565, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2566, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2561, - "name": "AuthApiError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2570, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2568, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2569, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2567, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2571, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2572, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2573, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2577, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2578, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2575, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2574, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2576, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2577, 2575, 2574, 2576] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2562] - }, - { - "title": "Properties", - "children": [2570, 2568, 2567] - }, - { - "title": "Methods", - "children": [2571] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 43, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2543, - "name": "AuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error thrown by Supabase Auth helpers." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthError } from '@supabase/auth-js'\n\nthrow new AuthError('Unexpected auth error', 500, 'unexpected')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2544, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 24, - "character": 4 - } - ], - "signatures": [ - { - "id": 2545, - "name": "AuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 2546, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2547, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2548, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 2552, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2549, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2550, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2551, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 2553, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2554, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2555, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2559, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2560, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2557, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2556, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2558, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2559, 2557, 2556, 2558] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2544] - }, - { - "title": "Properties", - "children": [2552, 2549, 2551] - }, - { - "title": "Methods", - "children": [2553] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 13, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2561, - "name": "AuthApiError" - }, - { - "type": "reference", - "target": 2579, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError" - } - ] - }, - { - "id": 2666, - "name": "AuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when implicit grant redirects contain an error." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthImplicitGrantRedirectError } from '@supabase/auth-js'\n\nthrow new AuthImplicitGrantRedirectError('OAuth redirect failed', {\n error: 'access_denied',\n code: 'oauth_error',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2667, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 4 - } - ], - "signatures": [ - { - "id": 2668, - "name": "AuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 4 - } - ], - "parameters": [ - { - "id": 2669, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2670, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2671, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2673, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 141, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2672, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 140, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2673, 2672] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 43 - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2694, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2692, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2693, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2674, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 135, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2675, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2677, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 137, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2676, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 136, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2677, 2676] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 135, - "character": 13 - } - ] - } - } - ] - } - }, - { - "id": 2690, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2691, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2678, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 4 - } - ], - "signatures": [ - { - "id": 2679, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2680, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2684, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 147, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2685, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2686, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 148, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2687, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2689, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 150, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2688, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 149, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2689, 2688] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 148, - "character": 17 - } - ] - } - } - ] - } - }, - { - "id": 2682, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 145, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2681, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 144, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2683, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 146, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2684, 2686, 2682, 2681, 2683] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2667] - }, - { - "title": "Properties", - "children": [2694, 2692, 2674, 2690, 2691] - }, - { - "title": "Methods", - "children": [2678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 134, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2649, - "name": "AuthInvalidCredentialsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when email/password credentials are invalid." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidCredentialsError } from '@supabase/auth-js'\n\nthrow new AuthInvalidCredentialsError('Email or password is incorrect')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2650, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 119, - "character": 4 - } - ], - "signatures": [ - { - "id": 2651, - "name": "AuthInvalidCredentialsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 119, - "character": 4 - } - ], - "parameters": [ - { - "id": 2652, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2649, - "name": "AuthInvalidCredentialsError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2657, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2655, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2653, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2654, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2658, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2659, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2660, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2664, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2665, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2662, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2661, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2663, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2664, 2662, 2661, 2663] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2650] - }, - { - "title": "Properties", - "children": [2657, 2655, 2653, 2654] - }, - { - "title": "Methods", - "children": [2658] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 118, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2796, - "name": "AuthInvalidJwtError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a JWT cannot be verified or parsed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidJwtError } from '@supabase/auth-js'\n\nthrow new AuthInvalidJwtError('Token signature is invalid')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2797, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 280, - "character": 4 - } - ], - "signatures": [ - { - "id": 2798, - "name": "AuthInvalidJwtError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 280, - "character": 4 - } - ], - "parameters": [ - { - "id": 2799, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2796, - "name": "AuthInvalidJwtError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2804, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2802, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2803, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2800, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2801, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2805, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2806, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2807, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2811, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2812, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2809, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2808, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2810, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2811, 2809, 2808, 2810] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2797] - }, - { - "title": "Properties", - "children": [2804, 2802, 2800, 2801] - }, - { - "title": "Methods", - "children": [2805] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 279, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2633, - "name": "AuthInvalidTokenResponseError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the token response is malformed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidTokenResponseError } from '@supabase/auth-js'\n\nthrow new AuthInvalidTokenResponseError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2634, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 106, - "character": 4 - } - ], - "signatures": [ - { - "id": 2635, - "name": "AuthInvalidTokenResponseError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2633, - "name": "AuthInvalidTokenResponseError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2640, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2638, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2639, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2636, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2637, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2641, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2642, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2643, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2647, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2648, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2645, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2644, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2646, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2647, 2645, 2644, 2646] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2634] - }, - { - "title": "Properties", - "children": [2640, 2638, 2636, 2637] - }, - { - "title": "Methods", - "children": [2641] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 105, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the PKCE code verifier is not found in storage.\nThis typically happens when the auth flow was initiated in a different\nbrowser, device, or the storage was cleared." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCECodeVerifierMissingError } from '@supabase/auth-js'\n\nthrow new AuthPKCECodeVerifierMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2725, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 198, - "character": 4 - } - ], - "signatures": [ - { - "id": 2726, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 198, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2731, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2729, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2730, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2727, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2728, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2732, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2733, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2734, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2738, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2739, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2736, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2735, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2737, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2738, 2736, 2735, 2737] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2725] - }, - { - "title": "Properties", - "children": [2731, 2729, 2727, 2728] - }, - { - "title": "Methods", - "children": [2732] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 197, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2695, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown during PKCE code exchanges." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'\n\nthrow new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2696, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 4 - } - ], - "signatures": [ - { - "id": 2697, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 4 - } - ], - "parameters": [ - { - "id": 2698, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2699, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2700, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2702, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 172, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2701, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 171, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2702, 2701] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 43 - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2695, - "name": "AuthPKCEGrantCodeExchangeError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2723, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2721, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2722, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2703, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 166, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2704, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2706, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 168, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2705, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 167, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2706, 2705] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 166, - "character": 13 - } - ] - } - } - ] - } - }, - { - "id": 2719, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2720, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2707, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 4 - } - ], - "signatures": [ - { - "id": 2708, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2709, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2713, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 178, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2714, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2715, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 179, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2716, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2718, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 181, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2717, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 180, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2718, 2717] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 179, - "character": 17 - } - ] - } - } - ] - } - }, - { - "id": 2711, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 176, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2710, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 175, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2712, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 177, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2713, 2715, 2711, 2710, 2712] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2696] - }, - { - "title": "Properties", - "children": [2723, 2721, 2703, 2719, 2720] - }, - { - "title": "Methods", - "children": [2707] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 165, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2758, - "name": "AuthRefreshDiscardedError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returned when the server rotated a refresh token successfully but the\nclient chose not to persist the rotated tokens because the local session\nchanged mid-flight. Usually means a concurrent " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " cleared storage\nbetween when the refresh started and when it came back.\n\nSet on the " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " field of the refresh result so callers can tell \"we\ngot rotated tokens but threw them away\" apart from \"the refresh failed.\"\nThe rotated session on the server will be picked up on the next refresh\nvia GoTrue's parent-of-active path." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { isAuthRefreshDiscardedError } from '@supabase/auth-js'\n\nif (isAuthRefreshDiscardedError(error)) {\n // Concurrent signOut/sign-in raced our refresh. Treat as a no-op.\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2759, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 236, - "character": 4 - } - ], - "signatures": [ - { - "id": 2760, - "name": "AuthRefreshDiscardedError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 236, - "character": 4 - } - ], - "parameters": [ - { - "id": 2761, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2766, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2764, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2765, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2762, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2763, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2767, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2768, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2773, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2774, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2771, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2770, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2772, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2773, 2771, 2770, 2772] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2759] - }, - { - "title": "Properties", - "children": [2766, 2764, 2762, 2763] - }, - { - "title": "Methods", - "children": [2767] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 235, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2740, - "name": "AuthRetryableFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a transient fetch issue occurs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthRetryableFetchError } from '@supabase/auth-js'\n\nthrow new AuthRetryableFetchError('Service temporarily unavailable', 503)\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2741, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 212, - "character": 4 - } - ], - "signatures": [ - { - "id": 2742, - "name": "AuthRetryableFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 212, - "character": 4 - } - ], - "parameters": [ - { - "id": 2743, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2744, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2749, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2747, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2748, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2745, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2746, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2750, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2751, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2756, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2757, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2754, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2753, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2755, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2756, 2754, 2753, 2755] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2741] - }, - { - "title": "Properties", - "children": [2749, 2747, 2745, 2746] - }, - { - "title": "Methods", - "children": [2750] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 211, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2617, - "name": "AuthSessionMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when an operation requires a session but none is present." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthSessionMissingError } from '@supabase/auth-js'\n\nthrow new AuthSessionMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2618, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 92, - "character": 4 - } - ], - "signatures": [ - { - "id": 2619, - "name": "AuthSessionMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 92, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2624, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2622, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2623, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2620, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2621, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2625, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2626, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2627, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2631, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2632, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2629, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2628, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2630, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2631, 2629, 2628, 2630] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2618] - }, - { - "title": "Properties", - "children": [2624, 2622, 2620, 2621] - }, - { - "title": "Methods", - "children": [2625] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 91, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2579, - "name": "AuthUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps non-standard errors so callers can inspect the root cause." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthUnknownError } from '@supabase/auth-js'\n\ntry {\n await someAuthCall()\n} catch (err) {\n throw new AuthUnknownError('Auth failed', err)\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2580, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 64, - "character": 4 - } - ], - "signatures": [ - { - "id": 2581, - "name": "AuthUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 64, - "character": 4 - } - ], - "parameters": [ - { - "id": 2582, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2583, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 2579, - "name": "AuthUnknownError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2588, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2585, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2586, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2584, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 2587, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2589, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2590, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2591, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2595, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2593, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2592, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2594, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2595, 2593, 2592, 2594] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2580] - }, - { - "title": "Properties", - "children": [2588, 2585, 2584, 2587] - }, - { - "title": "Methods", - "children": [2589] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 62, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2775, - "name": "AuthWeakPasswordError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a supplied password is considered weak." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthWeakPasswordError } from '@supabase/auth-js'\n\nthrow new AuthWeakPasswordError('Password too short', 400, ['min_length'])\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2776, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 259, - "character": 4 - } - ], - "signatures": [ - { - "id": 2777, - "name": "AuthWeakPasswordError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 259, - "character": 4 - } - ], - "parameters": [ - { - "id": 2778, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2779, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2780, - "name": "reasons", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2795, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2793, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2791, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2781, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reasons why the password is deemed weak." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 258, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 2792, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2782, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 4 - } - ], - "signatures": [ - { - "id": 2783, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2784, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2788, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 264, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2789, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2786, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 262, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2785, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 261, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2790, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 265, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 2787, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 263, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2788, 2786, 2785, 2790, 2787] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2776] - }, - { - "title": "Properties", - "children": [2795, 2793, 2791, 2781, 2792] - }, - { - "title": "Methods", - "children": [2782] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 254, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2597, - "name": "CustomAuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Flexible error class used to create named auth errors at runtime." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { CustomAuthError } from '@supabase/auth-js'\n\nthrow new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2598, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 79, - "character": 4 - } - ], - "signatures": [ - { - "id": 2599, - "name": "CustomAuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 79, - "character": 4 - } - ], - "parameters": [ - { - "id": 2600, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2601, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2602, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2603, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2608, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2606, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2607, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2604, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "AuthError.name" - } - }, - { - "id": 2605, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2609, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2610, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2611, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2615, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2616, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2613, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2612, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2614, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2615, 2613, 2612, 2614] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2598] - }, - { - "title": "Properties", - "children": [2608, 2606, 2604, 2605] - }, - { - "title": "Methods", - "children": [2609] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 76, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "target": 2633, - "name": "AuthInvalidTokenResponseError" - }, - { - "type": "reference", - "target": 2649, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "target": 2695, - "name": "AuthPKCEGrantCodeExchangeError" - }, - { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError" - }, - { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError" - }, - { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError" - }, - { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError" - }, - { - "type": "reference", - "target": 2796, - "name": "AuthInvalidJwtError" - } - ] - }, - { - "id": 912, - "name": "FunctionsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error for Supabase Edge Function invocations." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsError } from '@supabase/functions-js'\n\nthrow new FunctionsError('Unexpected error invoking function', 'FunctionsError', {\n requestId: 'abc123',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 913, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 30, - "character": 4 - } - ], - "signatures": [ - { - "id": 914, - "name": "FunctionsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 30, - "character": 4 - } - ], - "parameters": [ - { - "id": 915, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 917, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 918, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 919, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 920, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 921, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 924, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 923, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 922, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [924, 923, 922] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [913] - }, - { - "title": "Properties", - "children": [918] - }, - { - "title": "Methods", - "children": [919] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 28, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 879, - "name": "FunctionsHttpError" - }, - { - "type": "reference", - "target": 890, - "name": "FunctionsFetchError" - }, - { - "type": "reference", - "target": 901, - "name": "FunctionsRelayError" - } - ] - }, - { - "id": 890, - "name": "FunctionsFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the network request to an Edge Function fails." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsFetchError } from '@supabase/functions-js'\n\nthrow new FunctionsFetchError({ requestId: 'abc123' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 891, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 48, - "character": 4 - } - ], - "signatures": [ - { - "id": 892, - "name": "FunctionsFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 48, - "character": 4 - } - ], - "parameters": [ - { - "id": 893, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 890, - "name": "FunctionsFetchError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 894, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 895, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 896, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 897, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 900, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 899, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 898, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [900, 899, 898] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [891] - }, - { - "title": "Properties", - "children": [894] - }, - { - "title": "Methods", - "children": [895] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 47, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 879, - "name": "FunctionsHttpError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Edge Function returns a non-2xx status code." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsHttpError } from '@supabase/functions-js'\n\nthrow new FunctionsHttpError({ status: 500 })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 880, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 74, - "character": 4 - } - ], - "signatures": [ - { - "id": 881, - "name": "FunctionsHttpError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 74, - "character": 4 - } - ], - "parameters": [ - { - "id": 882, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 879, - "name": "FunctionsHttpError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 883, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 884, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 885, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 886, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 889, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 888, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 887, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [889, 888, 887] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [880] - }, - { - "title": "Properties", - "children": [883] - }, - { - "title": "Methods", - "children": [884] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 73, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 901, - "name": "FunctionsRelayError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Supabase relay cannot reach the Edge Function." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsRelayError } from '@supabase/functions-js'\n\nthrow new FunctionsRelayError({ region: 'us-east-1' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 902, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 61, - "character": 4 - } - ], - "signatures": [ - { - "id": 903, - "name": "FunctionsRelayError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 61, - "character": 4 - } - ], - "parameters": [ - { - "id": 904, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 901, - "name": "FunctionsRelayError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 905, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 906, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 907, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 908, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 911, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 910, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 909, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [911, 910, 909] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [902] - }, - { - "title": "Properties", - "children": [905] - }, - { - "title": "Methods", - "children": [906] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 60, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 1124, - "name": "GoTrueAdminApi", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1125, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 4 - } - ], - "signatures": [ - { - "id": 1126, - "name": "GoTrueAdminApi", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an admin API client that can be used to manage users and OAuth clients." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\nconst { data, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueAdminApi } from '@supabase/auth-js'\n\nconst admin = new GoTrueAdminApi({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { Authorization: `Bearer ${process.env.SUPABASE_SECRET_KEY}` },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 4 - } - ], - "parameters": [ - { - "id": 1127, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1128, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1142, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1134, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1135, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1136, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1137, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1138, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1139, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1140, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1141, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1130, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 49, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 49, - "character": 18 - } - ], - "indexSignatures": [ - { - "id": 1132, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 50, - "character": 12 - } - ], - "parameters": [ - { - "id": 1133, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1129, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 48, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1142, 1134, 1130, 1129] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 56 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1145, - "name": "customProviders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2343, - "name": "GoTrueAdminCustomProvidersApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1160, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 25, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1152, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 24, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1154, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1155, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1156, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1157, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1158, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1159, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1148, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 21, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1149, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 21, - "character": 23 - } - ], - "indexSignatures": [ - { - "id": 1150, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 22, - "character": 8 - } - ], - "parameters": [ - { - "id": 1151, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1143, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all MFA administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 6, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2096, - "name": "GoTrueAdminMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1144, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 11, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2228, - "name": "GoTrueAdminOAuthApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1146, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all passkey administration methods.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2512, - "name": "GoTrueAdminPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1147, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 20, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1178, - "name": "createUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 335, - "character": 4 - } - ], - "signatures": [ - { - "id": 1179, - "name": "createUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To confirm the user's email address or phone number, set " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " to true. Both arguments default to false.\n- " - }, - { - "kind": "code", - "text": "`createUser()`" - }, - { - "kind": "text", - "text": " will not send a confirmation email to the user. You can use [" - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " param to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "With custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n password: 'password',\n user_metadata: { name: 'Yoda' }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With custom user metadata\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n email_confirm: true\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n phone: '1234567890',\n phone_confirm: true\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 335, - "character": 4 - } - ], - "parameters": [ - { - "id": 1180, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1750, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1202, - "name": "deleteUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 613, - "character": 4 - } - ], - "signatures": [ - { - "id": 1203, - "name": "deleteUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a user. Requires a " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`deleteUser()`" - }, - { - "kind": "text", - "text": " method requires the user's ID, which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Removes a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.deleteUser(\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Removes a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {}\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 613, - "character": 4 - } - ], - "parameters": [ - { - "id": 1204, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user id you want to remove." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1205, - "name": "shouldSoftDelete", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1175, - "name": "generateLink", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 254, - "character": 4 - } - ], - "signatures": [ - { - "id": 1176, - "name": "generateLink", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates email links and OTPs to be sent via a custom email provider." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The following types can be passed into " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": ": " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_current`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_new`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " only generates the email link for " - }, - { - "kind": "code", - "text": "`email_change_email`" - }, - { - "kind": "text", - "text": " if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " handles the creation of the user for " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Generate a signup link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'signup',\n email: 'email@example.com',\n password: 'secret'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Generate a signup link\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"properties\": {\n \"action_link\": \"\",\n \"email_otp\": \"999999\",\n \"hashed_token\": \"\",\n \"verification_type\": \"signup\"\n },\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"email@example.com\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"email@example.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate an invite link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'invite',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a magic link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'magiclink',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a recovery link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'recovery',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate links to change current email address", - "content": [ - { - "kind": "code", - "text": "```js\n// generate an email change link to be sent to the current email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_current',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n\n// generate an email change link to be sent to the new email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_new',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 254, - "character": 4 - } - ], - "parameters": [ - { - "id": 1177, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1964, - "name": "GenerateLinkParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1965, - "name": "GenerateLinkResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1195, - "name": "getUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 435, - "character": 4 - } - ], - "signatures": [ - { - "id": 1196, - "name": "getUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get user by id." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Fetches the user object from the database based on the user's id.\n- The " - }, - { - "kind": "code", - "text": "`getUserById()`" - }, - { - "kind": "text", - "text": " method requires the user's id which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Fetch the user object using the access_token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.getUserById(1)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Fetch the user object using the access_token jwt\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 435, - "character": 4 - } - ], - "parameters": [ - { - "id": 1197, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1168, - "name": "inviteUserByEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 4 - } - ], - "signatures": [ - { - "id": 1169, - "name": "inviteUserByEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends an invite link to an email address." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Sends an invite link to the user's email address.\n- The " - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": " method is typically used by administrators to invite users to join the application.\n- Note that PKCE is not supported when using " - }, - { - "kind": "code", - "text": "`inviteUserByEmail`" - }, - { - "kind": "text", - "text": ". This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow." - } - ] - }, - { - "tag": "@example", - "name": "Invite a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Invite a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"invited_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 4 - } - ], - "parameters": [ - { - "id": 1170, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1171, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options to be included when inviting." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1172, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1173, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store additional metadata about the user. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.user_metadata`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 133, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1174, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 135, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1173, 1174] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 47 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1181, - "name": "listUsers", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 4 - } - ], - "signatures": [ - { - "id": 1182, - "name": "listUsers", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Defaults to return 50 users per page." - } - ] - }, - { - "tag": "@example", - "name": "Get a page of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Paginated list of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\n page: 1,\n perPage: 1000\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 4 - } - ], - "parameters": [ - { - "id": 1183, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object which supports " - }, - { - "kind": "code", - "text": "`page`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`perPage`" - }, - { - "kind": "text", - "text": " as numbers, to alter the paginated results." - } - ] - }, - "type": { - "type": "reference", - "target": 2117, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1184, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1185, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 362, - "character": 8 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1186, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1188, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 364, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1187, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 363, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1188, 1187] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 362, - "character": 14 - } - ] - } - }, - { - "type": "reference", - "target": 2110, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1189, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 366, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1185, 1189] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 44 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1190, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1191, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 368, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1192, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1193, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 369, - "character": 12 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1193] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 368, - "character": 14 - } - ] - } - } - }, - { - "id": 1194, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 371, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1191, 1194] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 367, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1161, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 4 - } - ], - "signatures": [ - { - "id": 1162, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a logged-in session." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 4 - } - ], - "parameters": [ - { - "id": 1163, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A valid, logged-in JWT." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1164, - "name": "scope", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logout sope." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1166, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 64, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1167, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 65, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1166, 1167] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 56 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1198, - "name": "updateUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 580, - "character": 4 - } - ], - "signatures": [ - { - "id": 1199, - "name": "updateUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the user data. Changes are applied directly without confirmation flows." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "**Important:** This is a server-side operation and does **not** trigger client-side\n" - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " listeners. The admin API has no connection to client state.\n\nTo sync changes to the client after calling this method:\n1. On the client, call " - }, - { - "kind": "code", - "text": "`supabase.auth.refreshSession()`" - }, - { - "kind": "text", - "text": " to fetch the updated user data\n2. This will trigger the " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event and notify all listeners" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\n// Server-side (Edge Function)\nconst { data, error } = await supabase.auth.admin.updateUserById(\n userId,\n { user_metadata: { preferences: { theme: 'dark' } } }\n)\n\n// Client-side (to sync the changes)\nconst { data, error } = await supabase.auth.refreshSession()\n// onAuthStateChange listeners will now be notified with updated user\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.refreshSession", - "target": 1405 - }, - { - "kind": "text", - "text": " for syncing admin changes to the client" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.updateUser", - "target": 1381 - }, - { - "kind": "text", - "text": " for client-side user updates (triggers listeners automatically)" - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '11111111-1111-1111-1111-111111111111',\n { email: 'new@email.com' }\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updates a user's email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"new@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { password: 'new_password' }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { user_metadata: { hello: 'world' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's app_metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { app_metadata: { plan: 'trial' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's email address", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { email_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { phone_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Ban a user for 100 years", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { ban_duration: '876000h' }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 580, - "character": 4 - } - ], - "parameters": [ - { - "id": 1200, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1201, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "reference", - "target": 1750, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1125] - }, - { - "title": "Properties", - "children": [1145, 1160, 1152, 1148, 1143, 1144, 1146, 1147] - }, - { - "title": "Methods", - "children": [1178, 1202, 1175, 1195, 1168, 1181, 1161, 1198] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1178, 1202, 1175, 1195, 1168, 1181, 1161, 1198] - }, - { - "title": "Other", - "children": [1125, 1145, 1160, 1152, 1148, 1143, 1144, 1146, 1147] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 4, - "character": 21 - } - ] - }, - { - "id": 1221, - "name": "GoTrueClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1223, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 134, - "character": 4 - } - ], - "signatures": [ - { - "id": 1224, - "name": "GoTrueClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueClient } from '@supabase/auth-js'\n\nconst auth = new GoTrueClient({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { apikey: 'your-publishable-key' },\n storageKey: 'supabase-auth',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 134, - "character": 4 - } - ], - "parameters": [ - { - "id": 1225, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1599, - "name": "GoTrueClientOptions", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": 1221, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1260, - "name": "_sessionRemovalEpoch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Monotonic counter incremented at the top of " - }, - { - "kind": "code", - "text": "`_removeSession`" - }, - { - "kind": "text", - "text": ", before any\n" - }, - { - "kind": "code", - "text": "`await`" - }, - { - "kind": "text", - "text": ". The commit guard inside " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": " captures this value\nbefore " - }, - { - "kind": "code", - "text": "`_saveSession`" - }, - { - "kind": "text", - "text": " and re-checks it after, so a " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " that\ninterleaves inside " - }, - { - "kind": "code", - "text": "`_saveSession`" - }, - { - "kind": "text", - "text": "'s storage-write awaits is still caught\n(the post-fetch storage snapshot alone misses that window)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 69, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1227, - "name": "admin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - }, - { - "id": 1254, - "name": "autoRefreshTicker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 58, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/timers.d.ts", - "qualifiedName": "__global.NodeJS.Timeout" - }, - "name": "Timeout", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.Timeout" - } - ] - } - }, - { - "id": 1255, - "name": "autoRefreshTickTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 59, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/timers.d.ts", - "qualifiedName": "__global.NodeJS.Timeout" - }, - "name": "Timeout", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.Timeout" - } - ] - } - }, - { - "id": 1245, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 47, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1291, - "name": "broadcastChannel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to broadcast state change events to other tabs listening." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 109, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "BroadcastChannel" - }, - "name": "BroadcastChannel", - "package": "typescript" - } - ] - } - }, - { - "id": 1262, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1263, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 45 - } - ], - "signatures": [ - { - "id": 1264, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 45 - } - ], - "parameters": [ - { - "id": 1265, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1266, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1267, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 64 - } - ], - "indexSignatures": [ - { - "id": 1268, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 78, - "character": 8 - } - ], - "parameters": [ - { - "id": 1269, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1290, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. Defaults to an empty object.\nSee " - }, - { - "kind": "code", - "text": "`GoTrueClientOptions.experimental`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 105, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1277, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 86, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1278, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1279, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1280, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1281, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1282, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1283, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1284, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1232, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 35, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1810, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1275, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 84, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1271, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 81, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1272, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 81, - "character": 23 - } - ], - "indexSignatures": [ - { - "id": 1273, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 82, - "character": 8 - } - ], - "parameters": [ - { - "id": 1274, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1261, - "name": "initializePromise", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Keeps track of the async client initialization.\nWhen null or not yet resolved the auth state is " - }, - { - "kind": "code", - "text": "`unknown`" - }, - { - "kind": "text", - "text": "\nOnce resolved the auth state is known and it's safe to call any further client methods.\nKeep extra care to never reject or throw uncaught errors" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 76, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2106, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - }, - { - "id": 1285, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom lock function passed via " - }, - { - "kind": "code", - "text": "`settings.lock`" - }, - { - "kind": "text", - "text": ". When non-null, every auth\noperation runs inside " - }, - { - "kind": "code", - "text": "`_acquireLock`" - }, - { - "kind": "text", - "text": ". When null (the default), the client\nuses its lockless coordination (refresh single-flight + commit guard).\nTODO(v3): remove along with the legacy lock path." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 93, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1590, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1286, - "name": "lockAcquired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 94, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1289, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is supplied. TODO(v3): remove." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 100, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1292, - "name": "logDebugMessages", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 110, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1293, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1294, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 22 - } - ], - "signatures": [ - { - "id": 1295, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 22 - } - ], - "parameters": [ - { - "id": 1296, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1297, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 1249, - "name": "memoryStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 54, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1250, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 54, - "character": 29 - } - ], - "indexSignatures": [ - { - "id": 1251, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 55, - "character": 8 - } - ], - "parameters": [ - { - "id": 1252, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ] - } - }, - { - "id": 1228, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the MFA methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2025, - "name": "GoTrueMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1229, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the OAuth 2.1 authorization server methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\nUsed to implement the authorization code flow on the consent page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2392, - "name": "AuthOAuthServerApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1230, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for passkey methods.\nIncludes lower-level two-step registration/authentication and passkey management.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2492, - "name": "AuthPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1287, - "name": "pendingInLock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 95, - "character": 14 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - }, - { - "id": 1246, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 48, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1259, - "name": "refreshingDeferred", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 61, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/helpers.ts", - "qualifiedName": "Deferred" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2109, - "name": "CallRefreshTokenResult", - "package": "@supabase/auth-js" - } - ], - "name": "Deferred", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1253, - "name": "stateChangeEmitters", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 57, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.collection.d.ts", - "qualifiedName": "Map" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - ], - "name": "Map", - "package": "typescript" - } - }, - { - "id": 1247, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 49, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 1231, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The storage key used to identify the values saved in localStorage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 34, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1276, - "name": "suppressGetSessionWarning", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 85, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1288, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 96, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1270, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 80, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1248, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 53, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1256, - "name": "visibilityChangedCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1257, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 42 - } - ], - "signatures": [ - { - "id": 1258, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 42 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 1233, - "name": "jwks", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 18 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 18 - } - ], - "getSignature": { - "id": 1234, - "name": "jwks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The JWKS used for verifying asymmetric JWTs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 18 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1235, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1236, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 40, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1236] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 26 - } - ] - } - } - }, - "setSignature": { - "id": 1237, - "name": "jwks", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 18 - } - ], - "parameters": [ - { - "id": 1238, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1239, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1240, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 43, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1240] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 30 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 1241, - "name": "jwks_cached_at", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 45, - "character": 18 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 46, - "character": 18 - } - ], - "getSignature": { - "id": 1242, - "name": "jwks_cached_at", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 45, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - "setSignature": { - "id": 1243, - "name": "jwks_cached_at", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 46, - "character": 18 - } - ], - "parameters": [ - { - "id": 1244, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 1410, - "name": "_refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 14 - } - ], - "signatures": [ - { - "id": 1411, - "name": "_refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 14 - } - ], - "parameters": [ - { - "id": 1412, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1414, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1911, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 47 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1399, - "name": "_setSession", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 14 - } - ], - "signatures": [ - { - "id": 1400, - "name": "_setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 14 - } - ], - "parameters": [ - { - "id": 1401, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1403, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1779, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1404, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1780, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1403, 1404] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 42 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1423, - "name": "_signOut", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 14 - } - ], - "signatures": [ - { - "id": 1424, - "name": "_signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 14 - } - ], - "parameters": [ - { - "id": 1425, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2121, - "name": "SignOut", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1426, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1427, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1974, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1427] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 53 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1387, - "name": "_updateUser", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 14 - } - ], - "signatures": [ - { - "id": 1388, - "name": "_updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 14 - } - ], - "parameters": [ - { - "id": 1389, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 1390, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1392, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1648, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1392] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 64 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1506, - "name": "dispose", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2320, - "character": 4 - } - ], - "signatures": [ - { - "id": 1507, - "name": "dispose", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tears down the client's background work: stops the auto-refresh interval,\nremoves the " - }, - { - "kind": "code", - "text": "`visibilitychange`" - }, - { - "kind": "text", - "text": " listener, closes the cross-tab\n" - }, - { - "kind": "code", - "text": "`BroadcastChannel`" - }, - { - "kind": "text", - "text": ", and clears registered " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " subscribers.\n\nCall this from cleanup hooks when the client is being replaced before\nits JS realm is destroyed. React Strict Mode and HMR are the common\ncases. Any in-flight " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " calls continue to completion and may still\nwrite to storage; dispose doesn't abort them or erase storage.\n\nLifecycle caveat: because in-flight refreshes are not aborted, a\ndisposed instance can still persist a rotated session to storage after\n" - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " returns. A subsequent " - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " against the same\n" - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " will pick up that session on its next read. If you need\nstrict isolation between client lifecycles, await any pending auth\noperation before calling " - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " (or change the " - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " for\nthe replacement client).\n\nSafe to call repeatedly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup on React unmount", - "content": [ - { - "kind": "code", - "text": "```ts\nuseEffect(() => {\n const client = createClient(...)\n return () => { client.auth.dispose() }\n}, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2320, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1318, - "name": "exchangeCodeForSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 797, - "character": 4 - } - ], - "signatures": [ - { - "id": 1319, - "name": "exchangeCodeForSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Used when " - }, - { - "kind": "code", - "text": "`flowType`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`pkce`" - }, - { - "kind": "text", - "text": " in client options." - } - ] - }, - { - "tag": "@example", - "name": "Exchange Auth Code", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Exchange Auth Code\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n session: {\n access_token: '',\n token_type: 'bearer',\n expires_in: 3600,\n expires_at: 1700000000,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com'\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n \"provider\": \"email\",\n \"providers\": [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n provider_token: '',\n provider_refresh_token: ''\n },\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n redirectType: null\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 797, - "character": 4 - } - ], - "parameters": [ - { - "id": 1320, - "name": "authCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1525, - "name": "getClaims", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 4 - } - ], - "signatures": [ - { - "id": 1526, - "name": "getClaims", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" - }, - { - "kind": "code", - "text": "`/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": ") to verify the JWT." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\n- A network request is sent to your project's JWT signing key discovery endpoint " - }, - { - "kind": "code", - "text": "`https://project-id.supabase.co/auth/v1/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": ", which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook)." - } - ] - }, - { - "tag": "@example", - "name": "Get JWT claims, header and signature", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getClaims()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get JWT claims, header and signature\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"claims\": {\n \"aal\": \"aal1\",\n \"amr\": [{\n \"method\": \"email\",\n \"timestamp\": 1715766000\n }],\n \"app_metadata\": {},\n \"aud\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"exp\": 1715769600,\n \"iat\": 1715766000,\n \"is_anonymous\": false,\n \"iss\": \"https://project-id.supabase.co/auth/v1\",\n \"phone\": \"+13334445555\",\n \"role\": \"authenticated\",\n \"session_id\": \"11111111-1111-1111-1111-111111111111\",\n \"sub\": \"11111111-1111-1111-1111-111111111111\",\n \"user_metadata\": {}\n },\n \"header\": {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"signature\": [/** Uint8Array */],\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 4 - } - ], - "parameters": [ - { - "id": 1527, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getSession" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1528, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Various additional options that allow you to customize the\n behavior of this method." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1529, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1531, - "name": "allowExpired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " the " - }, - { - "kind": "code", - "text": "`exp`" - }, - { - "kind": "text", - "text": " claim will not be validated against the current time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2468, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1532, - "name": "jwks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2470, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1533, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1534, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2471, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1534] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2470, - "character": 15 - } - ] - } - } - }, - { - "id": 1530, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Please use options.jwks instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2466, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1531, 1532, 1530] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 38 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1535, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1536, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2474, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1537, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1538, - "name": "claims", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2475, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 2146, - "name": "JwtPayload", - "package": "@supabase/auth-js" - } - }, - { - "id": 1539, - "name": "header", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2476, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 2130, - "name": "JwtHeader", - "package": "@supabase/auth-js" - } - }, - { - "id": 1540, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2477, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1538, 1539, 1540] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2474, - "character": 14 - } - ] - } - } - }, - { - "id": 1541, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2479, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1536, 1541] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2473, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1542, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1543, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2481, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1544, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2482, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1543, 1544] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2480, - "character": 8 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1545, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1546, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2484, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1547, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2485, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1546, 1547] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2483, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1357, - "name": "getSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 4 - } - ], - "signatures": [ - { - "id": 1358, - "name": "getSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser()" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " instead.\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\n- The session contains an access token (signed JWT), a refresh token and the user object.\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\n- When using in a browser, or you've called " - }, - { - "kind": "code", - "text": "`startAutoRefresh()`" - }, - { - "kind": "text", - "text": " in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or your own JWT verification library to securely establish the user's identity and access. You can also use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch the user object directly from the Auth server for this purpose.\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed." - } - ] - }, - { - "tag": "@example", - "name": "Get the session data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getSession()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the session data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1359, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1360, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1417, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1361, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1362, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1418, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1362] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1417, - "character": 14 - } - ] - } - } - }, - { - "id": 1363, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1420, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1360, 1363] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 26 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1364, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1365, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1422, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1367, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1423, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1367] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1422, - "character": 14 - } - ] - } - } - }, - { - "id": 1368, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1425, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1365, 1368] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1421, - "character": 8 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1369, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1370, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1427, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1371, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1372, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1428, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1372] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1427, - "character": 14 - } - ] - } - } - }, - { - "id": 1373, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1430, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1370, 1373] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1426, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1377, - "name": "getUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1528, - "character": 4 - } - ], - "signatures": [ - { - "id": 1378, - "name": "getUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method fetches the user object from the database instead of local session.\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\n- Should always be used when checking for user authorization on the server. On the client, you can instead use " - }, - { - "kind": "code", - "text": "`getSession().session.user`" - }, - { - "kind": "text", - "text": " for faster results. " - }, - { - "kind": "code", - "text": "`getSession`" - }, - { - "kind": "text", - "text": " is insecure on the server." - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with the current existing session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the logged in user with the current existing session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with a custom access token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1528, - "character": 4 - } - ], - "parameters": [ - { - "id": 1379, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1464, - "name": "getUserIdentities", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 4 - } - ], - "signatures": [ - { - "id": 1465, - "name": "getUserIdentities", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets all the identities linked to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`getUserIdentities()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Returns a list of identities linked to the user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getUserIdentities()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Returns a list of identities linked to the user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"2024-01-01T00:00:00Z\",\n \"user_id\": \"2024-01-01T00:00:00Z\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ]\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1466, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1467, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2126, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1469, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2127, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1469] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2126, - "character": 14 - } - ] - } - } - }, - { - "id": 1470, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2129, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1467, 1470] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 33 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1471, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1472, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2131, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1473, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2132, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1472, 1473] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2130, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1303, - "name": "initialize", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 154, - "character": 4 - } - ], - "signatures": [ - { - "id": 1304, - "name": "initialize", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 154, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2106, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1298, - "name": "isThrowOnErrorEnabled", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 138, - "character": 4 - } - ], - "signatures": [ - { - "id": 1299, - "name": "isThrowOnErrorEnabled", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns whether error throwing mode is enabled for this client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 138, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 1474, - "name": "linkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2138, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2142, - "character": 4 - } - ], - "signatures": [ - { - "id": 1475, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2138, - "character": 4 - } - ], - "parameters": [ - { - "id": 1476, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1812, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1685, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1477, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an OIDC identity to an existing user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2142, - "character": 4 - } - ], - "parameters": [ - { - "id": 1478, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1824, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1428, - "name": "onAuthStateChange", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 4 - } - ], - "signatures": [ - { - "id": 1429, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens.\nSafe to use without an async function as callback." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 4 - } - ], - "parameters": [ - { - "id": 1430, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1431, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 32 - } - ], - "signatures": [ - { - "id": 1432, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 32 - } - ], - "parameters": [ - { - "id": 1433, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1434, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1435, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1436, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1983, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1437, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1438, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1984, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1438] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1983, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1436] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 92 - } - ] - } - } - }, - { - "id": 1439, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens. Common reentry\npatterns (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", reading the session from inside a\nhandler) complete normally. One hazard remains: calling " - }, - { - "kind": "code", - "text": "`refreshSession`" - }, - { - "kind": "text", - "text": "\n(or anything that routes through " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": ") from inside a\n" - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " handler. " - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " resolves only after\n" - }, - { - "kind": "code", - "text": "`_notifyAllSubscribers`" - }, - { - "kind": "text", - "text": " returns, so the inner refresh dedupes onto the\nouter's unresolved promise and the two wait on each other." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Async callbacks can deadlock when they trigger a nested\nrefresh from a " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event. Prefer the sync overload, or move\nrefresh-triggering work outside the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 4 - } - ], - "parameters": [ - { - "id": 1440, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1441, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 32 - } - ], - "signatures": [ - { - "id": 1442, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 32 - } - ], - "parameters": [ - { - "id": 1443, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1444, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1446, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2003, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1448, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2004, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1448] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2003, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1446] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 101 - } - ] - } - } - } - ] - }, - { - "id": 1351, - "name": "reauthenticate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1269, - "character": 4 - } - ], - "signatures": [ - { - "id": 1352, - "name": "reauthenticate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used together with " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " when a user's password needs to be updated.\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\n- After receiving the OTP, include it as the " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " in your " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " call to finalize the password change." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Send reauthentication nonce\nSends a reauthentication nonce to the user's email or phone number." - } - ] - }, - { - "tag": "@example", - "name": "Send reauthentication nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.reauthenticate()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1269, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1405, - "name": "refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 4 - } - ], - "signatures": [ - { - "id": 1406, - "name": "refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method will refresh and return a new session whether the current one is expired or not." - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using the current session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession()\nconst { session, user } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Refresh session using the current session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using a refresh token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\nconst { session, user } = data\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 4 - } - ], - "parameters": [ - { - "id": 1407, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session. If passed in, it must contain a refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1408, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1409, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1908, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1409] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 36 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1551, - "name": "registerPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2508, - "character": 4 - } - ], - "signatures": [ - { - "id": 1552, - "name": "registerPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Register a passkey for the current authenticated user. Handles the full WebAuthn ceremony:\n1. Fetches registration challenge from server\n2. Prompts user via navigator.credentials.create()\n3. Verifies credential with server\n\nRequires an active session. Requires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2508, - "character": 4 - } - ], - "parameters": [ - { - "id": 1553, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2450, - "name": "RegisterPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1354, - "name": "resend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1330, - "character": 4 - } - ], - "signatures": [ - { - "id": 1355, - "name": "resend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Resends a signup confirmation, email change or phone change email to the user.\n- Passwordless sign-ins can be resent by calling the " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " method again.\n- Password recovery emails can be resent by calling the " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " method again.\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " again to resend the OTP).\n- You can specify a redirect url when you resend an email link using the " - }, - { - "kind": "code", - "text": "`emailRedirectTo`" - }, - { - "kind": "text", - "text": " option." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend an email signup confirmation\nResends the email signup confirmation to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend an email signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'signup',\n email: 'email@example.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend a phone signup confirmation\nResends the phone signup confirmation email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend a phone signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'sms',\n phone: '1234567890'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend email change email\nResends the email change email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend email change email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'email_change',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend phone change OTP\nResends the phone change OTP to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend phone change OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'phone_change',\n phone: '1234567890'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1330, - "character": 4 - } - ], - "parameters": [ - { - "id": 1356, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1910, - "name": "ResendParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1671, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1450, - "name": "resetPasswordForEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 4 - } - ], - "signatures": [ - { - "id": 1451, - "name": "resetPasswordForEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a password reset request to an email address. This method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\n- The " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " only sends a password reset link to the user's email.\nTo update the user's password, see [" - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-updateuser).\n- A " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": " event will be emitted when the password recovery link is clicked.\nYou can use [" - }, - { - "kind": "code", - "text": "`onAuthStateChange()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\n- When the user clicks the reset link in the email they are redirected back to your application.\nYou can configure the URL that the user is redirected to with the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter.\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- After the user has been redirected successfully, prompt them for a new password and call " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": ":\n" - }, - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: new_password\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\n redirectTo: 'https://example.com/update-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Reset password\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {}\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password (React)", - "content": [ - { - "kind": "code", - "text": "```js\n/**\n * Step 1: Send the user an email to get a password reset token.\n * This email contains a link which sends the user back to your application.\n */\nconst { data, error } = await supabase.auth\n .resetPasswordForEmail('user@email.com')\n\n/**\n * Step 2: Once the user is redirected back to your application,\n * ask the user to reset their password.\n */\n useEffect(() => {\n supabase.auth.onAuthStateChange(async (event, session) => {\n if (event == \"PASSWORD_RECOVERY\") {\n const newPassword = prompt(\"What would you like your new password to be?\");\n const { data, error } = await supabase.auth\n .updateUser({ password: newPassword })\n\n if (data) alert(\"Password updated successfully!\")\n if (error) alert(\"There was an error updating your password.\")\n }\n })\n }, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 4 - } - ], - "parameters": [ - { - "id": 1452, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1453, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1456, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2077, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1455, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to send the user to after they click the password reset link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2076, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1456, 1455] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 51 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1457, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1458, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2079, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1459, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 1460, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2080, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1458, 1460] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2078, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1461, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1462, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2082, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1463, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2083, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1462, 1463] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2081, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1393, - "name": "setSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 4 - } - ], - "signatures": [ - { - "id": 1394, - "name": "setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method sets the session using an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`refresh_token`" - }, - { - "kind": "text", - "text": ".\n- If successful, a " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event is emitted." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Set the session\nSets the session data from an access_token and refresh_token, then returns an auth response or error." - } - ] - }, - { - "tag": "@example", - "name": "Set the session", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.setSession({\n access_token,\n refresh_token\n })\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set the session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"11111111-1111-1111-1111-111111111111\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"2024-01-01T00:00:00Z\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"token_type\": \"bearer\",\n \"expires_in\": 3500,\n \"expires_at\": 1700000000\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 4 - } - ], - "parameters": [ - { - "id": 1395, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session that minimally contains an access token and refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1396, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1397, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1775, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1398, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1776, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1397, 1398] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 31 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1306, - "name": "signInAnonymously", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 235, - "character": 4 - } - ], - "signatures": [ - { - "id": 1307, - "name": "signInAnonymously", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new anonymous user." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A session where the is_anonymous claim in the access token JWT set to true" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Returns an anonymous user\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the " - }, - { - "kind": "code", - "text": "`options`" - }, - { - "kind": "text", - "text": " param." - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n captchaToken\n }\n});\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create an anonymous user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user with custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n data\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 235, - "character": 4 - } - ], - "parameters": [ - { - "id": 1308, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1774, - "name": "SignInAnonymouslyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1339, - "name": "signInWithIdToken", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 977, - "character": 4 - } - ], - "signatures": [ - { - "id": 1340, - "name": "signInWithIdToken", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use an ID token to sign in.\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API." - } - ] - }, - { - "tag": "@example", - "name": "Sign In using ID Token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithIdToken({\n provider: 'google',\n token: 'your-id-token'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign In using ID Token\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 977, - "character": 4 - } - ], - "parameters": [ - { - "id": 1341, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1824, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1315, - "name": "signInWithOAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 626, - "character": 4 - } - ], - "signatures": [ - { - "id": 1316, - "name": "signInWithOAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider with redirect\n- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter. This parameter defaults to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider with redirect", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n redirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with scopes and access provider tokens\nIf you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the " - }, - { - "kind": "code", - "text": "`scopes`" - }, - { - "kind": "text", - "text": " option takes in **a space-separated list** of scopes.\n\nBecause OAuth sign-in often includes redirects, you should register an " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback immediately after you create the Supabase client. This callback will listen for the presence of " - }, - { - "kind": "code", - "text": "`provider_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`provider_refresh_token`" - }, - { - "kind": "text", - "text": " properties on the " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with scopes and access provider tokens", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n\n// Call this on your Sign in with GitHub button to initiate OAuth\n// with GitHub with the requested elevated scopes.\nawait supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n scopes: 'repo gist notifications'\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 626, - "character": 4 - } - ], - "parameters": [ - { - "id": 1317, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1812, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1685, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1342, - "name": "signInWithOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1055, - "character": 4 - } - ], - "signatures": [ - { - "id": 1343, - "name": "signInWithOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " 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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email or phone number.\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\n- If the user doesn't exist, " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " will signup the user instead. To restrict this behavior, you can set " - }, - { - "kind": "code", - "text": "`shouldCreateUser`" - }, - { - "kind": "text", - "text": " in " - }, - { - "kind": "code", - "text": "`SignInWithPasswordlessCredentials.options`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ".\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\n- If you're using phone, you can configure whether you want the user to receive a OTP.\n- The magic link's destination URL is determined by the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": ".\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with email\nThe user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n email: 'example@email.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": null,\n \"session\": null\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with SMS OTP\nThe user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with SMS OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with WhatsApp OTP\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with WhatsApp OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n options: {\n channel:'whatsapp',\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1055, - "character": 4 - } - ], - "parameters": [ - { - "id": 1344, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1793, - "name": "SignInWithPasswordlessCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1671, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1548, - "name": "signInWithPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2497, - "character": 4 - } - ], - "signatures": [ - { - "id": 1549, - "name": "signInWithPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with a passkey. Handles the full WebAuthn ceremony:\n1. Fetches authentication challenge from server\n2. Prompts user via navigator.credentials.get()\n3. Verifies credential with server and creates session\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2497, - "character": 4 - } - ], - "parameters": [ - { - "id": 1550, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2444, - "name": "SignInWithPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1312, - "name": "signInWithPassword", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 546, - "character": 4 - } - ], - "signatures": [ - { - "id": 1313, - "name": "signInWithPassword", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user with an email and password or phone and password.\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\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email and password or a phone number and password." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email and password\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with phone and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n phone: '+13334445555',\n password: 'some-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nLog the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so fields like " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " aren't hidden. The " - }, - { - "kind": "code", - "text": "`error.code`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`'invalid_credentials'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'email_not_confirmed'`" - }, - { - "kind": "text", - "text": ") is often more useful for branching than " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": ", and the full object surfaces both." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\nif (error) {\n console.error(error)\n return\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 546, - "character": 4 - } - ], - "parameters": [ - { - "id": 1314, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1788, - "name": "SignInWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1680, - "name": "AuthTokenResponsePassword", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1348, - "name": "signInWithSSO", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1247, - "character": 4 - } - ], - "signatures": [ - { - "id": 1349, - "name": "signInWithSSO", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\n- If you've associated an email domain to the identity provider, you can use the " - }, - { - "kind": "code", - "text": "`domain`" - }, - { - "kind": "text", - "text": " property to start a sign-in flow.\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the " - }, - { - "kind": "code", - "text": "`providerId`" - }, - { - "kind": "text", - "text": " property. For example:\n - Mapping specific user email addresses with an identity provider.\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email domain", - "content": [ - { - "kind": "code", - "text": "```js\n // You can extract the user's email domain and use it to trigger the\n // authentication flow with the correct identity provider.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n domain: 'company.com'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with provider UUID", - "content": [ - { - "kind": "code", - "text": "```js\n // Useful when you need to map a user's sign in request according\n // to different rules that can't use email domains.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1247, - "character": 4 - } - ], - "parameters": [ - { - "id": 1350, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1924, - "name": "SignInWithSSO", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1698, - "name": "SSOResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1321, - "name": "signInWithWeb3", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 4 - } - ], - "signatures": [ - { - "id": 1322, - "name": "signInWithWeb3", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." - } - ], - "blockTags": [ - { - "tag": "@reference", - "content": [ - { - "kind": "text", - "text": "https://eips.ethereum.org/EIPS/eip-4361" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana or Ethereum (Window API)", - "content": [ - { - "kind": "code", - "text": "```js\n // uses window.ethereum for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n\n // uses window.solana for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Ethereum (Message and Signature)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n message: '',\n signature: '',\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Brave)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet: window.braveSolana\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Wallet Adapter)", - "content": [ - { - "kind": "code", - "text": "```jsx\n function SignInButton() {\n const wallet = useWallet()\n\n return (\n <>\n {wallet.connected ? (\n {\n supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet,\n })\n }}\n >\n Sign in with Solana\n \n ) : (\n \n )}\n \n )\n}\n\nfunction App() {\n const endpoint = clusterApiUrl('devnet')\n const wallets = useMemo(() => [], [])\n\n return (\n \n \n \n \n \n \n \n )\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 4 - } - ], - "parameters": [ - { - "id": 1323, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1885, - "name": "Web3Credentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1324, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1325, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 887, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1326, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1327, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 888, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1328, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 889, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1327, 1328] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 887, - "character": 14 - } - ] - } - } - }, - { - "id": 1329, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 891, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1325, 1329] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 58 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1330, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1331, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 893, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1332, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1333, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 894, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1334, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 895, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1333, 1334] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 893, - "character": 14 - } - ] - } - } - }, - { - "id": 1335, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 897, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1331, 1335] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 892, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1418, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 4 - } - ], - "signatures": [ - { - "id": 1419, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inside a browser context, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " - }, - { - "kind": "code", - "text": "`\"SIGNED_OUT\"`" - }, - { - "kind": "text", - "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " - }, - { - "kind": "code", - "text": "`auth.api.signOut(JWT: string)`" - }, - { - "kind": "text", - "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " - }, - { - "kind": "code", - "text": "`others`" - }, - { - "kind": "text", - "text": " scope, no " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event is fired!\n\n**Warning:** the default " - }, - { - "kind": "code", - "text": "`scope`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`'global'`" - }, - { - "kind": "text", - "text": ". This signs the user out of\n**every device they are currently signed in on**, not just the current\ntab/session. If you only want to sign the user out of the current session\n(the behavior most other auth libraries default to), pass\n" - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " explicitly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " uses the **global** scope, which signs out the user\n on every device they are signed in on (not just the current one). Pass\n " - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " to only sign out the current session. This is\n usually what apps want on a \"Sign out\" button, especially when users\n sign in from multiple devices and do not expect signing out of one to\n terminate the others.\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires." - } - ] - }, - { - "tag": "@example", - "name": "Sign out of every device (global – default)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out only the current session (recommended for most apps)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out of all other sessions, keep the current one", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 4 - } - ], - "parameters": [ - { - "id": 1420, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2121, - "name": "SignOut", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1421, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1422, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1971, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1422] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 40 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1309, - "name": "signUp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 413, - "character": 4 - } - ], - "signatures": [ - { - "id": 1310, - "name": "signUp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A logged-in session if the server has \"autoconfirm\" ON" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A user if the server has \"autoconfirm\" OFF" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\n- **Confirm email** determines if users need to confirm their email address after signing up.\n - If **Confirm email** is enabled, a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " is returned but " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " is null.\n - If **Confirm email** is disabled, both a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " and a " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " are returned.\n- When the user confirms their email address, they are redirected to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your " - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": " or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\n- If signUp() is called for an existing confirmed user:\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, " - }, - { - "kind": "code", - "text": "`User already registered`" - }, - { - "kind": "text", - "text": " is returned.\n- To fetch the currently logged-in user, refer to [" - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-getuser)." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with an email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign up with an email and password\n" - }, - { - "kind": "code", - "text": "```json\n// Some fields may be null if \"confirm email\" is enabled.\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (SMS)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'sms'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a phone number and password (whatsapp)\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (whatsapp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'whatsapp'\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with additional user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n data: {\n first_name: 'John',\n age: 27,\n }\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a redirect URL\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a redirect URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 413, - "character": 4 - } - ], - "parameters": [ - { - "id": 1311, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1780, - "name": "SignUpWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1502, - "name": "startAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2258, - "character": 4 - } - ], - "signatures": [ - { - "id": 1503, - "name": "startAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClientOptions#autoRefreshToken", - "target": 1615 - }, - { - "kind": "text", - "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "#stopAutoRefresh" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- To give this hint to the application, you should be calling this method when the app is in focus and calling " - }, - { - "kind": "code", - "text": "`supabase.auth.stopAutoRefresh()`" - }, - { - "kind": "text", - "text": " when it's out of focus." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2258, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1504, - "name": "stopAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2289, - "character": 4 - } - ], - "signatures": [ - { - "id": 1505, - "name": "stopAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#startAutoRefresh" - }, - { - "kind": "text", - "text": " for more details." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2289, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1481, - "name": "unlinkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 4 - } - ], - "signatures": [ - { - "id": 1482, - "name": "unlinkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`unlinkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- The user must have at least 2 identities in order to unlink an identity.\n- The identity to be unlinked must belong to the user." - } - ] - }, - { - "tag": "@example", - "name": "Unlink an identity", - "content": [ - { - "kind": "code", - "text": "```js\n// retrieve all identities linked to a user\nconst identities = await supabase.auth.getUserIdentities()\n\n// find the google identity\nconst googleIdentity = identities.find(\n identity => identity.provider === 'google'\n)\n\n// unlink the google identity\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 4 - } - ], - "parameters": [ - { - "id": 1483, - "name": "identity", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1484, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1485, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2171, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1486, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 1487, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2172, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1485, 1487] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 52 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1488, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1489, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2174, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1490, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2175, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1489, 1490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2173, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1381, - "name": "updateUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 4 - } - ], - "signatures": [ - { - "id": 1382, - "name": "updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates user data for a logged in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, email updates sends a confirmation link to both the user's current and new email.\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers)." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\nSends a \"Confirm Email Change\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email)." - } - ] - }, - { - "tag": "@example", - "name": "Update the email for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n email: 'new@email.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"new_email\": \"new@email.com\",\n \"email_change_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the phone number for an authenticated user\nSends a one-time password (OTP) to the new phone number." - } - ] - }, - { - "tag": "@example", - "name": "Update the phone number for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n phone: '123456789'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update the password for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's metadata\nUpdates the user's custom metadata.\n\n**Note**: The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column in your Supabase database. When calling " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": ", the data will be available as " - }, - { - "kind": "code", - "text": "`user.user_metadata`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n data: { hello: 'world' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's password with a nonce\nIf **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's password with a nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password',\n nonce: '123456'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 4 - } - ], - "parameters": [ - { - "id": 1383, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 1384, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1386, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1645, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1386] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 53 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1345, - "name": "verifyOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1193, - "character": 4 - } - ], - "signatures": [ - { - "id": 1346, - "name": "verifyOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " method takes in different verification types.\n- If a phone number is used, the type can either be:\n 1. " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new phone number during a phone number update process.\n- If an email address is used, the type can be one of the following (note: " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": " types are deprecated):\n 1. " - }, - { - "kind": "code", - "text": "`email`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent for account recovery, typically after a password reset request.\n 3. " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent as part of an invitation to join a project or organization.\n 4. " - }, - { - "kind": "code", - "text": "`email_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new email address during an email update process.\n- The verification type used should be determined based on the corresponding auth method called before " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " to sign up / sign-in a user.\n- The " - }, - { - "kind": "code", - "text": "`TokenHash`" - }, - { - "kind": "text", - "text": " is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details." - } - ] - }, - { - "tag": "@example", - "name": "Verify Signup One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify Signup One-Time Password (OTP)\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify SMS One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify Email Auth (Token Hash)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1193, - "character": 4 - } - ], - "parameters": [ - { - "id": 1347, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1886, - "name": "VerifyOtpParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1223] - }, - { - "title": "Properties", - "children": [ - 1260, 1227, 1254, 1255, 1245, 1291, 1262, 1290, 1277, 1232, 1275, 1271, 1261, - 1285, 1286, 1289, 1292, 1293, 1249, 1228, 1229, 1230, 1287, 1246, 1259, 1253, - 1247, 1231, 1276, 1288, 1270, 1248, 1256 - ] - }, - { - "title": "Accessors", - "children": [1233, 1241] - }, - { - "title": "Methods", - "children": [ - 1410, 1399, 1423, 1387, 1506, 1318, 1525, 1357, 1377, 1464, 1303, 1298, 1474, - 1428, 1351, 1405, 1551, 1354, 1450, 1393, 1306, 1339, 1315, 1342, 1548, 1312, - 1348, 1321, 1418, 1309, 1502, 1504, 1481, 1381, 1345 - ] - } - ], - "categories": [ - { - "title": "Auth", - "children": [ - 1506, 1318, 1525, 1357, 1377, 1464, 1303, 1351, 1405, 1551, 1354, 1450, 1393, - 1306, 1339, 1315, 1342, 1548, 1312, 1348, 1321, 1418, 1309, 1502, 1504, 1481, - 1381, 1345 - ] - }, - { - "title": "Other", - "children": [ - 1223, 1260, 1227, 1254, 1255, 1245, 1291, 1262, 1290, 1277, 1232, 1275, 1271, - 1261, 1285, 1286, 1289, 1292, 1293, 1249, 1228, 1229, 1230, 1287, 1246, 1259, - 1253, 1247, 1231, 1276, 1288, 1270, 1248, 1256, 1233, 1241, 1410, 1399, 1423, - 1387, 1298, 1474, 1428 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 6, - "character": 21 - } - ] - }, - { - "id": 1571, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client doesn't call " - }, - { - "kind": "code", - "text": "`navigator.locks`" - }, - { - "kind": "text", - "text": ", so this error\nnever originates from " - }, - { - "kind": "code", - "text": "`supabase.auth.*`" - }, - { - "kind": "text", - "text": " calls. Direct callers of\n" - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " still receive it on acquire timeout." - } - ] - } - ] - }, - "children": [ - { - "id": 1572, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 29, - "character": 4 - } - ], - "signatures": [ - { - "id": 1573, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 29, - "character": 4 - } - ], - "parameters": [ - { - "id": 1574, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1571, - "name": "NavigatorLockAcquireTimeoutError", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - }, - { - "id": 1575, - "name": "isAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 28, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": true - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.isAcquireTimeout" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1572] - }, - { - "title": "Properties", - "children": [1575] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 36, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError" - }, - "name": "LockAcquireTimeoutError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 57, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 58, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 59, - "name": "PostgrestBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 60, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 61, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 62, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "parameters": [ - { - "id": 63, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 69, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 72, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 74, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 75, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 76, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 77, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 78, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 79, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 67, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 80, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 65, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 83, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 68, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 81, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 70, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 71, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 66, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 82, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [69, 72, 67, 80, 65, 83, 68, 81, 70, 71, 66, 82] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 88, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 91, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 92, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 93, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 94, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 95, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 96, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 97, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 98, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 86, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 99, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 84, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 102, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 87, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 100, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 89, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 90, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 85, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 101, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 130, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 131, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 132, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 133, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 135, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [135] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 137, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [137] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 111, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 112, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 113, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 127, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 824, - "character": 2 - } - ], - "signatures": [ - { - "id": 128, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 824, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 129, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 129, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 107, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 108, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 109, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 110, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 105, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 114, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 115, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 116, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 117, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 118, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 119, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 120, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 121, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 122, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 124, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 125, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - }, - { - "id": 103, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 104, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [58] - }, - { - "title": "Properties", - "children": [88, 91, 86, 99, 84, 102, 87, 100, 89, 90, 85, 101] - }, - { - "title": "Methods", - "children": [130, 111, 127, 107, 105, 114, 103] - } - ], - "categories": [ - { - "title": "Database", - "children": [58, 130, 127, 107, 105, 103] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [111] - }, - { - "title": "Other", - "children": [88, 91, 86, 99, 84, 102, 87, 100, 89, 90, 85, 101, 114] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 674, - "character": 23 - } - ], - "typeParameters": [ - { - "id": 138, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 139, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 140, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 559, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - }, - { - "id": 830, - "name": "PostgrestError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error format\n\nReturned by every PostgREST request that fails. When something fails, the\nsingle most useful field is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — Postgres often returns the\nactionable fix there, not in " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": ". Always log the full object (e.g.\n" - }, - { - "kind": "code", - "text": "`console.error(error)`" - }, - { - "kind": "text", - "text": "); logging only " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": " hides the hint.\n\nRead the fields in roughly this order of usefulness:\n\n- " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — actionable guidance from the database when available. For\n permission-denied errors (" - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "), this is the literal SQL to fix the\n problem, e.g.\n " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.users TO anon;\"`" - }, - { - "kind": "text", - "text": ".\n Missing column? " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " suggests the column you probably meant. Whenever\n Postgres knows the fix, it puts it in " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": " — stable error code from PostgREST (e.g. " - }, - { - "kind": "code", - "text": "`PGRST301`" - }, - { - "kind": "text", - "text": ") or Postgres\n (e.g. " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "). Branch on this rather than on " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " text.\n- " - }, - { - "kind": "code", - "text": "`details`" - }, - { - "kind": "text", - "text": " — extra context, often the offending value, key, or row.\n- " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " — human-readable summary. Useful in UI strings; less useful\n for debugging.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", - "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" - } - ] - }, - "children": [ - { - "id": 831, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 832, - "name": "PostgrestError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport PostgrestError from '@supabase/postgrest-js'\n\nthrow new PostgrestError({\n message: 'Row level security prevented the request',\n details: 'RLS denied the insert',\n hint: 'Check your policies',\n code: 'PGRST301',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 2 - } - ], - "parameters": [ - { - "id": 833, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 834, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 838, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 836, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 837, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 46, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 835, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [838, 836, 837, 835] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 830, - "name": "PostgrestError", - "package": "@supabase/postgrest-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 841, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 839, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 27, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 840, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 28, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 842, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 2 - } - ], - "signatures": [ - { - "id": 843, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 844, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 849, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 54, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 847, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 848, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 846, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 51, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 845, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 50, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [849, 847, 848, 846, 845] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 12 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [831] - }, - { - "title": "Properties", - "children": [841, 839, 840] - }, - { - "title": "Methods", - "children": [842] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 26, - "character": 14 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 141, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 142, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 143, - "name": "PostgrestFilterBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 144, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 145, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 146, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 147, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 148, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 149, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 150, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 151, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 157, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 160, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 162, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 163, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 164, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 165, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 166, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 167, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 155, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 168, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 153, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 171, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 156, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 169, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 158, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 159, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 154, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 170, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 157, 160, 155, 168, 153, 171, 156, 169, 158, 159, 154, 170 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 561, - "name": "PostgrestTransformBuilder.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 560, - "name": "PostgrestTransformBuilder.constructor" - } - }, - { - "id": 506, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 676, - "name": "PostgrestTransformBuilder.body" - } - }, - { - "id": 509, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 511, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 512, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 513, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 514, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 515, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 516, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 679, - "name": "PostgrestTransformBuilder.fetch" - } - }, - { - "id": 504, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 674, - "name": "PostgrestTransformBuilder.headers" - } - }, - { - "id": 517, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 687, - "name": "PostgrestTransformBuilder.isMaybeSingle" - } - }, - { - "id": 502, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 672, - "name": "PostgrestTransformBuilder.method" - } - }, - { - "id": 520, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 690, - "name": "PostgrestTransformBuilder.retryEnabled" - } - }, - { - "id": 505, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 675, - "name": "PostgrestTransformBuilder.schema" - } - }, - { - "id": 518, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 688, - "name": "PostgrestTransformBuilder.shouldStripNulls" - } - }, - { - "id": 507, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 677, - "name": "PostgrestTransformBuilder.shouldThrowOnError" - } - }, - { - "id": 508, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 678, - "name": "PostgrestTransformBuilder.signal" - } - }, - { - "id": 503, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 673, - "name": "PostgrestTransformBuilder.url" - } - }, - { - "id": 519, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 689, - "name": "PostgrestTransformBuilder.urlLengthLimit" - } - }, - { - "id": 471, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "signatures": [ - { - "id": 472, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "parameters": [ - { - "id": 473, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 642, - "name": "PostgrestTransformBuilder.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 641, - "name": "PostgrestTransformBuilder.abortSignal" - } - }, - { - "id": 310, - "name": "containedBy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1879, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1880, - "character": 2 - } - ], - "signatures": [ - { - "id": 311, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1879, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 312, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 313, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 312, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 314, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 312, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 315, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1880, - "character": 2 - } - ], - "parameters": [ - { - "id": 316, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 317, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 302, - "name": "contains", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1877, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1878, - "character": 2 - } - ], - "signatures": [ - { - "id": 303, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1877, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 304, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 305, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 304, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 306, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 304, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 307, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1878, - "character": 2 - } - ], - "parameters": [ - { - "id": 308, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 309, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 480, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "signatures": [ - { - "id": 481, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 651, - "name": "PostgrestTransformBuilder.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 650, - "name": "PostgrestTransformBuilder.csv" - } - }, - { - "id": 172, - "name": "eq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1731, - "character": 2 - } - ], - "signatures": [ - { - "id": 173, - "name": "eq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nTo check if the value of " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL, you should use " - }, - { - "kind": "code", - "text": "`.is()`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1731, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 174, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 175, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 174, - "typeArguments": [ - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 174, - "typeArguments": [ - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 176, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 484, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "signatures": [ - { - "id": 485, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "parameters": [ - { - "id": 486, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 487, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 488, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1608, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 491, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1611, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 493, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1613, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 490, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1610, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 489, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1609, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 492, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1612, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [488, 491, 493, 490, 489, 492] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1607, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 655, - "name": "PostgrestTransformBuilder.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 654, - "name": "PostgrestTransformBuilder.explain" - } - }, - { - "id": 410, - "name": "filter", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2064, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2065, - "character": 2 - } - ], - "signatures": [ - { - "id": 411, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2064, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 412, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 413, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 412, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 414, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - }, - { - "type": "literal", - "value": "not.match" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.isdistinct" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - }, - { - "type": "literal", - "value": "not.imatch" - } - ] - } - }, - { - "id": 415, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 416, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2065, - "character": 2 - } - ], - "parameters": [ - { - "id": 417, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 418, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 419, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 482, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "signatures": [ - { - "id": 483, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 653, - "name": "PostgrestTransformBuilder.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 652, - "name": "PostgrestTransformBuilder.geojson" - } - }, - { - "id": 183, - "name": "gt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1784, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1785, - "character": 2 - } - ], - "signatures": [ - { - "id": 184, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1784, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 185, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 186, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 185, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 187, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 185, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 188, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1785, - "character": 2 - } - ], - "parameters": [ - { - "id": 189, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 190, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 191, - "name": "gte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1786, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1787, - "character": 2 - } - ], - "signatures": [ - { - "id": 192, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1786, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 193, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 194, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 193, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 195, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 193, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 196, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1787, - "character": 2 - } - ], - "parameters": [ - { - "id": 197, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 198, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 239, - "name": "ilike", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1798, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1799, - "character": 2 - } - ], - "signatures": [ - { - "id": 240, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1798, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 241, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 242, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 241, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 243, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 244, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1799, - "character": 2 - } - ], - "parameters": [ - { - "id": 245, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 246, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 247, - "name": "ilikeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1800, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1801, - "character": 2 - } - ], - "signatures": [ - { - "id": 248, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1800, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 249, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 250, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 249, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 251, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 252, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1801, - "character": 2 - } - ], - "parameters": [ - { - "id": 253, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 254, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 255, - "name": "ilikeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1802, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1803, - "character": 2 - } - ], - "signatures": [ - { - "id": 256, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1802, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 257, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 258, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 257, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 259, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 260, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1803, - "character": 2 - } - ], - "parameters": [ - { - "id": 261, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 262, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 292, - "name": "in", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1869, - "character": 2 - } - ], - "signatures": [ - { - "id": 293, - "name": "in", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .in('name', ['Leia', 'Han'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1869, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 294, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 295, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 296, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 279, - "name": "is", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1808, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1809, - "character": 2 - } - ], - "signatures": [ - { - "id": 280, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1808, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 281, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 282, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 281, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 283, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 281, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 284, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1809, - "character": 2 - } - ], - "parameters": [ - { - "id": 285, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 286, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 287, - "name": "isDistinct", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1820, - "character": 2 - } - ], - "signatures": [ - { - "id": 288, - "name": "isDistinct", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS DISTINCT FROM " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nUnlike " - }, - { - "kind": "code", - "text": "`.neq()`" - }, - { - "kind": "text", - "text": ", this treats " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " as a comparable value. Two " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " values\nare considered equal (not distinct), and comparing " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " with any non-NULL\nvalue returns true (distinct)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1820, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 289, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 290, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 291, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 215, - "name": "like", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1792, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1793, - "character": 2 - } - ], - "signatures": [ - { - "id": 216, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1792, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 217, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 218, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 217, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 219, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 220, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1793, - "character": 2 - } - ], - "parameters": [ - { - "id": 221, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 222, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 223, - "name": "likeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1794, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1795, - "character": 2 - } - ], - "signatures": [ - { - "id": 224, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1794, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 225, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 226, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 227, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 228, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1795, - "character": 2 - } - ], - "parameters": [ - { - "id": 229, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 230, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 231, - "name": "likeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1796, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1797, - "character": 2 - } - ], - "signatures": [ - { - "id": 232, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1796, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 233, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 234, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 233, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 235, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 236, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1797, - "character": 2 - } - ], - "parameters": [ - { - "id": 237, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 238, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 456, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "signatures": [ - { - "id": 457, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "parameters": [ - { - "id": 458, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 459, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 461, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1243, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 462, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1244, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [461, 462] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1242, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 627, - "name": "PostgrestTransformBuilder.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 626, - "name": "PostgrestTransformBuilder.limit" - } - }, - { - "id": 199, - "name": "lt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1788, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1789, - "character": 2 - } - ], - "signatures": [ - { - "id": 200, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1788, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 201, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 202, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 201, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 203, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 201, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 204, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1789, - "character": 2 - } - ], - "parameters": [ - { - "id": 205, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 206, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 207, - "name": "lte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1790, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1791, - "character": 2 - } - ], - "signatures": [ - { - "id": 208, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1790, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 209, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 210, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 209, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 211, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 209, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 212, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1791, - "character": 2 - } - ], - "parameters": [ - { - "id": 213, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 382, - "name": "match", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1901, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1902, - "character": 2 - } - ], - "signatures": [ - { - "id": 383, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1901, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 384, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 385, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "reference", - "target": 384, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 384, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 386, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1902, - "character": 2 - } - ], - "parameters": [ - { - "id": 387, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 499, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "signatures": [ - { - "id": 500, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "parameters": [ - { - "id": 501, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 670, - "name": "PostgrestTransformBuilder.maxAffected" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 669, - "name": "PostgrestTransformBuilder.maxAffected" - } - }, - { - "id": 477, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "signatures": [ - { - "id": 478, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 479, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 479, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 648, - "name": "PostgrestTransformBuilder.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 647, - "name": "PostgrestTransformBuilder.maybeSingle" - } - }, - { - "id": 178, - "name": "neq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1783, - "character": 2 - } - ], - "signatures": [ - { - "id": 179, - "name": "neq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is not equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nThis filter does not include rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": ". To match null\nvalues, use " - }, - { - "kind": "code", - "text": "`.is(column, null)`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .neq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1783, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 180, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 181, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 180, - "typeArguments": [ - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 180, - "typeArguments": [ - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 182, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 388, - "name": "not", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1903, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1904, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1905, - "character": 2 - } - ], - "signatures": [ - { - "id": 389, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1903, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 390, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 391, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 392, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "is" - } - }, - { - "id": 393, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": null - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NonNullableColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullableColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NarrowResultColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NarrowResultColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 394, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1904, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 395, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 396, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 395, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 397, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 398, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 395, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 399, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1905, - "character": 2 - } - ], - "parameters": [ - { - "id": 400, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 401, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 402, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 297, - "name": "notIn", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1876, - "character": 2 - } - ], - "signatures": [ - { - "id": 298, - "name": "notIn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NOT included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1876, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 299, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 300, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 301, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 403, - "name": "or", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2057, - "character": 2 - } - ], - "signatures": [ - { - "id": 404, - "name": "or", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`filters`" - }, - { - "kind": "text", - "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " - }, - { - "kind": "code", - "text": "`.or()`" - }, - { - "kind": "text", - "text": " filter across multiple tables." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.or('id.in.(5,6,7), arraycol.cs.{\"a\",\"b\"}') // Use `()` for `in` filter, `{}` for array values and `cs` for `contains()`.\n.or('id.in.(5,6,7), arraycol.cd.{\"a\",\"b\"}') // Use `cd` for `containedBy()`\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.eq.2,name.eq.Han')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n },\n {\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` with `and`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` on referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2057, - "character": 2 - } - ], - "parameters": [ - { - "id": 405, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filters to use, following PostgREST syntax" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 406, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 407, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 408, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " instead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2061, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 409, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to filter on referenced tables\ninstead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2062, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [408, 409] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2060, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 425, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 427, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 428, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 427, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 429, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 430, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 431, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 432, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1115, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 433, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [431, 432, 433] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 596, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 434, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - } - ], - "parameters": [ - { - "id": 435, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 436, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 437, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 438, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1119, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 439, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 440, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1121, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [438, 439, 440] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 604, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 441, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 442, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 443, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 442, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 444, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 446, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 448, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1129, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 447, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1128, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [446, 448, 447] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 611, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 449, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "parameters": [ - { - "id": 450, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 455, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 454, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [453, 455, 454] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 619, - "name": "PostgrestTransformBuilder.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 595, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 358, - "name": "overlaps", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1891, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1892, - "character": 2 - } - ], - "signatures": [ - { - "id": 359, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1891, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 360, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 361, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 360, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 362, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 360, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 363, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1892, - "character": 2 - } - ], - "parameters": [ - { - "id": 364, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 365, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 544, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 545, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 546, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 547, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 548, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 549, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [549] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 550, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 551, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [551] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 715, - "name": "PostgrestTransformBuilder.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 714, - "name": "PostgrestTransformBuilder.overrideTypes" - } - }, - { - "id": 463, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "signatures": [ - { - "id": 464, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "parameters": [ - { - "id": 465, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 466, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 467, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 469, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 470, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [469, 470] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 634, - "name": "PostgrestTransformBuilder.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 633, - "name": "PostgrestTransformBuilder.range" - } - }, - { - "id": 350, - "name": "rangeAdjacent", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1889, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1890, - "character": 2 - } - ], - "signatures": [ - { - "id": 351, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1889, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 352, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 353, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 352, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 354, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 355, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1890, - "character": 2 - } - ], - "parameters": [ - { - "id": 356, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 357, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 318, - "name": "rangeGt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1881, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1882, - "character": 2 - } - ], - "signatures": [ - { - "id": 319, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1881, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 320, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 321, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 320, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 322, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 323, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1882, - "character": 2 - } - ], - "parameters": [ - { - "id": 324, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 325, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 326, - "name": "rangeGte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1883, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1884, - "character": 2 - } - ], - "signatures": [ - { - "id": 327, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1883, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 328, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 329, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 328, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 330, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 331, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1884, - "character": 2 - } - ], - "parameters": [ - { - "id": 332, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 333, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 334, - "name": "rangeLt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1885, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1886, - "character": 2 - } - ], - "signatures": [ - { - "id": 335, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1885, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 336, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 337, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 336, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 338, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 339, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1886, - "character": 2 - } - ], - "parameters": [ - { - "id": 340, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 341, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 342, - "name": "rangeLte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1887, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1888, - "character": 2 - } - ], - "signatures": [ - { - "id": 343, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1887, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 344, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 345, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 346, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 347, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1888, - "character": 2 - } - ], - "parameters": [ - { - "id": 348, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 349, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 271, - "name": "regexIMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1806, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1807, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1806, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 273, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 274, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 273, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 275, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 276, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1807, - "character": 2 - } - ], - "parameters": [ - { - "id": 277, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 278, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 263, - "name": "regexMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1804, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1805, - "character": 2 - } - ], - "signatures": [ - { - "id": 264, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1804, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 265, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 266, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 265, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 267, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 268, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1805, - "character": 2 - } - ], - "parameters": [ - { - "id": 269, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 270, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 529, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 530, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 531, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 700, - "name": "PostgrestTransformBuilder.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 699, - "name": "PostgrestTransformBuilder.retry" - } - }, - { - "id": 496, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "signatures": [ - { - "id": 497, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 498, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 498, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 667, - "name": "PostgrestTransformBuilder.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 666, - "name": "PostgrestTransformBuilder.returns" - } - }, - { - "id": 494, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "signatures": [ - { - "id": 495, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 665, - "name": "PostgrestTransformBuilder.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 664, - "name": "PostgrestTransformBuilder.rollback" - } - }, - { - "id": 420, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "signatures": [ - { - "id": 421, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 422, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 423, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 424, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 591, - "name": "PostgrestTransformBuilder.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 590, - "name": "PostgrestTransformBuilder.select" - } - }, - { - "id": 525, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 526, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 527, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 528, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 696, - "name": "PostgrestTransformBuilder.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 695, - "name": "PostgrestTransformBuilder.setHeader" - } - }, - { - "id": 474, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "signatures": [ - { - "id": 475, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 476, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 476, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 645, - "name": "PostgrestTransformBuilder.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 644, - "name": "PostgrestTransformBuilder.single" - } - }, - { - "id": 523, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 524, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 694, - "name": "PostgrestTransformBuilder.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 693, - "name": "PostgrestTransformBuilder.stripNulls" - } - }, - { - "id": 366, - "name": "textSearch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 2 - } - ], - "signatures": [ - { - "id": 367, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 368, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 369, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 368, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 370, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 371, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 372, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 373, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1894, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 374, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1895, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [373, 374] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 97 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 375, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 2 - } - ], - "parameters": [ - { - "id": 376, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 377, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 378, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 380, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1898, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 381, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1899, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [380, 381] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 54 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 532, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 533, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 534, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 535, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 536, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 538, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 539, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 540, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 541, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 542, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 543, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 703, - "name": "PostgrestTransformBuilder.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 702, - "name": "PostgrestTransformBuilder.then" - } - }, - { - "id": 521, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 522, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 692, - "name": "PostgrestTransformBuilder.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 691, - "name": "PostgrestTransformBuilder.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [142] - }, - { - "title": "Properties", - "children": [506, 509, 504, 517, 502, 520, 505, 518, 507, 508, 503, 519] - }, - { - "title": "Methods", - "children": [ - 471, 310, 302, 480, 172, 484, 410, 482, 183, 191, 239, 247, 255, 292, 279, 287, - 215, 223, 231, 456, 199, 207, 382, 499, 477, 178, 388, 297, 403, 425, 358, 544, - 463, 350, 318, 326, 334, 342, 271, 263, 529, 496, 494, 420, 525, 474, 523, 366, - 532, 521 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 142, 471, 480, 172, 484, 482, 292, 456, 499, 477, 178, 403, 544, 463, 496, 494, - 420, 525, 474, 523, 521 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [529] - }, - { - "title": "Other", - "children": [ - 506, 509, 504, 517, 502, 520, 505, 518, 507, 508, 503, 519, 310, 302, 410, 183, - 191, 239, 247, 255, 279, 287, 215, 223, 231, 199, 207, 382, 388, 297, 425, 358, - 350, 318, 326, 334, 342, 271, 263, 366, 532 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1684, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 552, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 553, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 554, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 555, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 556, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 557, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 558, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 729, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 730, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2116, - "character": 2 - } - ], - "signatures": [ - { - "id": 731, - "name": "PostgrestQueryBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a query builder scoped to a Postgres table or view." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst query = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: { apikey: 'your-publishable-key' }, retry: true }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2116, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 732, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 733, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 734, - "name": "Relation$1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 735, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 736, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 737, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 738, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2070, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [738] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 216 - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "parameters": [ - { - "id": 739, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL for the query" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 740, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 741, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 744, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2125, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 747, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 748, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 749, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 750, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 751, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 742, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2123, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 753, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable automatic retries for transient errors (default: true)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 743, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to use" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2124, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 752, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length before warning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2126, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [744, 742, 753, 743, 752] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2122, - "character": 5 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 758, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2076, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 759, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 760, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 761, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 762, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 763, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 764, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 765, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 755, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2073, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 767, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\nWhen enabled, idempotent requests (GET/HEAD/OPTIONS) that fail with network\nerrors or HTTP 503/520 responses are automatically retried with exponential\nbackoff (1s, 2s, 4s, up to 3 attempts). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " when not specified." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2084, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 756, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2074, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 757, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2075, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 754, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2072, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 766, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2077, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 817, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3594, - "character": 2 - } - ], - "signatures": [ - { - "id": 818, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\n- If you use " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " with filters and you have\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\n rows visible through " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": " policies are deleted. Note that by default\n no rows are visible, so you need at least one " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": "/" - }, - { - "kind": "code", - "text": "`ALL`" - }, - { - "kind": "text", - "text": " policy that\n makes the rows visible.\n- When using " - }, - { - "kind": "code", - "text": "`delete().in()`" - }, - { - "kind": "text", - "text": ", specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal." - } - ] - }, - { - "tag": "@example", - "name": "Delete a single record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete multiple records", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .in('id', [1, 2, 3])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3594, - "character": 2 - } - ], - "parameters": [ - { - "id": 819, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 820, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 821, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count deleted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3597, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 822, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [821] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3596, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 779, - "name": "insert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3063, - "character": 2 - } - ], - "signatures": [ - { - "id": 780, - "name": "insert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Create a record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk create\nA bulk create operation is handled in a single transaction.\nIf any of the inserts fail, none of the rows are inserted." - } - ] - }, - { - "tag": "@example", - "name": "Bulk create", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert([\n { id: 1, name: 'Mordor' },\n { id: 1, name: 'The Shire' },\n ])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (id)=(1) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"countries_pkey\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3063, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 781, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 782, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 783, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 784, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3066, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [784] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3065, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 781, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 785, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 786, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3068, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [786] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3067, - "character": 85 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 781, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 787, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 788, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 789, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count inserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3073, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 791, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3074, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [789, 791] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3072, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 769, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 2 - } - ], - "signatures": [ - { - "id": 770, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT query on the table or view." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "When using " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`.range()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`.limit()`" - }, - { - "kind": "text", - "text": ", the returned " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " is the total number of rows\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\n\n- By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use " - }, - { - "kind": "code", - "text": "`range()`" - }, - { - "kind": "text", - "text": " queries to paginate through your data.\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Filters](/docs/reference/javascript/using-filters)\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\n- " - }, - { - "kind": "code", - "text": "`apikey`" - }, - { - "kind": "text", - "text": " is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Getting your data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Harry'),\n (2, 'Frodo'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Harry\"\n },\n {\n \"id\": 2,\n \"name\": \"Frodo\"\n },\n {\n \"id\": 3,\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nThe most useful field on a Postgres error is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (" - }, - { - "kind": "code", - "text": "`code: '42501'`" - }, - { - "kind": "text", - "text": ") arrives with a " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " like " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\"`" - }, - { - "kind": "text", - "text": ". Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so the hint isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('characters').select()\nif (error) {\n // Logs the full error: message, code, details, and hint.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"42501\",\n \"details\": null,\n \"hint\": \"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\",\n \"message\": \"permission denied for table characters\"\n },\n \"status\": 401,\n \"statusText\": \"Unauthorized\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Selecting specific columns", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Frodo'),\n (2, 'Harry'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Frodo\"\n },\n {\n \"name\": \"Harry\"\n },\n {\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\nIf your database has foreign key relationships, you can query related tables too." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\nIf your table name contains spaces, you must use double quotes in the " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " statement to reference the table." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables with spaces in their names", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral sections')\n .select(`\n name,\n \"musical instruments\" (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n \"orchestral sections\" (id int8 primary key, name text);\ncreate table\n \"musical instruments\" (\n id int8 primary key,\n section_id int8 not null references \"orchestral sections\",\n name text\n );\n\ninsert into\n \"orchestral sections\" (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n \"musical instruments\" (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"musical instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"musical instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\nIf you're in a situation where your tables are **NOT** directly\nrelated, but instead are joined by a _join table_, you can still use\nthe " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " method to query the related data. The join table needs\nto have the foreign keys as part of its composite primary key." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables through a join table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n name,\n teams (\n name\n )\n `)\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n -- both foreign keys must be part of a composite primary key\n primary key (user_id, team_id)\n );\n\ninsert into\n users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Kiran\",\n \"teams\": [\n {\n \"name\": \"Green\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Evan\",\n \"teams\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\nIf you need to query the same referenced table twice, use the name of the\njoined column to identify which join to use. You can also give each\ncolumn an alias." - } - ] - }, - { - "tag": "@example", - "name": "Query the same referenced table multiple times", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:sender_id(name),\n to:receiver_id(name)\n `)\n\n// To infer types, use the name of the table (in this case `users`) and\n// the name of the foreign key constraint.\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:users!messages_sender_id_fkey(name),\n to:users!messages_receiver_id_fkey(name)\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\n" - }, - { - "kind": "code", - "text": "```sql\n create table\n users (id int8 primary key, name text);\n\n create table\n messages (\n sender_id int8 not null references users,\n receiver_id int8 not null references users,\n content text\n );\n\n insert into\n users (id, name)\n values\n (1, 'Kiran'),\n (2, 'Evan');\n\n insert into\n messages (sender_id, receiver_id, content)\n values\n (1, 2, '👋');\n ```" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleResponse Query the same referenced table multiple times\n```" - }, - { - "kind": "text", - "text": "json\n{\n \"data\": [\n {\n \"content\": \"👋\",\n \"from\": {\n \"name\": \"Kiran\"\n },\n \"to\": {\n \"name\": \"Evan\"\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleDescription Query nested foreign tables through a join table\nYou can use the result of a joined table to gather data in\nanother foreign table. With multiple references to the same foreign\ntable you must specify the column on which to conduct the join.\n\n@example Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "ts\n const { data, error } = await supabase\n .from('games')\n .select(" - }, - { - "kind": "code", - "text": "`\n game_id:id,\n away_team:teams!games_away_team_fkey (\n users (\n id,\n name\n )\n )\n `" - }, - { - "kind": "text", - "text": ")\n\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleSql Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "sql\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n\n primary key (user_id, team_id)\n );\ncreate table\n games (\n id int8 primary key,\n home_team int8 not null references teams,\n away_team int8 not null references teams,\n name text\n );\n\ninsert into users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\ninsert into\n games (id, home_team, away_team, name)\nvalues\n (1, 1, 2, 'Green vs Blue'),\n (2, 2, 1, 'Blue vs Green');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query nested foreign tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"game_id\": 1,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n },\n {\n \"id\": 2,\n \"name\": \"Evan\"\n }\n ]\n }\n },\n {\n \"game_id\": 2,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n }\n ]\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\nIf the filter on a referenced table's column is not satisfied, the referenced\ntable returns " - }, - { - "kind": "code", - "text": "`[]`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " but the parent table is not filtered out.\nIf you want to filter out the parent table rows, use the " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " hint" - } - ] - }, - { - "tag": "@example", - "name": "Filtering through referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections(*)')\n .eq('orchestral_sections.name', 'percussion')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": null\n },\n {\n \"name\": \"violin\",\n \"orchestral_sections\": null\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\nYou can get the number of rows in a related table by using the\n**count** property." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with count", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`*, instruments(count)`)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table characters (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('strings') returning id\n)\ninsert into instruments (name, section_id) values\n('violin', (select id from section)),\n('viola', (select id from section)),\n('cello', (select id from section)),\n('double bass', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```json\n[\n {\n \"id\": \"693694e7-d993-4360-a6d7-6294e325d9b6\",\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"count\": 4\n }\n ]\n }\n]\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying with count option\nYou can get the number of rows by using the\n[count](/docs/reference/javascript/select#parameters) option." - } - ] - }, - { - "tag": "@example", - "name": "Querying with count option", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { count, error } = await supabase\n .from('characters')\n .select('*', { count: 'exact', head: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"count\": 3,\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\nYou can select and filter data inside of\n[JSON](/docs/guides/database/json) columns. Postgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nquerying JSON data." - } - ] - }, - { - "tag": "@example", - "name": "Querying JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n id, name,\n address->city\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Frodo', '{\"city\":\"Hobbiton\"}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Frodo\",\n \"city\": \"Hobbiton\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\nIf you don't want to return the referenced table contents, you can leave the parenthesis empty.\nLike " - }, - { - "kind": "code", - "text": "`.select('name, orchestral_sections!inner()')`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with inner join", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections!inner(name)')\n .eq('orchestral_sections.name', 'woodwinds')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table instruments (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('woodwinds') returning id\n)\ninsert into instruments (name, section_id) values\n('flute', (select id from section)),\n('clarinet', (select id from section)),\n('bassoon', (select id from section)),\n('piccolo', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\nIn addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas)." - } - ] - }, - { - "tag": "@example", - "name": "Switching schemas per query", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .schema('myschema')\n .from('mytable')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```sql\ncreate schema myschema;\n\ncreate table myschema.mytable (\n id uuid primary key default gen_random_uuid(),\n data text\n);\n\ninsert into myschema.mytable (data) values ('mydata');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": \"4162e008-27b0-4c0f-82dc-ccaeee9a624d\",\n \"data\": \"mydata\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 771, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 772, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 771, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 773, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " - }, - { - "kind": "code", - "text": "`customName:columnName`" - } - ] - }, - "type": { - "type": "reference", - "target": 771, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 774, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 777, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows in the table or view.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2941, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 778, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 776, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2940, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [777, 776] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 165 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 772, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "GET" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 807, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3458, - "character": 2 - } - ], - "signatures": [ - { - "id": 808, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update." - } - ] - }, - { - "tag": "@example", - "name": "Updating your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\nPostgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nworking with JSON data. Currently, it is only possible to update the entire JSON document." - } - ] - }, - { - "tag": "@example", - "name": "Updating JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .update({\n address: {\n street: 'Melrose Place',\n postcode: 90210\n }\n })\n .eq('address->postcode', 90210)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210 }');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Michael\",\n \"address\": {\n \"street\": \"Melrose Place\",\n \"postcode\": 90210\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3458, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 809, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 810, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to update with" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 811, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 812, - "name": "Update", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3461, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [812] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3460, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Update" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 809, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 813, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 814, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 815, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count updated rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3465, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [815] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3464, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "PATCH" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 792, - "name": "upsert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3293, - "character": 2 - } - ], - "signatures": [ - { - "id": 793, - "name": "upsert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": " allows you to perform the equivalent of\n" - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": " if a row with the corresponding " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates`" - }, - { - "kind": "text", - "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Upsert a single row using a unique key", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting a single row, overwriting based on the 'username' unique column\nconst { data, error } = await supabase\n .from('users')\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\n\n// Example response:\n// {\n// data: [\n// { id: 4, message: 'bar', username: 'supabot' }\n// ],\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upsert with conflict resolution and exact row counting", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting and returning exact count\nconst { data, error, count } = await supabase\n .from('users')\n .upsert(\n {\n id: 3,\n message: 'foo',\n username: 'supabot'\n },\n {\n onConflict: 'username',\n count: 'exact'\n }\n )\n\n// Example response:\n// {\n// data: [\n// {\n// id: 42,\n// handle: \"saoirse\",\n// display_name: \"Saoirse\"\n// }\n// ],\n// count: 1,\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Primary keys must be included in " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " to use upsert." - } - ] - }, - { - "tag": "@example", - "name": "Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert({ id: 1, name: 'piano' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Bulk Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert([\n { id: 1, name: 'piano' },\n { id: 2, name: 'harp' },\n ])\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n },\n {\n \"id\": 2,\n \"name\": \"harp\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\nIn the following query, " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " implicitly uses the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": "\n(primary key) column to determine conflicts. If there is no existing\nrow with the same " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " inserts a new row, which\nwill fail in this case as there is already a row with " - }, - { - "kind": "code", - "text": "`handle`" - }, - { - "kind": "text", - "text": " " - }, - { - "kind": "code", - "text": "`\"saoirse\"`" - }, - { - "kind": "text", - "text": ".\nUsing the " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " option, you can instruct " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " to use\nanother column with a unique constraint to determine conflicts." - } - ] - }, - { - "tag": "@example", - "name": "Upserting into tables with constraints", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 generated by default as identity primary key,\n handle text not null unique,\n display_name text\n );\n\ninsert into\n users (id, handle, display_name)\nvalues\n (1, 'saoirse', null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (handle)=(saoirse) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"users_handle_key\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3293, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 794, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 795, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 796, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 797, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3296, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [797] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3295, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 794, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 798, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 799, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3298, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [799] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3297, - "character": 85 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 794, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 800, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 801, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 804, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count upserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3307, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 805, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 806, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates: false`" - }, - { - "kind": "text", - "text": ". This also only applies when doing bulk upserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3308, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 803, - "name": "ignoreDuplicates", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", duplicate rows are ignored. If\n" - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", duplicate rows are merged with existing rows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 802, - "name": "onConflict", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns are equal." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [804, 806, 803, 802] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [730] - }, - { - "title": "Properties", - "children": [758, 755, 767, 756, 757, 754, 766] - }, - { - "title": "Methods", - "children": [817, 779, 769, 807, 792] - } - ], - "categories": [ - { - "title": "Database", - "children": [730, 817, 779, 769, 807, 792] - }, - { - "title": "Other", - "children": [758, 755, 767, 756, 757, 754, 766] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 823, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 824, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 825, - "name": "Relation$1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 826, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 827, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 828, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 829, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2070, - "character": 2 - } - ], - "type": { - "type": "inferred", - "name": "R" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [829] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 216 - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - }, - { - "id": 559, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 560, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 561, - "name": "PostgrestTransformBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 562, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 563, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 564, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 565, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 566, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 567, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 568, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 569, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 570, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 575, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 578, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 579, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 580, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 581, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 582, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 583, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 584, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 585, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 573, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 586, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 571, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 589, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 574, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 587, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 576, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 577, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 572, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 588, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 575, 578, 573, 586, 571, 589, 574, 587, 576, 577, 572, 588 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 59, - "name": "PostgrestBuilder.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 58, - "name": "PostgrestBuilder.constructor" - } - }, - { - "id": 676, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 88, - "name": "PostgrestBuilder.body" - } - }, - { - "id": 679, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 680, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 681, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 682, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 683, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 684, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 685, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 686, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 91, - "name": "PostgrestBuilder.fetch" - } - }, - { - "id": 674, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 86, - "name": "PostgrestBuilder.headers" - } - }, - { - "id": 687, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 99, - "name": "PostgrestBuilder.isMaybeSingle" - } - }, - { - "id": 672, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 84, - "name": "PostgrestBuilder.method" - } - }, - { - "id": 690, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 102, - "name": "PostgrestBuilder.retryEnabled" - } - }, - { - "id": 675, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 87, - "name": "PostgrestBuilder.schema" - } - }, - { - "id": 688, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 100, - "name": "PostgrestBuilder.shouldStripNulls" - } - }, - { - "id": 677, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 89, - "name": "PostgrestBuilder.shouldThrowOnError" - } - }, - { - "id": 678, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 90, - "name": "PostgrestBuilder.signal" - } - }, - { - "id": 673, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 85, - "name": "PostgrestBuilder.url" - } - }, - { - "id": 689, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 101, - "name": "PostgrestBuilder.urlLengthLimit" - } - }, - { - "id": 641, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "signatures": [ - { - "id": 642, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "parameters": [ - { - "id": 643, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 650, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "signatures": [ - { - "id": 651, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 654, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "signatures": [ - { - "id": 655, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "parameters": [ - { - "id": 656, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 657, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 658, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1608, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 661, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1611, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 663, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1613, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 660, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1610, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 659, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1609, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 662, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1612, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [658, 661, 663, 660, 659, 662] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1607, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - } - ] - }, - { - "id": 652, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "signatures": [ - { - "id": 653, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 626, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "signatures": [ - { - "id": 627, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "parameters": [ - { - "id": 628, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 629, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 631, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1243, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 632, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1244, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [631, 632] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1242, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 669, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "signatures": [ - { - "id": 670, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "parameters": [ - { - "id": 671, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - } - } - ] - }, - { - "id": 647, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "signatures": [ - { - "id": 648, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 649, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 479, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 595, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "signatures": [ - { - "id": 596, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 597, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 598, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 427, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 599, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 600, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 601, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 602, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1115, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 603, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [601, 602, 603] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 604, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - } - ], - "parameters": [ - { - "id": 605, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 606, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 607, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 608, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1119, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 609, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 610, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1121, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [608, 609, 610] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 611, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 612, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 613, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 442, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 614, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 616, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 618, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1129, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 617, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1128, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [616, 618, 617] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 619, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "parameters": [ - { - "id": 620, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 621, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 623, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 625, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 624, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [623, 625, 624] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 714, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 715, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 716, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 717, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 718, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 719, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [719] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 720, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 721, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [721] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 131, - "name": "PostgrestBuilder.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 130, - "name": "PostgrestBuilder.overrideTypes" - } - }, - { - "id": 633, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "signatures": [ - { - "id": 634, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "parameters": [ - { - "id": 635, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 636, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 637, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 638, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 639, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 640, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [639, 640] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 699, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 700, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 701, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 112, - "name": "PostgrestBuilder.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 111, - "name": "PostgrestBuilder.retry" - } - }, - { - "id": 666, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "signatures": [ - { - "id": 667, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 668, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 498, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "overwrites": { - "type": "reference", - "target": 128, - "name": "PostgrestBuilder.returns" - } - } - ], - "overwrites": { - "type": "reference", - "target": 127, - "name": "PostgrestBuilder.returns" - } - }, - { - "id": 664, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "signatures": [ - { - "id": 665, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 590, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "signatures": [ - { - "id": 591, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 592, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 593, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 594, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 695, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 696, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 697, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 698, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 108, - "name": "PostgrestBuilder.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 107, - "name": "PostgrestBuilder.setHeader" - } - }, - { - "id": 644, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "signatures": [ - { - "id": 645, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 646, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 476, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 693, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 694, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 106, - "name": "PostgrestBuilder.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 105, - "name": "PostgrestBuilder.stripNulls" - } - }, - { - "id": 702, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 703, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 704, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 705, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 706, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 707, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 708, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 709, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 710, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 711, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 712, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 713, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 115, - "name": "PostgrestBuilder.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 114, - "name": "PostgrestBuilder.then" - } - }, - { - "id": 691, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 692, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 104, - "name": "PostgrestBuilder.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 103, - "name": "PostgrestBuilder.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [560] - }, - { - "title": "Properties", - "children": [676, 679, 674, 687, 672, 690, 675, 688, 677, 678, 673, 689] - }, - { - "title": "Methods", - "children": [ - 641, 650, 654, 652, 626, 669, 647, 595, 714, 633, 699, 666, 664, 590, 695, 644, - 693, 702, 691 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 560, 641, 650, 654, 652, 626, 669, 647, 714, 633, 666, 664, 590, 695, 644, 693, - 691 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [699] - }, - { - "title": "Other", - "children": [676, 679, 674, 687, 672, 690, 675, 688, 677, 678, 673, 689, 595, 702] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1066, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 722, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 723, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 724, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 725, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 726, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 727, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 728, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 141, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 2822, - "name": "RealtimeChannel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "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": 2823, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 200, - "character": 4 - } - ], - "signatures": [ - { - "id": 2824, - "name": "RealtimeChannel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\n\nThe topic determines which realtime stream you are subscribing to. Config options let you\nenable acknowledgement for broadcasts, presence tracking, or private channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 200, - "character": 4 - } - ], - "parameters": [ - { - "id": 2825, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2826, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 2827, - "name": "socket", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2831, - "name": "bindings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 160, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "Binding" - }, - "name": "Binding", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2833, - "name": "broadcastEndpointURL", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2829, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 158, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2835, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2813, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2834, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 163, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2830, - "name": "socket", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 159, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2832, - "name": "subTopic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2828, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 157, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2840, - "name": "joinedOnce", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 167, - "character": 8 - } - ], - "getSignature": { - "id": 2841, - "name": "joinedOnce", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 167, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - }, - { - "id": 2844, - "name": "joinPush", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 169, - "character": 8 - } - ], - "getSignature": { - "id": 2845, - "name": "joinPush", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 169, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/push.js", - "qualifiedName": "default" - }, - "name": "Push", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 2846, - "name": "rejoinTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 170, - "character": 8 - } - ], - "getSignature": { - "id": 2847, - "name": "rejoinTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 170, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 2836, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 165, - "character": 8 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 166, - "character": 8 - } - ], - "getSignature": { - "id": 2837, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 165, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - }, - "setSignature": { - "id": 2838, - "name": "state", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 166, - "character": 8 - } - ], - "parameters": [ - { - "id": 2839, - "name": "state", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 2842, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 168, - "character": 8 - } - ], - "getSignature": { - "id": 2843, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 168, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3133, - "name": "copyBindings", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 463, - "character": 4 - } - ], - "signatures": [ - { - "id": 3134, - "name": "copyBindings", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 463, - "character": 4 - } - ], - "parameters": [ - { - "id": 3135, - "name": "other", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3099, - "name": "httpSend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 4 - } - ], - "signatures": [ - { - "id": 3100, - "name": "httpSend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a broadcast message explicitly via REST API.\n\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\n\nPayloads that are " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`ArrayBufferView`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`Uint8Array`" - }, - { - "kind": "text", - "text": ") are sent as\n" - }, - { - "kind": "code", - "text": "`application/octet-stream`" - }, - { - "kind": "text", - "text": "; all other payloads are JSON-encoded." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise resolving to object with success status, and error details if failed" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 4 - } - ], - "parameters": [ - { - "id": 3101, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the broadcast event" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3102, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent (required)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3103, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options including timeout" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3105, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 374, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3105] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 49 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 3106, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3107, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 376, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3107] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 375, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 3108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3111, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 380, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3110, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 379, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3109, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 378, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3111, 3110, 3109] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 377, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2880, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 4 - } - ], - "signatures": [ - { - "id": 2881, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 4 - } - ], - "parameters": [ - { - "id": 2882, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2883, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2884, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2885, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 258, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2885] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 58 - } - ] - } - } - }, - { - "id": 2886, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2887, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 259, - "character": 17 - } - ], - "signatures": [ - { - "id": 2888, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 259, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2889, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2890, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2891, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2892, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 261, - "character": 8 - } - ], - "parameters": [ - { - "id": 2893, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2894, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2895, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2896, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2897, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 263, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2897] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 262, - "character": 58 - } - ] - } - } - }, - { - "id": 2898, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2899, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 264, - "character": 17 - } - ], - "signatures": [ - { - "id": 2900, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 264, - "character": 17 - } - ], - "parameters": [ - { - "id": 2901, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3362, - "typeArguments": [ - { - "type": "reference", - "target": 2890, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2902, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2903, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2904, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2905, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 266, - "character": 8 - } - ], - "parameters": [ - { - "id": 2906, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2907, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2908, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2910, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 268, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2910] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 267, - "character": 58 - } - ] - } - } - }, - { - "id": 2911, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2912, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 269, - "character": 17 - } - ], - "signatures": [ - { - "id": 2913, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 269, - "character": 17 - } - ], - "parameters": [ - { - "id": 2914, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3372, - "typeArguments": [ - { - "type": "reference", - "target": 2903, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2915, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2916, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2917, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2918, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 271, - "character": 8 - } - ], - "parameters": [ - { - "id": 2919, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2920, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2921, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2923, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 273, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "*" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2923] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 272, - "character": 58 - } - ] - } - } - }, - { - "id": 2924, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2925, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 274, - "character": 17 - } - ], - "signatures": [ - { - "id": 2926, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 274, - "character": 17 - } - ], - "parameters": [ - { - "id": 2927, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3362, - "typeArguments": [ - { - "type": "reference", - "target": 2916, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3372, - "typeArguments": [ - { - "type": "reference", - "target": 2916, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2928, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2929, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2930, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2931, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 276, - "character": 8 - } - ], - "parameters": [ - { - "id": 2932, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2933, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2934, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2935, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2936, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 277, - "character": 156 - } - ], - "signatures": [ - { - "id": 2937, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 277, - "character": 156 - } - ], - "parameters": [ - { - "id": 2938, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3328, - "typeArguments": [ - { - "type": "reference", - "target": 2929, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2939, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2940, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2941, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2942, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 279, - "character": 8 - } - ], - "parameters": [ - { - "id": 2943, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2944, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2945, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2946, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2947, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 280, - "character": 159 - } - ], - "signatures": [ - { - "id": 2948, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 280, - "character": 159 - } - ], - "parameters": [ - { - "id": 2949, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3333, - "typeArguments": [ - { - "type": "reference", - "target": 2940, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2950, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2951, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2952, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2953, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 282, - "character": 8 - } - ], - "parameters": [ - { - "id": 2954, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2955, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2956, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2957, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2958, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 283, - "character": 159 - } - ], - "signatures": [ - { - "id": 2959, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 283, - "character": 159 - } - ], - "parameters": [ - { - "id": 2960, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3343, - "typeArguments": [ - { - "type": "reference", - "target": 2951, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2961, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2962, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2963, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2964, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 285, - "character": 8 - } - ], - "parameters": [ - { - "id": 2965, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2966, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2967, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2968, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2969, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 286, - "character": 159 - } - ], - "signatures": [ - { - "id": 2970, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 286, - "character": 159 - } - ], - "parameters": [ - { - "id": 2971, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3352, - "typeArguments": [ - { - "type": "reference", - "target": 2962, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2972, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2973, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2975, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 288, - "character": 8 - } - ], - "parameters": [ - { - "id": 2976, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2977, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2978, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "*" - }, - { - "type": "literal", - "value": "INSERT" - }, - { - "type": "literal", - "value": "UPDATE" - } - ] - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2979, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2980, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 289, - "character": 152 - } - ], - "signatures": [ - { - "id": 2981, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 289, - "character": 152 - } - ], - "parameters": [ - { - "id": 2982, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3328, - "typeArguments": [ - { - "type": "reference", - "target": 2973, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2983, - "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": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 4 - } - ], - "parameters": [ - { - "id": 2984, - "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": 2985, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2986, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2987, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 297, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2987] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 59 - } - ] - } - } - }, - { - "id": 2988, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function to be invoked when event handler is triggered." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2989, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 17 - } - ], - "signatures": [ - { - "id": 2990, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 17 - } - ], - "parameters": [ - { - "id": 2991, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2992, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2994, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 300, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2995, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 301, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2996, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2998, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 303, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2997, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 302, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2998, 2997] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 301, - "character": 15 - } - ] - } - } - }, - { - "id": 2993, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 299, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2994, 2995, 2993] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 27 - } - ], - "indexSignatures": [ - { - "id": 2999, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 305, - "character": 8 - } - ], - "parameters": [ - { - "id": 3000, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3001, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3002, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3003, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3004, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 308, - "character": 8 - } - ], - "parameters": [ - { - "id": 3005, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3006, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3007, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3008, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3009, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 310, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3009] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 309, - "character": 59 - } - ] - } - } - }, - { - "id": 3010, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3011, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 17 - } - ], - "signatures": [ - { - "id": 3012, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 17 - } - ], - "parameters": [ - { - "id": 3013, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3014, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3016, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 313, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3017, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 314, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3018, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3020, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 316, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3019, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 315, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3020, 3019] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 314, - "character": 15 - } - ] - } - } - }, - { - "id": 3021, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 318, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3002, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3015, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 312, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3016, 3017, 3021, 3015] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3022, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3023, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 3024, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3025, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3026, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3027, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 321, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3399, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3027] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 94 - } - ] - } - } - }, - { - "id": 3028, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 17 - } - ], - "signatures": [ - { - "id": 3030, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 17 - } - ], - "parameters": [ - { - "id": 3031, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3032, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3034, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 324, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3399, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - }, - { - "id": 3035, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 325, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3023, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3033, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 323, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3034, 3035, 3033] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3036, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3037, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3039, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 328, - "character": 8 - } - ], - "parameters": [ - { - "id": 3040, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3041, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3042, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3043, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3044, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 330, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3400, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3044] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 329, - "character": 59 - } - ] - } - } - }, - { - "id": 3045, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3046, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 17 - } - ], - "signatures": [ - { - "id": 3047, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 17 - } - ], - "parameters": [ - { - "id": 3048, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3051, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 333, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3400, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - }, - { - "id": 3052, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 334, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastInsertPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3037, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastInsertPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3050, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 332, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3051, 3052, 3050] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3053, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3054, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3055, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3056, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 337, - "character": 8 - } - ], - "parameters": [ - { - "id": 3057, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3058, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3059, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3060, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3061, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 339, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3401, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3061] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 338, - "character": 59 - } - ] - } - } - }, - { - "id": 3062, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3063, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 17 - } - ], - "signatures": [ - { - "id": 3064, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 17 - } - ], - "parameters": [ - { - "id": 3065, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3068, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 342, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3401, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - }, - { - "id": 3069, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastUpdatePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3054, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastUpdatePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3067, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 341, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3068, 3069, 3067] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3070, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3071, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3072, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3073, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 346, - "character": 8 - } - ], - "parameters": [ - { - "id": 3074, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3075, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3076, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3077, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3078, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 348, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3402, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3078] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 347, - "character": 59 - } - ] - } - } - }, - { - "id": 3079, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3080, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 17 - } - ], - "signatures": [ - { - "id": 3081, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 17 - } - ], - "parameters": [ - { - "id": 3082, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3083, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3085, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 351, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3402, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - }, - { - "id": 3086, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 352, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastDeletePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3071, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastDeletePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3084, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3085, 3086, 3084] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3087, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3088, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3089, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3090, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 355, - "character": 8 - } - ], - "parameters": [ - { - "id": 3091, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3092, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 3093, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 3095, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3096, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 356, - "character": 70 - } - ], - "signatures": [ - { - "id": 3097, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 356, - "character": 70 - } - ], - "parameters": [ - { - "id": 3098, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2857, - "name": "presenceState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 4 - } - ], - "signatures": [ - { - "id": 2858, - "name": "presenceState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current presence state for this channel.\n\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\ntracked metadata for that user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2859, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 28 - } - ], - "indexSignatures": [ - { - "id": 2861, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 233, - "character": 8 - } - ], - "parameters": [ - { - "id": 2862, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 2863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "target": 3382, - "typeArguments": [ - { - "type": "reference", - "target": 2859, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 3112, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 4 - } - ], - "signatures": [ - { - "id": 3113, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a message into the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- When using REST you don't need to subscribe to the channel\n- REST calls are only available from 2.37.0 onwards\n- If you create a channel only to send a REST broadcast, remove it from\n the client when the send completes" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via websocket", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\nchannel.subscribe((status) => {\n if (status === 'SUBSCRIBED') {\n channel.send({\n type: 'broadcast',\n event: 'cursor-pos',\n payload: { x: Math.random(), y: Math.random() },\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Send a message via websocket\n" - }, - { - "kind": "code", - "text": "```js\nok | timed out | error\n```" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via REST", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\ntry {\n await channel.httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\n} finally {\n await supabase.removeChannel(channel)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 4 - } - ], - "parameters": [ - { - "id": 3114, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arguments to send to channel" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3117, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event being sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 432, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3118, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 433, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3116, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of event to send" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 431, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3117, 3118, 3116] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 15 - } - ], - "indexSignatures": [ - { - "id": 3119, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 434, - "character": 8 - } - ], - "parameters": [ - { - "id": 3120, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 3121, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options to be used during the send process" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3122, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 435, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3123, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 436, - "character": 8 - } - ], - "parameters": [ - { - "id": 3124, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2848, - "name": "subscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 4 - } - ], - "signatures": [ - { - "id": 2849, - "name": "subscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Subscribe registers your client with the server.\n\nThe optional " - }, - { - "kind": "code", - "text": "`callback`" - }, - { - "kind": "text", - "text": " receives a " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and, on failure, an " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " argument.\nLog the full " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " so its " - }, - { - "kind": "code", - "text": "`cause`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", and any structured fields aren't hidden\nbehind " - }, - { - "kind": "code", - "text": "`err.message`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.channel('room1').subscribe((status, err) => {\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\n // Log the full error: its `cause` often holds the underlying reason.\n console.error(status, err)\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 4 - } - ], - "parameters": [ - { - "id": 2850, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 25 - } - ], - "signatures": [ - { - "id": 2852, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 25 - } - ], - "parameters": [ - { - "id": 2853, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3407, - "name": "REALTIME_SUBSCRIBE_STATES", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2854, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 2855, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3131, - "name": "teardown", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 462, - "character": 4 - } - ], - "signatures": [ - { - "id": 3132, - "name": "teardown", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Destroys and stops related timers." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 462, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 2864, - "name": "track", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 4 - } - ], - "signatures": [ - { - "id": 2865, - "name": "track", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends the supplied payload to the presence tracker so other subscribers can see that this\nclient is online. Use " - }, - { - "kind": "code", - "text": "`untrack`" - }, - { - "kind": "text", - "text": " to stop broadcasting presence for the same key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 4 - } - ], - "parameters": [ - { - "id": 2866, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2867, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 19 - } - ], - "indexSignatures": [ - { - "id": 2868, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 242, - "character": 8 - } - ], - "parameters": [ - { - "id": 2869, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 2870, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 243, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 2872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 244, - "character": 8 - } - ], - "parameters": [ - { - "id": 2873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3128, - "name": "unsubscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 456, - "character": 4 - } - ], - "signatures": [ - { - "id": 3129, - "name": "unsubscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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!\") )" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 456, - "character": 4 - } - ], - "parameters": [ - { - "id": 3130, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2874, - "name": "untrack", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 4 - } - ], - "signatures": [ - { - "id": 2875, - "name": "untrack", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes the current presence state for this client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 4 - } - ], - "parameters": [ - { - "id": 2876, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2877, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 19 - } - ], - "indexSignatures": [ - { - "id": 2878, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 252, - "character": 8 - } - ], - "parameters": [ - { - "id": 2879, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3125, - "name": "updateJoinPayload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 444, - "character": 4 - } - ], - "signatures": [ - { - "id": 3126, - "name": "updateJoinPayload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the payload that will be sent the next time the channel joins (reconnects).\nUseful for rotating access tokens or updating config without re-creating the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 444, - "character": 4 - } - ], - "parameters": [ - { - "id": 3127, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2823] - }, - { - "title": "Properties", - "children": [2831, 2833, 2829, 2835, 2834, 2830, 2832, 2828] - }, - { - "title": "Accessors", - "children": [2840, 2844, 2846, 2836, 2842] - }, - { - "title": "Methods", - "children": [3133, 3099, 2880, 2857, 3112, 2848, 3131, 2864, 3128, 2874, 3125] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 2831, 2833, 2829, 2835, 2834, 2830, 2832, 2828, 2840, 2844, 2846, 2836, 2842, - 3133, 2880 - ] - }, - { - "title": "Realtime", - "children": [2823, 3099, 2857, 3112, 2848, 3131, 2864, 3128, 2874, 3125] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 155, - "character": 21 - } - ] - }, - { - "id": 3152, - "name": "RealtimeClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 3153, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 145, - "character": 4 - } - ], - "signatures": [ - { - "id": 3154, - "name": "RealtimeClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the Socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nclient.connect()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 145, - "character": 4 - } - ], - "parameters": [ - { - "id": 3155, - "name": "endPoint", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3156, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3273, - "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": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future." - } - ], - "heartbeatIntervalMs": [ - { - "kind": "text", - "text": "The millisec interval to send a heartbeat message." - } - ], - "heartbeatCallback": [ - { - "kind": "text", - "text": "The optional function to handle heartbeat status and latency." - } - ], - "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." - } - ], - "vsn": [ - { - "kind": "text", - "text": "The protocol version to use when connecting. Supported versions are \"1.0.0\" and \"2.0.0\". Defaults to \"2.0.0\"." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3159, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3160, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 18 - } - ], - "signatures": [ - { - "id": 3161, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 18 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3158, - "name": "accessTokenValue", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 59, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 3162, - "name": "apiKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 61, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 3157, - "name": "channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 58, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - }, - { - "id": 3174, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 72, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 3176, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 3177, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3178, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 3179, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 3180, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3181, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3164, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "headers cannot be set on websocket connections" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 64, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 64, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3166, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 65, - "character": 8 - } - ], - "parameters": [ - { - "id": 3167, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3163, - "name": "httpEndpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3173, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 71, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3168, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 67, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3169, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 67, - "character": 13 - } - ], - "indexSignatures": [ - { - "id": 3170, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 68, - "character": 8 - } - ], - "parameters": [ - { - "id": 3171, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3172, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 70, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3185, - "name": "serializer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 76, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/lib/serializer.ts", - "qualifiedName": "default" - }, - "name": "Serializer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3182, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 73, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3184, - "name": "workerRef", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 75, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Worker" - }, - "name": "Worker", - "package": "typescript" - } - }, - { - "id": 3183, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 74, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3206, - "name": "decode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 87, - "character": 8 - } - ], - "getSignature": { - "id": 3207, - "name": "decode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 87, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3204, - "name": "encode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 86, - "character": 8 - } - ], - "getSignature": { - "id": 3205, - "name": "encode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 86, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3186, - "name": "endPoint", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 77, - "character": 8 - } - ], - "getSignature": { - "id": 3187, - "name": "endPoint", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 77, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 3192, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 80, - "character": 8 - } - ], - "getSignature": { - "id": 3193, - "name": "heartbeatCallback", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 80, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3194, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 81, - "character": 8 - } - ], - "getSignature": { - "id": 3195, - "name": "heartbeatIntervalMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 81, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3196, - "name": "heartbeatTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 82, - "character": 8 - } - ], - "getSignature": { - "id": 3197, - "name": "heartbeatTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 82, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "HeartbeatTimer" - }, - "name": "HeartbeatTimer", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3198, - "name": "pendingHeartbeatRef", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 83, - "character": 8 - } - ], - "getSignature": { - "id": 3199, - "name": "pendingHeartbeatRef", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 83, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 3208, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 8 - } - ], - "getSignature": { - "id": 3209, - "name": "reconnectAfterMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3210, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 28 - } - ], - "signatures": [ - { - "id": 3211, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 28 - } - ], - "parameters": [ - { - "id": 3212, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - } - }, - { - "id": 3200, - "name": "reconnectTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 84, - "character": 8 - } - ], - "getSignature": { - "id": 3201, - "name": "reconnectTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 84, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 3213, - "name": "sendBuffer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 8 - } - ], - "getSignature": { - "id": 3214, - "name": "sendBuffer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 3215, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 23 - } - ], - "signatures": [ - { - "id": 3216, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 23 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - } - }, - { - "id": 3217, - "name": "stateChangeCallbacks", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 8 - } - ], - "getSignature": { - "id": 3218, - "name": "stateChangeCallbacks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3219, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3221, - "name": "close", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 92, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3222, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 93, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3223, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 94, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3220, - "name": "open", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 91, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3221, 3222, 3223, 3220] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 32 - } - ] - } - } - } - }, - { - "id": 3188, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 78, - "character": 8 - } - ], - "getSignature": { - "id": 3189, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 78, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3190, - "name": "transport", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 79, - "character": 8 - } - ], - "getSignature": { - "id": 3191, - "name": "transport", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 79, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3481, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3202, - "name": "vsn", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 85, - "character": 8 - } - ], - "getSignature": { - "id": 3203, - "name": "vsn", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 85, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Vsn" - }, - "name": "Vsn", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3258, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 228, - "character": 4 - } - ], - "signatures": [ - { - "id": 3259, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates (or reuses) a " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RealtimeChannel", - "target": 2822 - }, - { - "kind": "text", - "text": " for the provided topic.\n\nTopics are automatically prefixed with " - }, - { - "kind": "code", - "text": "`realtime:`" - }, - { - "kind": "text", - "text": " to match the Realtime service.\nIf a channel with the same topic already exists it will be returned instead of creating\na duplicate connection." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 228, - "character": 4 - } - ], - "parameters": [ - { - "id": 3260, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3261, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3230, - "name": "connect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 151, - "character": 4 - } - ], - "signatures": [ - { - "id": 3231, - "name": "connect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Connects the socket, unless already connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 151, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3250, - "name": "connectionState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 200, - "character": 4 - } - ], - "signatures": [ - { - "id": 3251, - "name": "connectionState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current state of the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 200, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/lib/constants.ts", - "qualifiedName": "ConnectionState" - }, - "name": "ConnectionState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 3234, - "name": "disconnect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 167, - "character": 4 - } - ], - "signatures": [ - { - "id": 3235, - "name": "disconnect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Disconnects the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 167, - "character": 4 - } - ], - "parameters": [ - { - "id": 3236, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A numeric status code to send on disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3237, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom reason for the disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "timeout" - }, - { - "type": "literal", - "value": "ok" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3232, - "name": "endpointURL", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 158, - "character": 4 - } - ], - "signatures": [ - { - "id": 3233, - "name": "endpointURL", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the URL of the websocket." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "string The URL of the websocket." - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 158, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 3238, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 173, - "character": 4 - } - ], - "signatures": [ - { - "id": 3239, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all created channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 173, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 3252, - "name": "isConnected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 206, - "character": 4 - } - ], - "signatures": [ - { - "id": 3253, - "name": "isConnected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " is the connection is open." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3254, - "name": "isConnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 212, - "character": 4 - } - ], - "signatures": [ - { - "id": 3255, - "name": "isConnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently connecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 212, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3256, - "name": "isDisconnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 218, - "character": 4 - } - ], - "signatures": [ - { - "id": 3257, - "name": "isDisconnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently disconnecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 218, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3245, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 194, - "character": 4 - } - ], - "signatures": [ - { - "id": 3246, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " - }, - { - "kind": "code", - "text": "`this.logger`" - }, - { - "kind": "text", - "text": " can be overridden in Client constructor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 194, - "character": 4 - } - ], - "parameters": [ - { - "id": 3247, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3248, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3249, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3270, - "name": "onHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 272, - "character": 4 - } - ], - "signatures": [ - { - "id": 3271, - "name": "onHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets a callback that receives lifecycle events for internal heartbeat messages.\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 272, - "character": 4 - } - ], - "parameters": [ - { - "id": 3272, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3262, - "name": "push", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 236, - "character": 4 - } - ], - "signatures": [ - { - "id": 3263, - "name": "push", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 236, - "character": 4 - } - ], - "parameters": [ - { - "id": 3264, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3314, - "name": "RealtimeMessage", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3243, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 186, - "character": 4 - } - ], - "signatures": [ - { - "id": 3244, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down all channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 186, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3240, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 180, - "character": 4 - } - ], - "signatures": [ - { - "id": 3241, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down a single channel" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 180, - "character": 4 - } - ], - "parameters": [ - { - "id": 3242, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A RealtimeChannel instance" - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3268, - "name": "sendHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 265, - "character": 4 - } - ], - "signatures": [ - { - "id": 3269, - "name": "sendHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a heartbeat message if the socket is connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 265, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3265, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 259, - "character": 4 - } - ], - "signatures": [ - { - "id": 3266, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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.\n\nWhen a token is explicitly provided, it will be preserved across channel operations\n(including removeChannel and resubscribe). The " - }, - { - "kind": "code", - "text": "`accessToken`" - }, - { - "kind": "text", - "text": " callback will not be\ninvoked until " - }, - { - "kind": "code", - "text": "`setAuth()`" - }, - { - "kind": "text", - "text": " is called without arguments." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nSetting the authorization header\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\nclient.realtime.setAuth('my-custom-jwt')\n\n// Switch back to using the accessToken callback\nclient.realtime.setAuth()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 259, - "character": 4 - } - ], - "parameters": [ - { - "id": 3267, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A JWT string to override the token set on the client." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [3153] - }, - { - "title": "Properties", - "children": [ - 3159, 3158, 3162, 3157, 3174, 3164, 3163, 3173, 3168, 3172, 3185, 3182, 3184, - 3183 - ] - }, - { - "title": "Accessors", - "children": [ - 3206, 3204, 3186, 3192, 3194, 3196, 3198, 3208, 3200, 3213, 3217, 3188, 3190, - 3202 - ] - }, - { - "title": "Methods", - "children": [ - 3258, 3230, 3250, 3234, 3232, 3238, 3252, 3254, 3256, 3245, 3270, 3262, 3243, - 3240, 3268, 3265 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 3159, 3158, 3162, 3157, 3174, 3164, 3163, 3173, 3168, 3172, 3185, 3182, 3184, - 3183, 3206, 3204, 3186, 3192, 3194, 3196, 3198, 3208, 3200, 3213, 3217, 3188, - 3190, 3202 - ] - }, - { - "title": "Realtime", - "children": [ - 3153, 3258, 3230, 3250, 3234, 3232, 3238, 3252, 3254, 3256, 3245, 3270, 3262, - 3243, 3240, 3268, 3265 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 57, - "character": 21 - } - ] - }, - { - "id": 2813, - "name": "RealtimePresence", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2814, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 60, - "character": 4 - } - ], - "signatures": [ - { - "id": 2815, - "name": "RealtimePresence", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Presence helper that keeps the local presence state in sync with the server." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example for a presence channel", - "content": [ - { - "kind": "code", - "text": "```ts\nconst presence = new RealtimePresence(channel)\n\nchannel.on('presence', ({ event, key }) => {\n console.log(`Presence ${event} on ${key}`)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 60, - "character": 4 - } - ], - "parameters": [ - { - "id": 2816, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2817, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom event names, e.g. " - }, - { - "kind": "code", - "text": "`{ events: { state: 'state', diff: 'diff' } }`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceOptions" - }, - "name": "RealtimePresenceOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 2813, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2818, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2819, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 41, - "character": 8 - } - ], - "getSignature": { - "id": 2820, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 41, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3382, - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2814] - }, - { - "title": "Properties", - "children": [2818] - }, - { - "title": "Accessors", - "children": [2819] - } - ], - "categories": [ - { - "title": "Other", - "children": [2818, 2819] - }, - { - "title": "Realtime", - "children": [2814] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 39, - "character": 21 - } - ] - }, - { - "id": 850, - "name": "StorageApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "API error returned from Storage service\nIncludes HTTP status code and service-specific error code" - } - ] - }, - "children": [ - { - "id": 851, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 40, - "character": 2 - } - ], - "signatures": [ - { - "id": 852, - "name": "StorageApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 40, - "character": 2 - } - ], - "parameters": [ - { - "id": 853, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 854, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 855, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 856, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 850, - "name": "StorageApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.constructor" - } - }, - { - "id": 866, - "name": "__isStorageError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "StorageError.__isStorageError" - } - }, - { - "id": 867, - "name": "namespace", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "StorageError.namespace" - } - }, - { - "id": 857, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.status" - } - }, - { - "id": 858, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.statusCode" - } - }, - { - "id": 859, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 2 - } - ], - "signatures": [ - { - "id": 860, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 861, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 863, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 862, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 42, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 864, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 865, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [863, 862, 864, 865] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 12 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [851] - }, - { - "title": "Properties", - "children": [866, 867, 857, 858] - }, - { - "title": "Methods", - "children": [859] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 37, - "character": 14 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 941, - "name": "SupabaseClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Client.\n\nAn isomorphic Javascript client for interacting with Postgres." - } - ] - }, - "children": [ - { - "id": 942, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 309, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L309" - } - ], - "signatures": [ - { - "id": 943, - "name": "SupabaseClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Initializing" - } - ] - }, - { - "tag": "@example", - "name": "Creating a client", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Create a single supabase client for interacting with your database\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n```" - } - ] - }, - { - "tag": "@example", - "name": "With a custom domain", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Use a custom domain as the supabase URL\nconst supabase = createClient('https://my-custom-domain.com', 'your-publishable-key')\n```" - } - ] - }, - { - "tag": "@example", - "name": "With additional parameters", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst options = {\n db: {\n schema: 'public',\n },\n auth: {\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: true\n },\n global: {\n headers: { 'x-my-custom-header': 'my-app-name' },\n },\n}\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", options)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With custom schemas\nBy default the API server points to the " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": " schema. You can enable other database schemas within the Dashboard.\nGo to [Settings > API > Exposed schemas](/dashboard/project/_/settings/api) and add the schema which you want to expose to the API.\n\nNote: each client connection can only access a single schema, so the code above can access the " - }, - { - "kind": "code", - "text": "`other_schema`" - }, - { - "kind": "text", - "text": " schema but cannot access the " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": " schema." - } - ] - }, - { - "tag": "@example", - "name": "With custom schemas", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n // Provide a custom schema. Defaults to \"public\".\n db: { schema: 'other_schema' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Custom fetch implementation\n" - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests,\nbut an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option.\nThis is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible (for instance Cloudflare Workers)." - } - ] - }, - { - "tag": "@example", - "name": "Custom fetch implementation", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n global: { fetch: fetch.bind(globalThis) }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "React Native options with AsyncStorage\nFor React Native we recommend using " - }, - { - "kind": "code", - "text": "`AsyncStorage`" - }, - { - "kind": "text", - "text": " as the storage implementation for Supabase Auth." - } - ] - }, - { - "tag": "@example", - "name": "React Native options with AsyncStorage", - "content": [ - { - "kind": "code", - "text": "```js\nimport 'react-native-url-polyfill/auto'\nimport { createClient } from '@supabase/supabase-js'\nimport AsyncStorage from \"@react-native-async-storage/async-storage\";\n\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", {\n auth: {\n storage: AsyncStorage,\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: false,\n },\n});\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "React Native options with Expo SecureStore\nIf you wish to encrypt the user's session information, you can use " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " and store the encryption key in Expo SecureStore.\nThe " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " library, a reputable JavaScript-only implementation of the AES encryption algorithm in CTR mode.\nA new 256-bit encryption key is generated using the " - }, - { - "kind": "code", - "text": "`react-native-get-random-values`" - }, - { - "kind": "text", - "text": " library.\nThis key is stored inside Expo's SecureStore, while the value is encrypted and placed inside AsyncStorage.\n\nPlease make sure that:\n- You keep the " - }, - { - "kind": "code", - "text": "`expo-secure-store`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`react-native-get-random-values`" - }, - { - "kind": "text", - "text": " libraries up-to-date.\n- Choose the correct [" - }, - { - "kind": "code", - "text": "`SecureStoreOptions`" - }, - { - "kind": "text", - "text": "](https://docs.expo.dev/versions/latest/sdk/securestore/#securestoreoptions) for your app's needs.\n E.g. [" - }, - { - "kind": "code", - "text": "`SecureStore.WHEN_UNLOCKED`" - }, - { - "kind": "text", - "text": "](https://docs.expo.dev/versions/latest/sdk/securestore/#securestorewhen_unlocked) regulates when the data can be accessed.\n- Carefully consider optimizations or other modifications to the above example, as those can lead to introducing subtle security vulnerabilities." - } - ] - }, - { - "tag": "@example", - "name": "React Native options with Expo SecureStore", - "content": [ - { - "kind": "code", - "text": "```ts\nimport 'react-native-url-polyfill/auto'\nimport { createClient } from '@supabase/supabase-js'\nimport AsyncStorage from '@react-native-async-storage/async-storage';\nimport * as SecureStore from 'expo-secure-store';\nimport * as aesjs from 'aes-js';\nimport 'react-native-get-random-values';\n\n// As Expo's SecureStore does not support values larger than 2048\n// bytes, an AES-256 key is generated and stored in SecureStore, while\n// it is used to encrypt/decrypt values stored in AsyncStorage.\nclass LargeSecureStore {\n private async _encrypt(key: string, value: string) {\n const encryptionKey = crypto.getRandomValues(new Uint8Array(256 / 8));\n\n const cipher = new aesjs.ModeOfOperation.ctr(encryptionKey, new aesjs.Counter(1));\n const encryptedBytes = cipher.encrypt(aesjs.utils.utf8.toBytes(value));\n\n await SecureStore.setItemAsync(key, aesjs.utils.hex.fromBytes(encryptionKey));\n\n return aesjs.utils.hex.fromBytes(encryptedBytes);\n }\n\n private async _decrypt(key: string, value: string) {\n const encryptionKeyHex = await SecureStore.getItemAsync(key);\n if (!encryptionKeyHex) {\n return encryptionKeyHex;\n }\n\n const cipher = new aesjs.ModeOfOperation.ctr(aesjs.utils.hex.toBytes(encryptionKeyHex), new aesjs.Counter(1));\n const decryptedBytes = cipher.decrypt(aesjs.utils.hex.toBytes(value));\n\n return aesjs.utils.utf8.fromBytes(decryptedBytes);\n }\n\n async getItem(key: string) {\n const encrypted = await AsyncStorage.getItem(key);\n if (!encrypted) { return encrypted; }\n\n return await this._decrypt(key, encrypted);\n }\n\n async removeItem(key: string) {\n await AsyncStorage.removeItem(key);\n await SecureStore.deleteItemAsync(key);\n }\n\n async setItem(key: string, value: string) {\n const encrypted = await this._encrypt(key, value);\n\n await AsyncStorage.setItem(key, encrypted);\n }\n}\n\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", {\n auth: {\n storage: new LargeSecureStore(),\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: false,\n },\n});\n```" - } - ] - }, - { - "tag": "@example", - "name": "With a database query", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n\nconst { data } = await supabase.from('profiles').select('*')\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With OpenTelemetry tracing\nOpt in to W3C trace context propagation so the " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " from your\nclient-side spans is attached to Supabase requests and appears in API\nGateway and Edge Function logs. Requires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be\ninstalled in your application. See [Tracing with the JS SDK](https://supabase.com/docs/guides/telemetry/client-side-tracing)." - } - ] - }, - { - "tag": "@example", - "name": "With OpenTelemetry tracing", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n tracePropagation: true,\n})\n\nconst tracer = trace.getTracer('my-app')\n\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // Outgoing request carries the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 309, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L309" - } - ], - "typeParameters": [ - { - "id": 944, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 945, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 946, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 947, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [947] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 948, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "reference", - "target": 945, - "typeArguments": [ - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - } - }, - { - "id": 949, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 950, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 951, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 952, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [952] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ] - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 953, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 954, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 955, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 956, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [956] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [954] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "__InternalSupabase" - }, - "objectType": { - "type": "reference", - "target": 944, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - ], - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 957, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 958, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [958] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ] - } - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 959, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 960, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [960] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 945, - "typeArguments": [ - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "parameters": [ - { - "id": 961, - "name": "supabaseUrl", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 962, - "name": "supabaseKey", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 963, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1072, - "typeArguments": [ - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClientOptions", - "package": "@supabase/supabase-js", - "highlightedProperties": { - "realtime": [ - { - "kind": "text", - "text": "Options passed along to realtime-js constructor." - } - ], - "storage": [ - { - "kind": "text", - "text": "Options passed along to the storage-js constructor." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 941, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClient", - "package": "@supabase/supabase-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 982, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 983, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "signatures": [ - { - "id": 984, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 964, - "name": "auth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 78, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L78" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/SupabaseAuthClient.ts", - "qualifiedName": "SupabaseAuthClient" - }, - "name": "SupabaseAuthClient", - "package": "@supabase/supabase-js" - } - }, - { - "id": 968, - "name": "authUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 86, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L86" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 981, - "name": "changedAccessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 92, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L92" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 973, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 91, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L91" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 975, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 976, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 977, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 978, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 979, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 980, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 970, - "name": "functionsUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L88" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 985, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 95, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L95" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 965, - "name": "realtime", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L79" - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 967, - "name": "realtimeUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L85" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 971, - "name": "rest", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 89, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L89" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestClient" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 986, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 96, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L96" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/helpers.ts", - "qualifiedName": "ResolvedSupabaseClientOptions" - }, - "typeArguments": [ - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "ResolvedSupabaseClientOptions", - "package": "@supabase/supabase-js" - } - }, - { - "id": 966, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L83" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageClient" - }, - "name": "StorageClient", - "package": "@supabase/storage-js" - } - }, - { - "id": 972, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 90, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L90" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 969, - "name": "storageUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 87, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L87" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 988, - "name": "supabaseKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 311, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L311" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 987, - "name": "supabaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 310, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L310" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 989, - "name": "functions", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 403, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L403" - } - ], - "getSignature": { - "id": 990, - "name": "functions", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Functions allows you to deploy and invoke edge functions." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 403, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L403" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../functions-js/src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "name": "FunctionsClient", - "package": "@supabase/functions-js" - } - } - }, - { - "id": 1016, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L515" - } - ], - "signatures": [ - { - "id": 1017, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L515" - } - ], - "parameters": [ - { - "id": 1018, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Realtime channel." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1019, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The options to pass to the Realtime channel." - } - ] - }, - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 991, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a query on a table or a view." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "relation", - "content": [ - { - "kind": "text", - "text": "The table or view name to query" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L411" - }, - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L415" - }, - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L423" - } - ], - "signatures": [ - { - "id": 992, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L411" - } - ], - "typeParameters": [ - { - "id": 993, - "name": "TableName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 994, - "name": "Table", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 995, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 993, - "name": "TableName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 994, - "name": "Table", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 993, - "name": "TableName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 996, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L415" - } - ], - "typeParameters": [ - { - "id": 997, - "name": "ViewName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 998, - "name": "View", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 999, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 997, - "name": "ViewName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 998, - "name": "View", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 997, - "name": "ViewName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 1020, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 529, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L529" - } - ], - "signatures": [ - { - "id": 1021, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all Realtime channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Get all channels", - "content": [ - { - "kind": "code", - "text": "```js\nconst channels = supabase.getChannels()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 529, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L529" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 1025, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L566" - } - ], - "signatures": [ - { - "id": 1026, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes and removes all Realtime channels from Realtime client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Removing channels is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed." - } - ] - }, - { - "tag": "@example", - "name": "Remove all channels", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.removeAllChannels()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L566" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1022, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L549" - } - ], - "signatures": [ - { - "id": 1023, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes and removes Realtime channel from Realtime client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Removing a channel is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed." - } - ] - }, - { - "tag": "@example", - "name": "Removes a channel", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.removeChannel(myChannel)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L549" - } - ], - "parameters": [ - { - "id": 1024, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Realtime channel." - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1004, - "name": "rpc", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L470" - } - ], - "signatures": [ - { - "id": 1005, - "name": "rpc", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a function call." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L470" - } - ], - "typeParameters": [ - { - "id": 1006, - "name": "FnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1007, - "name": "Args", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "default": { - "type": "intrinsic", - "name": "never" - } - }, - { - "id": 1008, - "name": "FilterBuilder", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/rpc.ts", - "qualifiedName": "RpcFunctionNotFound" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "RpcFunctionNotFound", - "package": "@supabase/supabase-js" - }, - "default": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/rpc.ts", - "qualifiedName": "GetRpcFunctionFilterBuilderByArgs" - }, - "typeArguments": [ - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1007, - "name": "Args", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "GetRpcFunctionFilterBuilderByArgs", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 1009, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function name to call" - } - ] - }, - "type": { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "id": 1010, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The arguments to pass to the function call" - } - ] - }, - "type": { - "type": "reference", - "target": 1007, - "name": "Args", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "defaultValue": "..." - }, - { - "id": 1011, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1012, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1015, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 481, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L481" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 1014, - "name": "get", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the function will be called with\nread-only access mode." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 480, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L480" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1013, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 479, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L479" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1015, 1014, 1013] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 478, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L478" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Result" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "RelationName" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Relationships" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "RPC" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 1000, - "name": "schema", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L435" - } - ], - "signatures": [ - { - "id": 1001, - "name": "schema", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L435" - } - ], - "typeParameters": [ - { - "id": 1002, - "name": "DynamicSchema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 1003, - "name": "schema", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema to query" - } - ] - }, - "type": { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestClient" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [942] - }, - { - "title": "Properties", - "children": [ - 982, 964, 968, 981, 973, 970, 985, 965, 967, 971, 986, 966, 972, 969, 988, 987 - ] - }, - { - "title": "Accessors", - "children": [989] - }, - { - "title": "Methods", - "children": [1016, 991, 1020, 1025, 1022, 1004, 1000] - } - ], - "categories": [ - { - "title": "Initializing", - "children": [942] - }, - { - "title": "Other", - "children": [ - 982, 964, 968, 981, 973, 970, 985, 965, 967, 971, 986, 966, 972, 969, 988, 987, - 989, 991, 1004, 1000 - ] - }, - { - "title": "Realtime", - "children": [1016, 1020, 1025, 1022] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 43, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L43" - } - ], - "typeParameters": [ - { - "id": 1055, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 1056, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - { - "type": "reflection", - "declaration": { - "id": 1057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1058, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1058] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1059, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "trueType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - } - }, - { - "id": 1060, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 1061, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1062, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1063, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1063] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ] - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1064, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1065, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1067, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1067] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1065] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "__InternalSupabase" - }, - "objectType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 1068, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1069, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1069] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ] - } - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1070, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1071, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1071] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ] - }, - { - "id": 3419, - "name": "WebSocketFactory", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Utilities for creating WebSocket instances across runtimes." - } - ] - }, - "children": [ - { - "id": 3421, - "name": "getWebSocketConstructor", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 65, - "character": 11 - } - ], - "signatures": [ - { - "id": 3422, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the best available WebSocket constructor for the current runtime." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example with error handling", - "content": [ - { - "kind": "code", - "text": "```ts\ntry {\n const WS = WebSocketFactory.getWebSocketConstructor()\n const socket = new WS('wss://example.com/socket')\n} catch (error) {\n console.error('WebSocket not available in this environment.', error)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 65, - "character": 11 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3423, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26772, - "character": 23 - } - ], - "signatures": [ - { - "id": 3424, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26774, - "character": 4 - } - ], - "parameters": [ - { - "id": 3425, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3426, - "name": "protocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" - }, - "name": "WebSocket", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 3427, - "name": "isWebSocketSupported", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 79, - "character": 11 - } - ], - "signatures": [ - { - "id": 3428, - "name": "isWebSocketSupported", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detects whether the runtime can establish WebSocket connections." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example in a Node.js script", - "content": [ - { - "kind": "code", - "text": "```ts\nif (!WebSocketFactory.isWebSocketSupported()) {\n console.error('WebSockets are required for this script.')\n process.exitCode = 1\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 79, - "character": 11 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [3421, 3427] - } - ], - "categories": [ - { - "title": "Realtime", - "children": [3421, 3427] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 44, - "character": 21 - } - ] - }, - { - "id": 1750, - "name": "AdminUserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1752, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's application specific metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.app_metadata`" - }, - { - "kind": "text", - "text": " column.\n\nOnly a service role can modify.\n\nThe " - }, - { - "kind": "code", - "text": "`app_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 432, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1755, - "name": "ban_duration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 455, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1763, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 385, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.current_password" - } - }, - { - "id": 1760, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 389, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.email" - } - }, - { - "id": 1753, - "name": "email_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's email as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 438, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1758, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " for the user.\n\nAllows you to overwrite the default " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " set for the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 477, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1759, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 403, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.nonce" - } - }, - { - "id": 1761, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.password" - } - }, - { - "id": 1757, - "name": "password_hash", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`password_hash`" - }, - { - "kind": "text", - "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 471, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1762, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 393, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.phone" - } - }, - { - "id": 1754, - "name": "phone_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's phone as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 444, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1756, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " - }, - { - "kind": "code", - "text": "`authenticated`" - }, - { - "kind": "text", - "text": " by default. You should only modify the " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " is not recommended as it grants the user admin privileges." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 463, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1751, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\n\nThe " - }, - { - "kind": "code", - "text": "`user_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 423, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1752, 1755, 1763, 1760, 1753, 1758, 1759, 1761, 1757, 1762, 1754, 1756, 1751 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 412, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "data" - } - ], - "name": "Omit", - "package": "typescript" - } - ] - }, - { - "id": 1707, - "name": "AMREntry", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An authentication method reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time.\n\nNote: Custom access token hooks can return AMR claims as either:\n- An array of AMREntry objects (detailed format with timestamps)\n- An array of strings (RFC-8176 compliant format)" - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 2079 - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "children": [ - { - "id": 1708, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication method name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 282, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1705, - "name": "AMRMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 1709, - "name": "timestamp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 287, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1708, 1709] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 280, - "character": 17 - } - ] - }, - { - "id": 2392, - "name": "AuthOAuthServerApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth 2.1 authorization server user-facing methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThese methods are used to implement the consent page." - } - ] - }, - "children": [ - { - "id": 2396, - "name": "approveAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 4 - } - ], - "signatures": [ - { - "id": 2397, - "name": "approveAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Approves an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter approval, the user's consent is stored and an authorization code is generated.\nThe response contains a complete redirect URL with the authorization code and state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with authorization code" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 4 - } - ], - "parameters": [ - { - "id": 2398, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to approve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2399, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2400, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2401, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2265, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2401] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 60 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2383, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2402, - "name": "denyAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 4 - } - ], - "signatures": [ - { - "id": 2403, - "name": "denyAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Denies an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter denial, the response contains a redirect URL with an OAuth error\n(access_denied) to inform the OAuth client that the user rejected the request." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with error information" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 4 - } - ], - "parameters": [ - { - "id": 2404, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to deny" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2405, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2406, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2407, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2283, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2407] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 57 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2383, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2393, - "name": "getAuthorizationDetails", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2248, - "character": 4 - } - ], - "signatures": [ - { - "id": 2394, - "name": "getAuthorizationDetails", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves details about an OAuth authorization request.\nUsed to display consent information to the user.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis method returns one of two response types:\n- " - }, - { - "kind": "code", - "text": "`OAuthAuthorizationDetails`" - }, - { - "kind": "text", - "text": ": User needs to consent - show consent page with client info\n- " - }, - { - "kind": "code", - "text": "`OAuthRedirect`" - }, - { - "kind": "text", - "text": ": User already consented - redirect immediately to the OAuth client\n\nUse type narrowing to distinguish between the responses:\n" - }, - { - "kind": "code", - "text": "```typescript\nif ('authorization_id' in data) {\n // Show consent page\n} else {\n // Redirect to data.redirect_url\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Authorization details or redirect URL depending on consent status" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2248, - "character": 4 - } - ], - "parameters": [ - { - "id": 2395, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID from the authorization request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2382, - "name": "AuthOAuthAuthorizationDetailsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2408, - "name": "listGrants", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2294, - "character": 4 - } - ], - "signatures": [ - { - "id": 2409, - "name": "listGrants", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth grants that the authenticated user has authorized.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Response with array of OAuth grants with client information and granted scopes" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2294, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2389, - "name": "AuthOAuthGrantsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2410, - "name": "revokeGrant", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 4 - } - ], - "signatures": [ - { - "id": 2411, - "name": "revokeGrant", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revokes a user's OAuth grant for a specific client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\nand invalidates associated refresh tokens." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Empty response on successful revocation" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 4 - } - ], - "parameters": [ - { - "id": 2412, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revocation options" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2414, - "name": "clientId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client identifier (UUID) to revoke access for" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2310, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 25 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2390, - "name": "AuthOAuthRevokeGrantResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2396, 2402, 2393, 2408, 2410] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2396, 2402, 2393, 2408, 2410] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2223, - "character": 17 - } - ] - }, - { - "id": 2492, - "name": "AuthPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lower-level two-step API and management methods for passkeys.\nAccess via " - }, - { - "kind": "code", - "text": "`supabase.auth.passkey`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "children": [ - { - "id": 2509, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2464, - "character": 4 - } - ], - "signatures": [ - { - "id": 2510, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a passkey for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2464, - "character": 4 - } - ], - "parameters": [ - { - "id": 2511, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2472, - "name": "PasskeyDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2484, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2504, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2450, - "character": 4 - } - ], - "signatures": [ - { - "id": 2505, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2450, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2482, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2498, - "name": "startAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2435, - "character": 4 - } - ], - "signatures": [ - { - "id": 2499, - "name": "startAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey authentication ceremony. Fetches an authentication\nchallenge and credential request options from the server. Used as the\nfirst step of a two-step sign-in flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.get()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2435, - "character": 4 - } - ], - "parameters": [ - { - "id": 2500, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2459, - "name": "StartPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2477, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2493, - "name": "startRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2417, - "character": 4 - } - ], - "signatures": [ - { - "id": 2494, - "name": "startRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey registration ceremony. Fetches a registration challenge\nand credential creation options from the server. Used as the first step of\na two-step registration flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.create()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2417, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2475, - "name": "AuthPasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2506, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2457, - "character": 4 - } - ], - "signatures": [ - { - "id": 2507, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a passkey's friendly name." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2457, - "character": 4 - } - ], - "parameters": [ - { - "id": 2508, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2468, - "name": "PasskeyUpdateParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2483, - "name": "AuthPasskeyUpdateResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2501, - "name": "verifyAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2443, - "character": 4 - } - ], - "signatures": [ - { - "id": 2502, - "name": "verifyAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey authentication credential against a previously issued\nchallenge. Used as the second step of a two-step sign-in flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2443, - "character": 4 - } - ], - "parameters": [ - { - "id": 2503, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2464, - "name": "VerifyPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2495, - "name": "verifyRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2425, - "character": 4 - } - ], - "signatures": [ - { - "id": 2496, - "name": "verifyRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey registration credential against a previously issued\nchallenge. Used as the second step of a two-step registration flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2425, - "character": 4 - } - ], - "parameters": [ - { - "id": 2497, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2455, - "name": "VerifyPasskeyRegistrationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2509, 2504, 2498, 2493, 2506, 2501, 2495] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2509, 2504, 2498, 2493, 2506, 2501, 2495] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2407, - "character": 17 - } - ] - }, - { - "id": 42, - "name": "AuthSession", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 45, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 247, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 259, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 47, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 255, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 44, - "name": "provider_refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 243, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 43, - "name": "provider_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 238, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 46, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A one-time used refresh token that never expires." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 251, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 49, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 260, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 50, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When using a separate user storage, accessing properties of this object will throw an error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 264, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [45, 48, 47, 44, 43, 46, 49, 50] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 234, - "character": 17 - } - ] - }, - { - "id": 15, - "name": "AuthUser", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 26, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 360, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 17, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 351, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1734, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 19, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 353, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 41, - "name": "banned_until", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 375, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 20, - "name": "confirmation_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 354, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 30, - "name": "confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 364, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 29, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 363, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 40, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 374, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 27, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 361, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 22, - "name": "email_change_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 356, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 31, - "name": "email_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 365, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 373, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - { - "type": "literal", - "value": "unverified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - ] - } - } - }, - { - "id": 16, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 350, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 370, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 25, - "name": "invited_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 359, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 37, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 371, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 38, - "name": "is_sso_user", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 372, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 33, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 367, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 23, - "name": "new_email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 357, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 24, - "name": "new_phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 358, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 28, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 362, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "phone_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 366, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 21, - "name": "recovery_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 355, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 34, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 368, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 35, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 369, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 18, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 352, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1739, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 26, 17, 19, 41, 20, 30, 29, 40, 27, 22, 31, 39, 16, 36, 25, 37, 38, 33, 23, 24, - 28, 32, 21, 34, 35, 18 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 349, - "character": 17 - } - ] - }, - { - "id": 1961, - "name": "GenerateLinkOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1962, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 776, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1963, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 778, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1962, 1963] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 770, - "character": 17 - } - ] - }, - { - "id": 2343, - "name": "GoTrueAdminCustomProvidersApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "children": [ - { - "id": 2347, - "name": "createProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2071, - "character": 4 - } - ], - "signatures": [ - { - "id": 2348, - "name": "createProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new custom OIDC/OAuth provider.\n\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\nfrom the issuer's well-known endpoint (or the provided " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": ") at creation time.\nThis may return a validation error (" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\nin the document does not match the expected issuer.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2071, - "character": 4 - } - ], - "parameters": [ - { - "id": 2349, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2288, - "name": "CreateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2357, - "name": "deleteProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 4 - } - ], - "signatures": [ - { - "id": 2358, - "name": "deleteProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a custom provider.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 4 - } - ], - "parameters": [ - { - "id": 2359, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2360, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2361, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2104, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2362, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2105, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2361, 2362] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 48 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2350, - "name": "getProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2080, - "character": 4 - } - ], - "signatures": [ - { - "id": 2351, - "name": "getProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific custom provider by identifier.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2080, - "character": 4 - } - ], - "parameters": [ - { - "id": 2352, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2344, - "name": "listProviders", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2056, - "character": 4 - } - ], - "signatures": [ - { - "id": 2345, - "name": "listProviders", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all custom providers with optional type filter.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2056, - "character": 4 - } - ], - "parameters": [ - { - "id": 2346, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2328, - "name": "ListCustomProvidersParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2332, - "name": "CustomProviderListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2353, - "name": "updateProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2094, - "character": 4 - } - ], - "signatures": [ - { - "id": 2354, - "name": "updateProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing custom provider.\n\nWhen " - }, - { - "kind": "code", - "text": "`issuer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": " is changed on an OIDC provider, the server re-fetches and\nvalidates the discovery document before persisting. This may return a validation error\n(" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery document is unreachable, invalid, or\nthe issuer does not match.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2094, - "character": 4 - } - ], - "parameters": [ - { - "id": 2355, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2356, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2309, - "name": "UpdateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2347, 2357, 2350, 2344, 2353] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2347, 2357, 2350, 2344, 2353] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2047, - "character": 17 - } - ] - }, - { - "id": 2096, - "name": "GoTrueAdminMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication administration API." - } - ], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "children": [ - { - "id": 2100, - "name": "deleteFactor", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1511, - "character": 4 - } - ], - "signatures": [ - { - "id": 2101, - "name": "deleteFactor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#unenroll", - "target": 2071 - } - ] - }, - { - "tag": "@expermental", - "content": [] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Delete a factor for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a factor for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1511, - "character": 4 - } - ], - "parameters": [ - { - "id": 2102, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2086, - "name": "AuthMFAAdminDeleteFactorParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2083, - "name": "AuthMFAAdminDeleteFactorResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2097, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1481, - "character": 4 - } - ], - "signatures": [ - { - "id": 2098, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all factors associated to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "List all factors for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "List all factors for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n factors: Factor[\n {\n id: '',\n friendly_name: 'Auth App Factor',\n factor_type: 'totp',\n status: 'verified',\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z'\n }\n ]\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1481, - "character": 4 - } - ], - "parameters": [ - { - "id": 2099, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2093, - "name": "AuthMFAAdminListFactorsParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2090, - "name": "AuthMFAAdminListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2100, 2097] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2100, 2097] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1449, - "character": 17 - } - ] - }, - { - "id": 2228, - "name": "GoTrueAdminOAuthApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "children": [ - { - "id": 2232, - "name": "createClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1810, - "character": 4 - } - ], - "signatures": [ - { - "id": 2233, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1810, - "character": 4 - } - ], - "parameters": [ - { - "id": 2234, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2198, - "name": "CreateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2242, - "name": "deleteClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 4 - } - ], - "signatures": [ - { - "id": 2243, - "name": "deleteClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 4 - } - ], - "parameters": [ - { - "id": 2244, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2245, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2246, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1841, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2247, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1842, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2246, 2247] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 44 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2235, - "name": "getClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1820, - "character": 4 - } - ], - "signatures": [ - { - "id": 2236, - "name": "getClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1820, - "character": 4 - } - ], - "parameters": [ - { - "id": 2237, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2229, - "name": "listClients", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1800, - "character": 4 - } - ], - "signatures": [ - { - "id": 2230, - "name": "listClients", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth clients with optional pagination.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1800, - "character": 4 - } - ], - "parameters": [ - { - "id": 2231, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2117, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2216, - "name": "OAuthClientListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2248, - "name": "regenerateClientSecret", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1853, - "character": 4 - } - ], - "signatures": [ - { - "id": 2249, - "name": "regenerateClientSecret", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Regenerates the secret for an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1853, - "character": 4 - } - ], - "parameters": [ - { - "id": 2250, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2238, - "name": "updateClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1830, - "character": 4 - } - ], - "signatures": [ - { - "id": 2239, - "name": "updateClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1830, - "character": 4 - } - ], - "parameters": [ - { - "id": 2240, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2241, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2207, - "name": "UpdateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2232, 2242, 2235, 2229, 2248, 2238] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2232, 2242, 2235, 2229, 2248, 2238] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1790, - "character": 17 - } - ] - }, - { - "id": 2512, - "name": "GoTrueAdminPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2516, - "name": "deletePasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2484, - "character": 4 - } - ], - "signatures": [ - { - "id": 2517, - "name": "deletePasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a specific passkey for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2484, - "character": 4 - } - ], - "parameters": [ - { - "id": 2518, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2488, - "name": "AuthPasskeyAdminDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2484, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2513, - "name": "listPasskeys", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2475, - "character": 4 - } - ], - "signatures": [ - { - "id": 2514, - "name": "listPasskeys", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2475, - "character": 4 - } - ], - "parameters": [ - { - "id": 2515, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2485, - "name": "AuthPasskeyAdminListParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2482, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2516, 2513] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2516, 2513] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2466, - "character": 17 - } - ] - }, - { - "id": 2025, - "name": "GoTrueMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication API." - } - ] - }, - "children": [ - { - "id": 2082, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1412, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "WebAuthnApi" - }, - "name": "WebAuthnApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 2035, - "name": "challenge", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1154, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1155, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1156, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1157, - "character": 4 - } - ], - "signatures": [ - { - "id": 2036, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- A phone factor sends a code to the user upon challenge. The channel defaults to " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " unless otherwise specified." - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor (WhatsApp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n channel: 'whatsapp',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor (WhatsApp)\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1154, - "character": 4 - } - ], - "parameters": [ - { - "id": 2037, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2039, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2040, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2039, 2040] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2041, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2042, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 2043, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2042, 2043] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2044, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1155, - "character": 4 - } - ], - "parameters": [ - { - "id": 2045, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1992, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2046, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2047, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2048, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2047, 2048] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2050, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 2051, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2050, 2051] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2052, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1156, - "character": 4 - } - ], - "parameters": [ - { - "id": 2053, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1993, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2054, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2055, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2056, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2055, 2056] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2058, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2059, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2058, 2059] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2060, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1157, - "character": 4 - } - ], - "parameters": [ - { - "id": 2061, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1994, - "name": "MFAChallengeParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2013, - "name": "AuthMFAChallengeResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2074, - "name": "challengeAndVerify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1346, - "character": 4 - } - ], - "signatures": [ - { - "id": 2075, - "name": "challengeAndVerify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Intended for use with only TOTP factors.\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking " - }, - { - "kind": "code", - "text": "`challengeAndVerify()`" - }, - { - "kind": "text", - "text": ".\n- Executes [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge) and [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify) in a single step." - } - ] - }, - { - "tag": "@example", - "name": "Create and verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create and verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1346, - "character": 4 - } - ], - "parameters": [ - { - "id": 2076, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2026, - "name": "enroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1081, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1082, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1083, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1084, - "character": 4 - } - ], - "signatures": [ - { - "id": 2027, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " as the " - }, - { - "kind": "code", - "text": "`factorType`" - }, - { - "kind": "text", - "text": " and use the returned " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " to create a challenge.\n- To create a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge).\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- To create and verify a TOTP challenge in a single step, see [" - }, - { - "kind": "code", - "text": "`mfa.challengeAndVerify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challengeandverify).\n- To generate a QR code for the " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " secret in Next.js, you can do the following:\n" - }, - { - "kind": "code", - "text": "```html\n{data.totp.uri}\n```" - }, - { - "kind": "text", - "text": "\n- The " - }, - { - "kind": "code", - "text": "`challenge`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`verify`" - }, - { - "kind": "text", - "text": " steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge." - } - ] - }, - { - "tag": "@example", - "name": "Enroll a time-based, one-time password (TOTP) factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'totp',\n friendlyName: 'your_friendly_name'\n})\n\n// Use the id to create a challenge.\n// The challenge can be verified by entering the code generated from the authenticator app.\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a time-based, one-time password (TOTP) factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp'\n totp: {\n qr_code: '',\n secret: '',\n uri: '',\n }\n friendly_name?: 'Important app'\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Enroll a Phone Factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'phone',\n friendlyName: 'your_friendly_name',\n phone: '+12345678',\n})\n\n// Use the id to create a challenge and send an SMS with a code to the user.\nconst { id, type, friendly_name, phone } = data\n\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a Phone Factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n friendly_name?: 'Important app',\n phone: '+5787123456'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1081, - "character": 4 - } - ], - "parameters": [ - { - "id": 2028, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2124, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2029, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1082, - "character": 4 - } - ], - "parameters": [ - { - "id": 2030, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2125, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2031, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1083, - "character": 4 - } - ], - "parameters": [ - { - "id": 2032, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2033, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1084, - "character": 4 - } - ], - "parameters": [ - { - "id": 2034, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1977, - "name": "MFAEnrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2004, - "name": "AuthMFAEnrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2079, - "name": "getAuthenticatorAssuranceLevel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1411, - "character": 4 - } - ], - "signatures": [ - { - "id": 2080, - "name": "getAuthenticatorAssuranceLevel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " (or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\nand rarely uses the network. When a JWT is provided (useful in server-side\nenvironments like Edge Functions where no session is stored), this method\nwill make a network request to validate the user and fetch their MFA factors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\n- In Supabase, having an AAL of " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\n- If the user has a verified factor, the " - }, - { - "kind": "code", - "text": "`nextLevel`" - }, - { - "kind": "text", - "text": " field will return " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": ", else, it will return " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": ".\n- An optional " - }, - { - "kind": "code", - "text": "`jwt`" - }, - { - "kind": "text", - "text": " parameter can be passed to check the AAL level of a specific JWT instead of the current session." - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details of a session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the AAL details of a session\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n currentLevel: 'aal1',\n nextLevel: 'aal2',\n currentAuthenticationMethods: [\n {\n method: 'password',\n timestamp: 1700000000\n }\n ]\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details for a specific JWT", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1411, - "character": 4 - } - ], - "parameters": [ - { - "id": 2081, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2020, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2077, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1358, - "character": 4 - } - ], - "signatures": [ - { - "id": 2078, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the list of MFA factors enabled for this user." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 2026 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 2079 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient#getUser", - "target": 1377 - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1358, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2014, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - } - } - ], - "name": "AuthMFAListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2071, - "name": "unenroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1265, - "character": 4 - } - ], - "signatures": [ - { - "id": 2072, - "name": "unenroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unenroll removes a MFA factor.\nA user has to have an " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " authenticator level in order to unenroll a " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " factor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@example", - "name": "Unenroll a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.unenroll({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Unenroll a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: ''\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1265, - "character": 4 - } - ], - "parameters": [ - { - "id": 2073, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1978, - "name": "MFAUnenrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2005, - "name": "AuthMFAUnenrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2062, - "name": "verify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1237, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1238, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1239, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1240, - "character": 4 - } - ], - "signatures": [ - { - "id": 2063, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first." - } - ] - }, - { - "tag": "@example", - "name": "Verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.verify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1237, - "character": 4 - } - ], - "parameters": [ - { - "id": 2064, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1981, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2065, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1238, - "character": 4 - } - ], - "parameters": [ - { - "id": 2066, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1982, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2067, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1239, - "character": 4 - } - ], - "parameters": [ - { - "id": 2068, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1987, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2069, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1240, - "character": 4 - } - ], - "parameters": [ - { - "id": 2070, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1989, - "name": "MFAVerifyParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [2082] - }, - { - "title": "Methods", - "children": [2035, 2074, 2026, 2079, 2077, 2071, 2062] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2035, 2074, 2026, 2079, 2077, 2071, 2062] - }, - { - "title": "Other", - "children": [2082] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 999, - "character": 17 - } - ] - }, - { - "id": 2166, - "name": "JWK", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2170, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1661, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2169, - "name": "key_ops", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1660, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2171, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1662, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2167, - "name": "kty", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1659, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2168, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2170, 2169, 2171, 2167] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1658, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2172, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1663, - "character": 4 - } - ], - "parameters": [ - { - "id": 2173, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 2146, - "name": "JwtPayload", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWT Payload containing claims for Supabase authentication tokens.\n\nRequired claims (iss, aud, exp, iat, sub, role, aal, session_id) are inherited from RequiredClaims.\nAll other claims are optional as they can be customized via Custom Access Token Hooks." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://supabase.com/docs/guides/auth/jwt-fields" - } - ] - } - ] - }, - "children": [ - { - "id": 2162, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1629, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aal" - } - }, - { - "id": 2154, - "name": "amr", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication Method References.\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1654, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1707, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - } - ] - } - }, - { - "id": 2152, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1646, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1734, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 2158, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1625, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aud" - } - }, - { - "id": 2147, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1641, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2159, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1626, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.exp" - } - }, - { - "id": 2160, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1627, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iat" - } - }, - { - "id": 2149, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1643, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2156, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1623, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iss" - } - }, - { - "id": 2150, - "name": "jti", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1644, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2151, - "name": "nbf", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1645, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2148, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1642, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2155, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1655, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2161, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1628, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.role" - } - }, - { - "id": 2163, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.session_id" - } - }, - { - "id": 2157, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1624, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.sub" - } - }, - { - "id": 2153, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1647, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1739, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2162, 2154, 2152, 2158, 2147, 2159, 2160, 2149, 2156, 2150, 2151, 2148, 2155, - 2161, 2163, 2157, 2153 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1640, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2164, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1656, - "character": 4 - } - ], - "parameters": [ - { - "id": 2165, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2136, - "name": "RequiredClaims", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1764, - "name": "Subscription", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1766, - "name": "callback", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to call every time there is an event. eg: (eventName) => {}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1767, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 14 - } - ], - "signatures": [ - { - "id": 1768, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 14 - } - ], - "parameters": [ - { - "id": 1769, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1770, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 1765, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for this subscription, set by the client.\nThis is an internal identifier used for managing callbacks and should not be\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 485, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1771, - "name": "unsubscribe", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Call this to remove the listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1772, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 17 - } - ], - "signatures": [ - { - "id": 1773, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1766, 1765, 1771] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 479, - "character": 17 - } - ] - }, - { - "id": 1112, - "name": "TracePropagationOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for trace context propagation.\n\nEnables distributed tracing across Supabase services using W3C Trace Context\nand OpenTelemetry standards. When enabled, the SDK automatically attaches\ntrace context headers (" - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": ") to outgoing\nrequests to Supabase domains. The resulting " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " appears in API\nGateway and Edge Function logs, so logs forwarded through Log Drains can\nbe correlated back to the originating client-side span.\n\nRequires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be installed in the consuming application.\nIf it is not installed, or there is no active context at request time,\npropagation silently no-ops." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Enable with defaults", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true },\n})\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://www.w3.org/TR/trace-context/" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://opentelemetry.io/docs/concepts/context-propagation/" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://supabase.com/docs/guides/telemetry/client-side-tracing" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "children": [ - { - "id": 1113, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable trace propagation. Disabled by default.\n\nWhen enabled, automatically detects and propagates active trace context\nfrom the OpenTelemetry API to outgoing Supabase requests. Trace context\nis only propagated to Supabase domains (" - }, - { - "kind": "code", - "text": "`*.supabase.co`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`*.supabase.in`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`localhost`" - }, - { - "kind": "text", - "text": ") for security — third-party hosts never receive trace headers." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 71, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1114, - "name": "respectSamplingDecision", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Respect upstream sampling decisions.\n\nWhen true (the default), trace context is not propagated if the upstream\ntrace indicates non-sampling (sampled flag = " - }, - { - "kind": "code", - "text": "`0`" - }, - { - "kind": "text", - "text": " in the " - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": "\nheader). This avoids overhead when traces are being recorded but dropped.\n\nSet to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " to always propagate, regardless of the sampling decision\n— useful when you want every Supabase request tagged with a " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": "\nfor log correlation, even if the trace itself will not be exported." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\ntrue\n```" - } - ] - }, - { - "tag": "@example", - "name": "Always propagate, ignore sampling", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L93" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113, 1114] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 53, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L53" - } - ] - }, - { - "id": 1734, - "name": "UserAppMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1735, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The first provider that the user used to sign up with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 339, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1736, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all providers that the user has linked to their account." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 343, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1735, 1736] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 335, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 1737, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 344, - "character": 4 - } - ], - "parameters": [ - { - "id": 1738, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1743, - "name": "UserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1744, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 385, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1749, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 410, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1745, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 389, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1748, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 403, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1747, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1746, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 393, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1744, 1749, 1745, 1748, 1747, 1746] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 377, - "character": 17 - } - ] - }, - { - "id": 1710, - "name": "UserIdentity", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1719, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 297, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1711, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 290, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1713, - "name": "identity_data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 292, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1714, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 292, - "character": 20 - } - ], - "indexSignatures": [ - { - "id": 1715, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 293, - "character": 8 - } - ], - "parameters": [ - { - "id": 1716, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 1717, - "name": "identity_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 295, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1720, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 298, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1718, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 296, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1721, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 299, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1712, - "name": "user_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 291, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1719, 1711, 1713, 1717, 1720, 1718, 1721, 1712] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 289, - "character": 17 - } - ] - }, - { - "id": 1739, - "name": "UserMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 346, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 1740, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 347, - "character": 4 - } - ], - "parameters": [ - { - "id": 1741, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1895, - "name": "VerifyEmailOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1896, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 671, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1899, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 676, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1900, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1902, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 683, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1901, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 678, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1902, 1901] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 676, - "character": 14 - } - ] - } - } - }, - { - "id": 1897, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 673, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1898, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 675, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1896, 1899, 1897, 1898] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 669, - "character": 17 - } - ] - }, - { - "id": 1887, - "name": "VerifyMobileOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1891, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 658, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1892, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1894, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 666, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1893, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 660, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1894, 1893] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 658, - "character": 14 - } - ] - } - } - }, - { - "id": 1888, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 653, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1889, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 655, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1890, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 657, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1906, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1891, 1888, 1889, 1890] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 651, - "character": 17 - } - ] - }, - { - "id": 1903, - "name": "VerifyTokenHashParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1904, - "name": "token_hash", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token hash used in an email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 688, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1905, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 690, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1904, 1905] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 686, - "character": 17 - } - ] - }, - { - "id": 3431, - "name": "WebSocketLike", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3474, - "name": "binaryType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3475, - "name": "bufferedAmount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3435, - "name": "CLOSED", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 5, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3434, - "name": "CLOSING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 4, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3432, - "name": "CONNECTING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 2, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3477, - "name": "dispatchEvent", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3478, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 20 - } - ], - "signatures": [ - { - "id": 3479, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 20 - } - ], - "parameters": [ - { - "id": 3480, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - }, - { - "id": 3476, - "name": "extensions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3456, - "name": "onclose", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3457, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 14 - } - ], - "signatures": [ - { - "id": 3458, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 14 - } - ], - "parameters": [ - { - "id": 3459, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3460, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "CloseEvent" - }, - "name": "CloseEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3461, - "name": "onerror", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 14 - } - ], - "signatures": [ - { - "id": 3463, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 14 - } - ], - "parameters": [ - { - "id": 3464, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3465, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3451, - "name": "onmessage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 16 - } - ], - "signatures": [ - { - "id": 3453, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 16 - } - ], - "parameters": [ - { - "id": 3454, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3455, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "MessageEvent" - }, - "name": "MessageEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3446, - "name": "onopen", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 13 - } - ], - "signatures": [ - { - "id": 3448, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 13 - } - ], - "parameters": [ - { - "id": 3449, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3450, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3433, - "name": "OPEN", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 3, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3438, - "name": "protocol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 8, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3436, - "name": "readyState", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 6, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3437, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 7, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3466, - "name": "addEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 24, - "character": 4 - } - ], - "signatures": [ - { - "id": 3467, - "name": "addEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registers an event listener on the socket (compatible with browser WebSocket API)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 3468, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3469, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3439, - "name": "close", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 12, - "character": 4 - } - ], - "signatures": [ - { - "id": 3440, - "name": "close", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Closes the socket, optionally providing a close code and reason." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 12, - "character": 4 - } - ], - "parameters": [ - { - "id": 3441, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3442, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3470, - "name": "removeEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 28, - "character": 4 - } - ], - "signatures": [ - { - "id": 3471, - "name": "removeEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a previously registered event listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 28, - "character": 4 - } - ], - "parameters": [ - { - "id": 3472, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3473, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3443, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 16, - "character": 4 - } - ], - "signatures": [ - { - "id": 3444, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends data through the socket using the underlying implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 16, - "character": 4 - } - ], - "parameters": [ - { - "id": 3445, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3474, 3475, 3435, 3434, 3432, 3477, 3476, 3456, 3461, 3451, 3446, 3433, 3438, - 3436, 3437 - ] - }, - { - "title": "Methods", - "children": [3466, 3439, 3470, 3443] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 1, - "character": 17 - } - ] - }, - { - "id": 3481, - "name": "WebSocketLikeConstructor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal WebSocket constructor interface that RealtimeClient can work with.\nSupply a compatible implementation (native WebSocket, " - }, - { - "kind": "code", - "text": "`ws`" - }, - { - "kind": "text", - "text": ", etc) when running outside the browser." - } - ] - }, - "children": [ - { - "id": 3482, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 22, - "character": 17 - } - ], - "signatures": [ - { - "id": 3483, - "name": "WebSocketLikeConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 23, - "character": 4 - } - ], - "parameters": [ - { - "id": 3484, - "name": "address", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3485, - "name": "subprotocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 3431, - "name": "WebSocketLike", - "package": "@supabase/realtime-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [3482] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 22, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3486, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 3487, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1705, - "name": "AMRMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 267, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMRMethods" - }, - "name": "AMRMethods", - "package": "@supabase/auth-js", - "preferValues": true - } - } - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1706, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 267, - "character": 64 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1589, - "name": "AuthChangeEvent", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "reference", - "target": 1588, - "name": "AuthChangeEventMFA", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1588, - "name": "AuthChangeEventMFA", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 2018, - "name": "AuthenticatorAssuranceLevels", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 973, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2019, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 973, - "character": 71 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1810, - "name": "AuthFlowType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 562, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1811, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 562, - "character": 59 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2086, - "name": "AuthMFAAdminDeleteFactorParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1424, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2087, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2088, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the MFA factor to delete." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1426, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2089, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user whose factor is being deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1428, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2088, 2089] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1424, - "character": 45 - } - ] - } - } - }, - { - "id": 2083, - "name": "AuthMFAAdminDeleteFactorResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1417, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2084, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2085, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1419, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2085] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1417, - "character": 61 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2093, - "name": "AuthMFAAdminListFactorsParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1440, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2095, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1442, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2095] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1440, - "character": 44 - } - ] - } - } - }, - { - "id": 2090, - "name": "AuthMFAAdminListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1433, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2091, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2092, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All factors attached to the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1435, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2092] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1433, - "character": 60 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2009, - "name": "AuthMFAChallengePhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 922, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponseFields" - }, - "name": "AuthMFAChallengePhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2013, - "name": "AuthMFAChallengeResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 965, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2008, - "name": "AuthMFAChallengeTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2009, - "name": "AuthMFAChallengePhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2010, - "name": "AuthMFAChallengeWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2008, - "name": "AuthMFAChallengeTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 920, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponseFields" - }, - "name": "AuthMFAChallengeTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2010, - "name": "AuthMFAChallengeWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn MFA challenge.\nContains credential creation or request options from the server." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Credential Creation", - "target": "https://w3c.github.io/webauthn/#sctn-credential-creation" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 941, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2011, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable version of WebAuthn challenge response.\nUsed for server communication with base64url-encoded binary fields." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 959, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFieldsJSON" - }, - "name": "AuthMFAChallengeWebauthnResponseFieldsJSON", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2012, - "name": "AuthMFAChallengeWebauthnServerResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server response type for WebAuthn MFA challenge.\nContains JSON-formatted WebAuthn options ready for browser API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 964, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2011, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1609, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponseFields" - }, - "name": "AuthMFAEnrollPhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2004, - "name": "AuthMFAEnrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 906, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1604, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponseFields" - }, - "name": "AuthMFAEnrollTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn factor enrollment.\nReturns the enrolled factor ID and metadata." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1616, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnFields" - }, - "name": "AuthMFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2020, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 974, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2021, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2024, - "name": "currentAuthenticationMethods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario.\n\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 993, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1707, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2022, - "name": "currentLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Current AAL level of the session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 976, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2023, - "name": "nextLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#challenge", - "target": 2035 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 983, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2024, 2022, 2023] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 974, - "character": 74 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2014, - "name": "AuthMFAListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "response of ListFactors, which should contain all the types of factors that are available, this ensures we always include all" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 967, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 2017, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - }, - "default": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2015, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2016, - "name": "all", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All available factors (verified and unverified)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 969, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2016] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 967, - "character": 106 - } - ] - } - }, - { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "reference", - "target": 2017, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2005, - "name": "AuthMFAUnenrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 907, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2006, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2007, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 909, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2007] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 907, - "character": 52 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2003, - "name": "AuthMFAVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for MFA verification operations.\nReturns session tokens on successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 905, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 1996, - "name": "AuthMFAVerifyResponseData", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1996, - "name": "AuthMFAVerifyResponseData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data returned after successful MFA verification.\nContains new session tokens and updated user information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 889, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1997, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1998, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New access token (JWT) after successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 891, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2000, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of seconds in which the access token will expire." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 895, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2001, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Refresh token you can use to obtain new access tokens when expired." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 897, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1999, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of token, always " - }, - { - "kind": "code", - "text": "`bearer`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 893, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 2002, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updated user profile." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 899, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1998, 2000, 2001, 1999, 2002] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 889, - "character": 40 - } - ] - } - } - }, - { - "id": 2382, - "name": "AuthOAuthAuthorizationDetailsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for getting OAuth authorization details.\nReturns either full authorization details (if consent needed) or redirect URL (if already consented).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase.auth.oauth.getAuthorizationDetails(authorizationId)\n\nif (error) {\n console.error('Error:', error)\n} else if ('authorization_id' in data) {\n // User needs to provide consent - show consent page\n console.log('Client:', data.client.name)\n console.log('Scopes:', data.scope)\n console.log('Redirect URI:', data.redirect_uri)\n} else {\n // User already consented - redirect immediately\n window.location.href = data.redirect_url\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2189, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2369, - "name": "OAuthAuthorizationDetails", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2379, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2383, - "name": "AuthOAuthConsentResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth consent decision (approve/deny).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2194, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2379, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2389, - "name": "AuthOAuthGrantsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing user's OAuth grants.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2211, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 2384, - "name": "OAuthGrant", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2390, - "name": "AuthOAuthRevokeGrantResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for revoking an OAuth grant.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2216, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2216, - "character": 57 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1671, - "name": "AuthOtpResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AuthOtpResponse is returned when OTP is used.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "AuthResponse" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 194, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1675, - "name": "messageId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 197, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1674, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 196, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1673, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 195, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1675, 1674, 1673] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 194, - "character": 59 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 2488, - "name": "AuthPasskeyAdminDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2399, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2489, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2491, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2401, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2490, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2400, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2491, 2490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2399, - "character": 43 - } - ] - } - } - }, - { - "id": 2485, - "name": "AuthPasskeyAdminListParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2396, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2486, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2487, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2487] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2396, - "character": 41 - } - ] - } - } - }, - { - "id": 2477, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2388, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2429, - "name": "PasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2389, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2479, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2480, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2390, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2481, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2391, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2480, 2481] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2389, - "character": 68 - } - ] - } - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2484, - "name": "AuthPasskeyDeleteResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2395, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "literal", - "value": null - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2482, - "name": "AuthPasskeyListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2393, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 2438, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2475, - "name": "AuthPasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2386, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2415, - "name": "PasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2387, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2424, - "name": "PasskeyMetadata", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2483, - "name": "AuthPasskeyUpdateResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2394, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2438, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1662, - "name": "AuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 180, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1663, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1665, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 182, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1664, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 181, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1665, 1664] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 180, - "character": 56 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1666, - "name": "AuthResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 184, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1667, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1669, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 186, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1668, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 185, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1670, - "name": "weak_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 187, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1636, - "name": "WeakPassword", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1669, 1668, 1670] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 184, - "character": 64 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1676, - "name": "AuthTokenResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 199, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1677, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1679, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 201, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1678, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 200, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1679, 1678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 199, - "character": 61 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1680, - "name": "AuthTokenResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 203, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1681, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1683, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 205, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1682, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 204, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - }, - { - "id": 1684, - "name": "weakPassword", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1636, - "name": "WeakPassword", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1683, 1682, 1684] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 203, - "character": 69 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 2109, - "name": "CallRefreshTokenResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1531, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2288, - "name": "CreateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new custom provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1938, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2289, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2295, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1950, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2298, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1956, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2299, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1958, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2305, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1970, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2293, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1946, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2294, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1948, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2303, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1966, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2301, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1962, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2300, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1960, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2291, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1942, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2302, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1964, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2308, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1976, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2292, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1944, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2297, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1954, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2290, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1940, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2296, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1952, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2304, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1968, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2306, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1972, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2307, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1974, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2295, 2298, 2299, 2305, 2293, 2294, 2303, 2301, 2300, 2291, 2302, 2308, - 2292, 2297, 2290, 2296, 2304, 2306, 2307 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1938, - "character": 41 - } - ] - } - } - }, - { - "id": 2198, - "name": "CreateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1730, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2199, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2200, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1732, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2201, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1734, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2203, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1738, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2202, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1736, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2204, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types (optional, defaults to code)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1740, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2178, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2205, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1742, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2206, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method (defaults to server default if not specified)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1744, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2200, 2201, 2203, 2202, 2204, 2205, 2206] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1730, - "character": 38 - } - ] - } - } - }, - { - "id": 2264, - "name": "CustomOAuthProvider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom OAuth/OIDC provider object returned from the admin API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1889, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2265, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2271, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1901, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2274, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1907, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2275, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1909, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2281, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1921, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2270, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1899, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2286, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1931, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2285, - "name": "discovery_document", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document (OIDC providers only)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1929, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2252, - "name": "OIDCDiscoveryDocument", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2279, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1917, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2277, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1913, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2276, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1911, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2266, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1891, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2268, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1895, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2278, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1915, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2284, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1927, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2269, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1897, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2273, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1905, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2267, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1893, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2272, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1903, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2280, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1919, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2282, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1923, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2287, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1933, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2283, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1925, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2271, 2274, 2275, 2281, 2270, 2286, 2285, 2279, 2277, 2276, 2266, 2268, - 2278, 2284, 2269, 2273, 2267, 2272, 2280, 2282, 2287, 2283 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1889, - "character": 34 - } - ] - } - } - }, - { - "id": 2332, - "name": "CustomProviderListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2033, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2333, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2334, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2034, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2335, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2336, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2035, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2264, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2336] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2034, - "character": 10 - } - ] - } - } - }, - { - "id": 2337, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2037, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2334, 2337] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2033, - "character": 41 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2339, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2039, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2340, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2341, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2040, - "character": 8 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2341] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2039, - "character": 10 - } - ] - } - } - }, - { - "id": 2342, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2042, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2339, 2342] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2038, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2331, - "name": "CustomProviderResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for custom provider operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2029, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2264, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2251, - "name": "CustomProviderType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of custom identity provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1858, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - } - }, - { - "id": 1122, - "name": "DatabaseWithoutInternals", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strips internal Supabase metadata from Database types.\nUseful for libraries defining generic constraints on Database types." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Stripping internal Supabase metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\ntype CleanDB = DatabaseWithoutInternals\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 320, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L320" - } - ], - "typeParameters": [ - { - "id": 1123, - "name": "DB", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1123, - "name": "DB", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1908, - "name": "EmailOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 693, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 693, - "character": 113 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1867, - "name": "EthereumWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 624, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "EIP1193Provider" - }, - "name": "EIP1193Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1868, - "name": "EthereumWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 625, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1869, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1870, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 626, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1873, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 631, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1874, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1876, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 635, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1877, - "name": "signInWithEthereum", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 636, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "EthereumSignInInput" - }, - "name": "EthereumSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1875, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 633, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1876, 1877, 1875] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 631, - "character": 14 - } - ] - } - } - }, - { - "id": 1872, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1871, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.ethereum`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 628, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1867, - "name": "EthereumWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1870, 1873, 1872, 1871] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 625, - "character": 38 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1878, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1879, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 639, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1880, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Ethereum compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 641, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1882, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 644, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1883, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1884, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 646, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1884] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 644, - "character": 14 - } - ] - } - } - }, - { - "id": 1881, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ethereum curve (secp256k1) signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 643, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "Hex" - }, - "name": "Hex", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1879, 1880, 1882, 1881] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 638, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1632, - "name": "ExperimentalFeatureFlags", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 126, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1633, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1634, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enables passkey support:\n - " - }, - { - "kind": "code", - "text": "`auth.signInWithPasskey()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`auth.registerPasskey()`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.passkey.*`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.admin.passkey.*`" - }, - { - "kind": "text", - "text": "\n\nDefaults to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ". Calling any passkey method while this flag is\ndisabled throws a descriptive error at call time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1634] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 126, - "character": 39 - } - ] - } - } - }, - { - "id": 1723, - "name": "Factor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A MFA factor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 2026 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#listFactors", - "target": 2077 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAAdminApi#listFactors" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 318, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1732, - "name": "Type", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 1722, - "name": "FactorType", - "package": "@supabase/auth-js" - }, - "default": { - "type": "reference", - "target": 1722, - "name": "FactorType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1733, - "name": "Status", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorVerificationStatus" - }, - "name": "FactorVerificationStatus", - "package": "@supabase/auth-js" - }, - "default": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorVerificationStatuses" - }, - "name": "FactorVerificationStatuses", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1724, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1729, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 331, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1727, - "name": "factor_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 326, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1732, - "name": "Type", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1726, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 322, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1725, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 320, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1731, - "name": "last_challenged_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 333, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1728, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification status of the factor, default is " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " after " - }, - { - "kind": "code", - "text": "`.enroll()`" - }, - { - "kind": "text", - "text": ", then " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " after the user verifies it with " - }, - { - "kind": "code", - "text": "`.verify()`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 330, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1733, - "name": "Status", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1730, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 332, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1729, 1727, 1726, 1725, 1731, 1728, 1730] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 318, - "character": 146 - } - ] - } - } - }, - { - "id": 1722, - "name": "FactorType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 305, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 868, - "name": "FunctionInvokeOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 93, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 869, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 876, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 111, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 870, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Object representing the headers to send with the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 97, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 97, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 98, - "character": 8 - } - ], - "parameters": [ - { - "id": 873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 874, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP verb of the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 103, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 875, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Region to invoke the function in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 925, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 877, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 115, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 878, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timeout for the request in milliseconds.\nIf the function takes longer than this, the request will be aborted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [876, 870, 874, 875, 877, 878] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 93, - "character": 36 - } - ] - } - } - }, - { - "id": 1955, - "name": "GenerateEmailChangeLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 760, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1956, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1958, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 763, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1959, - "name": "newEmail", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 767, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1960, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 768, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1957, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 761, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1958, 1959, 1960, 1957] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 760, - "character": 44 - } - ] - } - } - }, - { - "id": 1945, - "name": "GenerateInviteOrMagiclinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 748, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1946, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1948, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 751, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1949, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 752, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1947, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 749, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1948, 1949, 1947] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 748, - "character": 46 - } - ] - } - } - }, - { - "id": 1964, - "name": "GenerateLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 780, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1939, - "name": "GenerateSignupLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1945, - "name": "GenerateInviteOrMagiclinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1950, - "name": "GenerateRecoveryLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1955, - "name": "GenerateEmailChangeLinkParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1969, - "name": "GenerateLinkProperties", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The properties related to the email link generated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 786, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1970, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1971, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 791, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1972, - "name": "email_otp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 796, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1973, - "name": "hashed_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The hashed token appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 800, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1974, - "name": "redirect_to", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 802, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1975, - "name": "verification_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification type that the email link is associated to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 804, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1976, - "name": "GenerateLinkType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1971, 1972, 1973, 1974, 1975] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 786, - "character": 37 - } - ] - } - } - }, - { - "id": 1965, - "name": "GenerateLinkResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 781, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1966, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1967, - "name": "properties", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 782, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1969, - "name": "GenerateLinkProperties", - "package": "@supabase/auth-js" - } - }, - { - "id": 1968, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 783, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1967, 1968] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 781, - "character": 64 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1976, - "name": "GenerateLinkType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 806, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - }, - { - "id": 1950, - "name": "GenerateRecoveryLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 754, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1951, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1953, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 757, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1954, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 758, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1952, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 755, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1953, 1954, 1952] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 754, - "character": 41 - } - ] - } - } - }, - { - "id": 1939, - "name": "GenerateSignupLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 742, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1940, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1942, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 744, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1944, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 746, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1943, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 745, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1941, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 743, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1942, 1944, 1943, 1941] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 742, - "character": 39 - } - ] - } - } - }, - { - "id": 1599, - "name": "GoTrueClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 32, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1600, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1615, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 61, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1621, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 74, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 74, - "character": 23 - } - ], - "signatures": [ - { - "id": 1623, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1624, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1625, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - }, - { - "id": 1607, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if you want to automatically detect OAuth grants in the URL and sign in the user.\nSet to \"false\" to disable automatic detection.\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\nThe function receives the current URL and parsed parameters, and should return true if the URL\nshould be processed as a Supabase auth callback, or false to ignore it.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1608, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 36 - } - ], - "signatures": [ - { - "id": 1609, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1610, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1611, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1612, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 55 - } - ], - "indexSignatures": [ - { - "id": 1613, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 59, - "character": 8 - } - ], - "parameters": [ - { - "id": 1614, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1631, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 124, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1619, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 72, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/fetch.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/auth-js" - } - }, - { - "id": 1620, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 73, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1810, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1627, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if there is a custom authorization header set globally." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 93, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1602, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1603, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 34, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 1604, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 35, - "character": 8 - } - ], - "parameters": [ - { - "id": 1605, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1626, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe client coordinates refreshes itself (single-flight via\n" - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " + commit guard) and relies on the GoTrue server to\nresolve cross-tab refresh races. Passing a custom lock opts into a\nlegacy path that wraps every auth operation in your supplied lock — this\npath is preserved for backwards compatibility (typically React Native\n" - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": " or Node multi-process setups)." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\nconstructor options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 88, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1590, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - }, - { - "id": 1629, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option. Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is\npassed — the default lockless path doesn't use this timeout." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1616, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1630, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in constructor. Useful for SSR\ncontexts where initialization timing must be controlled to prevent race\nconditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 117, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1617, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 1606, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 37, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1628, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 98, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1601, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 33, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1618, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " - }, - { - "kind": "code", - "text": "`storage`" - }, - { - "kind": "text", - "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " - }, - { - "kind": "code", - "text": "`userStorage`" - }, - { - "kind": "text", - "text": " will only contain the user object under the key " - }, - { - "kind": "code", - "text": "`storageKey + '-user'`" - }, - { - "kind": "text", - "text": ".\n\nWhen this option is set and cookie storage is used, " - }, - { - "kind": "code", - "text": "`getSession()`" - }, - { - "kind": "text", - "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch a user object in those scenarios." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 71, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1615, 1621, 1607, 1631, 1619, 1620, 1627, 1602, 1626, 1629, 1616, 1630, - 1617, 1606, 1628, 1601, 1618 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 32, - "character": 34 - } - ] - } - } - }, - { - "id": 2106, - "name": "InitializeResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1528, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2107, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2108, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1529, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2108] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1528, - "character": 31 - } - ] - } - } - }, - { - "id": 2130, - "name": "JwtHeader", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1617, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2132, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1618, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "RS256" - }, - { - "type": "literal", - "value": "ES256" - }, - { - "type": "literal", - "value": "HS256" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2133, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1618, - "character": 49 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2134, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1619, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2135, - "name": "typ", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1620, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2132, 2134, 2135] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1617, - "character": 24 - } - ] - } - } - }, - { - "id": 2328, - "name": "ListCustomProvidersParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2022, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2330, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2024, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2330] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2022, - "character": 40 - } - ] - } - } - }, - { - "id": 1590, - "name": "LockFunc", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": " async function, such that no other client instances will be able to\nhold it at the same time." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1591, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 23 - } - ], - "signatures": [ - { - "id": 1592, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameters": [ - { - "id": 1598, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1593, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1594, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1595, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to execute when the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 69 - } - ], - "signatures": [ - { - "id": 1597, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1995, - "name": "MFAChallengeAndVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 884, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - }, - { - "id": 1994, - "name": "MFAChallengeParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 880, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1991, - "name": "MFAChallengeTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1992, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1993, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1992, - "name": "MFAChallengePhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 864, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParamFields" - }, - "name": "MFAChallengePhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1991, - "name": "MFAChallengeTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 859, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1993, - "name": "MFAChallengeWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for initiating a WebAuthn MFA challenge.\nIncludes Relying Party information needed for WebAuthn ceremonies." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Relying Party Operations", - "target": "https://w3c.github.io/webauthn/#sctn-rp-operations" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 879, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParamFields" - }, - "name": "MFAChallengeWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1977, - "name": "MFAEnrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 807, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2124, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2125, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2126, - "name": "MFAEnrollWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2125, - "name": "MFAEnrollPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1572, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParamFields" - }, - "name": "MFAEnrollPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2124, - "name": "MFAEnrollTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1567, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParamFields" - }, - "name": "MFAEnrollTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2126, - "name": "MFAEnrollWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for enrolling a WebAuthn factor.\nCreates an unverified WebAuthn factor that must be verified with a credential." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1579, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnFields" - }, - "name": "MFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1990, - "name": "MFATOTPChannel", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 858, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFATOTPChannels" - }, - "name": "MFATOTPChannels", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1978, - "name": "MFAUnenrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 808, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1979, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1980, - "name": "factorId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor being unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 810, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1980] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 808, - "character": 32 - } - ] - } - } - }, - { - "id": 1989, - "name": "MFAVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 852, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1981, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1982, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1987, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1982, - "name": "MFAVerifyPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 824, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParamFields" - }, - "name": "MFAVerifyPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1981, - "name": "MFAVerifyTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 822, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParamFields" - }, - "name": "MFAVerifyTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1983, - "name": "MFAVerifyWebauthnParamFields", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "WebAuthn-specific fields for MFA verification.\nSupports both credential creation (registration) and request (authentication) flows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 842, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1986, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1984, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1985, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 843, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFieldsBase" - }, - "name": "MFAVerifyWebauthnParamFieldsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnCredentialParamFields" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1986, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnCredentialParamFields", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1985] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 842, - "character": 98 - } - ] - } - } - }, - { - "id": 1987, - "name": "MFAVerifyWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for WebAuthn MFA verification.\nUsed to verify WebAuthn credentials after challenge." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Verifying an Authentication Assertion", - "target": "https://w3c.github.io/webauthn/#sctn-verifying-assertion" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 851, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1988, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1983, - "typeArguments": [ - { - "type": "reference", - "target": 1988, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1906, - "name": "MobileOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 692, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1907, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 692, - "character": 63 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2363, - "name": "OAuthAuthorizationClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client details in an authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2112, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2364, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2365, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2368, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2366, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2367, - "name": "uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's website" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2118, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2365, 2368, 2366, 2367] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2112, - "character": 39 - } - ] - } - } - }, - { - "id": 2369, - "name": "OAuthAuthorizationDetails", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth authorization details when user needs to provide consent.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response includes all information needed to display a consent page:\nclient details, user info, requested scopes, and where the user will be redirected.\n\nNote: " - }, - { - "kind": "code", - "text": "`redirect_uri`" - }, - { - "kind": "text", - "text": " is the base URI (e.g., \"https://app.com/callback\") without\nquery parameters. After consent, you'll receive a complete " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " with\nthe authorization code and state parameters appended." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2133, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2370, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2371, - "name": "authorization_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID used to approve or deny the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2373, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client requesting authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2139, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2363, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 2372, - "name": "redirect_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client's registered redirect URI (base URI without query parameters)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2378, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Space-separated list of requested scopes (e.g., \"openid profile email\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2148, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2374, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User object associated with the authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2141, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2375, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2377, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2145, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2376, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User ID (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2143, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2377, 2376] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2141, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2371, 2373, 2372, 2378, 2374] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2133, - "character": 40 - } - ] - } - } - }, - { - "id": 2182, - "name": "OAuthClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client object returned from the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1696, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2183, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2184, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1698, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2185, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1700, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2186, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client secret (only returned on registration and regeneration)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1702, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2187, - "name": "client_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1704, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2179, - "name": "OAuthClientType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2190, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1710, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2196, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2193, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1716, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2191, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1712, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2192, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1714, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2189, - "name": "registration_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registration type of the client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1708, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2180, - "name": "OAuthClientRegistrationType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2194, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1718, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2178, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2195, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2188, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1706, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 2197, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1724, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2184, 2185, 2186, 2187, 2190, 2196, 2193, 2191, 2192, 2189, 2194, 2195, - 2188, 2197 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1696, - "character": 26 - } - ] - } - } - }, - { - "id": 2176, - "name": "OAuthClientGrantType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client grant types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1671, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2177, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1671, - "character": 86 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2216, - "name": "OAuthClientListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing OAuth clients.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1774, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2217, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2218, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1775, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2219, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2221, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1777, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2220, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1776, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2182, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2221, 2220] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1775, - "character": 10 - } - ] - } - }, - { - "type": "reference", - "target": 2110, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2222, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1779, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2218, 2222] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1774, - "character": 38 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2223, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2224, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1781, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2225, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2226, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1782, - "character": 8 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2226] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1781, - "character": 10 - } - ] - } - } - }, - { - "id": 2227, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1784, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2224, 2227] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1780, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2180, - "name": "OAuthClientRegistrationType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client registration type.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1686, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - } - }, - { - "id": 2215, - "name": "OAuthClientResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth client operations.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1769, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2182, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2178, - "name": "OAuthClientResponseType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client response types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1676, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "code" - } - }, - { - "id": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client token endpoint authentication method.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1691, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - } - }, - { - "id": 2179, - "name": "OAuthClientType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client type indicating whether the client can keep credentials confidential.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1681, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - } - }, - { - "id": 2384, - "name": "OAuthGrant", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An OAuth grant representing a user's authorization of an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2199, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2386, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client information" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2201, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2363, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 2388, - "name": "granted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the grant was created (ISO 8601 date-time)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2205, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2387, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of scopes granted to this client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2203, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2386, 2388, 2387] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2199, - "character": 25 - } - ] - } - } - }, - { - "id": 2379, - "name": "OAuthRedirect", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth redirect response when user has already consented or after consent decision.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response is returned in three scenarios:\n1. User already consented to these scopes (auto-approved)\n2. User just approved the authorization request\n3. User just denied the authorization request\n\nThe " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " is a complete URL ready for redirecting the user back to the\nOAuth client, including authorization code (on success) or error (on denial) in\nquery parameters, along with the state parameter if one was provided." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2163, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2380, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2381, - "name": "redirect_url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Complete redirect URL with authorization code and state parameters (e.g., \"https://app.com/callback?code=xxx&state=yyy\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2165, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2381] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2163, - "character": 28 - } - ] - } - } - }, - { - "id": 1685, - "name": "OAuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 208, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1686, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1687, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 209, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1688, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1689, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 210, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1690, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 211, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1689, 1690] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 209, - "character": 10 - } - ] - } - } - }, - { - "id": 1691, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 213, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1687, 1691] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 208, - "character": 28 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1692, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1693, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 215, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1694, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1695, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 216, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1696, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 217, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1695, 1696] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 215, - "character": 10 - } - ] - } - } - }, - { - "id": 1697, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 219, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1693, 1697] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 214, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2252, - "name": "OIDCDiscoveryDocument", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document fields.\nPopulated when the server successfully fetches and validates the\nprovider's OpenID Connect discovery document." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1864, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2253, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2255, - "name": "authorization_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the authorization endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1868, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2254, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The issuer identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1866, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2257, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the JSON Web Key Set" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1872, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2259, - "name": "revocation_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the revocation endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1876, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2263, - "name": "supported_id_token_signing_algs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported ID token signing algorithms" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1884, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2261, - "name": "supported_response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1880, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2260, - "name": "supported_scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported scopes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1878, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2262, - "name": "supported_subject_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported subject types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1882, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2256, - "name": "token_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the token endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1870, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2258, - "name": "userinfo_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the userinfo endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1874, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2255, 2254, 2257, 2259, 2263, 2261, 2260, 2262, 2256, 2258] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1864, - "character": 36 - } - ] - } - } - }, - { - "id": 2117, - "name": "PageParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1538, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2119, - "name": "page", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The page number" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1540, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2120, - "name": "perPage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items returned per page" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1542, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2119, 2120] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1538, - "character": 25 - } - ] - } - } - }, - { - "id": 2110, - "name": "Pagination", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1532, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2113, - "name": "lastPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1535, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2112, - "name": "nextPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1534, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2114, - "name": "total", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1536, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2113, 2112, 2114] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1532, - "character": 25 - } - ], - "indexSignatures": [ - { - "id": 2115, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1533, - "character": 4 - } - ], - "parameters": [ - { - "id": 2116, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 2429, - "name": "PasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/authentication/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2331, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2430, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2431, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2332, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2433, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2334, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2432, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2333, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialRequestOptions" - }, - "name": "ServerCredentialRequestOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2431, 2433, 2432] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2331, - "character": 51 - } - ] - } - } - }, - { - "id": 2434, - "name": "PasskeyAuthenticationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/authentication/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2337, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2435, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2436, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2338, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2437, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2339, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.dom.ts", - "qualifiedName": "AuthenticationResponseJSON" - }, - "name": "AuthenticationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2436, 2437] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2337, - "character": 48 - } - ] - } - } - }, - { - "id": 2472, - "name": "PasskeyDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2382, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2473, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2474, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to delete" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2384, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2474] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2382, - "character": 34 - } - ] - } - } - }, - { - "id": 2438, - "name": "PasskeyListItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Item in the passkeys list (GET /passkeys/ and admin list)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2342, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2439, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2442, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2345, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2441, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2344, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2440, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2343, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2443, - "name": "last_used_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2346, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2442, 2441, 2440, 2443] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2342, - "character": 30 - } - ] - } - } - }, - { - "id": 2424, - "name": "PasskeyMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2325, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2425, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2428, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2328, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2427, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2327, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2426, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2326, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2428, 2427, 2426] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2325, - "character": 30 - } - ] - } - } - }, - { - "id": 2415, - "name": "PasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2314, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2416, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2417, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2315, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2419, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2317, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2418, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2316, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialCreationOptions" - }, - "name": "ServerCredentialCreationOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2417, 2419, 2418] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2314, - "character": 49 - } - ] - } - } - }, - { - "id": 2420, - "name": "PasskeyRegistrationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2320, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2421, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2422, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2321, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2423, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2322, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.dom.ts", - "qualifiedName": "RegistrationResponseJSON" - }, - "name": "RegistrationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2422, 2423] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2320, - "character": 46 - } - ] - } - } - }, - { - "id": 2468, - "name": "PasskeyUpdateParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2376, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2469, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2471, - "name": "friendlyName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New friendly name (max 120 chars)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2380, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2470, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2378, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2471, 2470] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2376, - "character": 34 - } - ] - } - } - }, - { - "id": 55, - "name": "PostgrestMaybeSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 641, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 56, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 56, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 51, - "name": "PostgrestResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 642, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 52, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 52, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 53, - "name": "PostgrestSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 640, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 54, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 54, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseFailure" - }, - "name": "PostgrestResponseFailure", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 1640, - "name": "Prettify", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resolve mapped types and show the derived keys and their types when hovering in\nVS Code, instead of just showing the names those mapped types are defined with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1641, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - } - }, - { - "id": 1587, - "name": "Provider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue. Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ], - "elementSummaries": [ - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [ - { - "kind": "text", - "text": "Uses OAuth 1.0a" - } - ], - [ - { - "kind": "text", - "text": "Uses OAuth 2.0" - } - ], - [], - [], - [], - [] - ] - } - }, - { - "id": 1117, - "name": "QueryData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ], - "typeParameters": [ - { - "id": 1120, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1120, - "name": "T", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1119, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "inferred", - "name": "U" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1119] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ] - } - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "U" - }, - "name": "U", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ], - "name": "Exclude", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 1121, - "name": "QueryError", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 309, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L309" - } - ], - "type": { - "type": "reference", - "target": 830, - "name": "PostgrestError", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 1115, - "name": "QueryResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper types for query results." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 307, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L307" - } - ], - "typeParameters": [ - { - "id": 1116, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1116, - "name": "T", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "inferred", - "name": "U" - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "U" - }, - "name": "U", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 3136, - "name": "RealtimeChannelOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3137, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3138, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 12, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3140, - "name": "broadcast", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received\nreplay option instructs server to replay broadcast messages" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 18, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3143, - "name": "ack", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 20, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3144, - "name": "replay", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 21, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "ReplayOption" - }, - "name": "ReplayOption", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3142, - "name": "self", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 19, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3143, 3144, 3142] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 18, - "character": 20 - } - ] - } - } - }, - { - "id": 3145, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "key option is used to track presence payload across clients" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3146, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3148, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 28, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3147, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 27, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3148, 3147] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 26, - "character": 19 - } - ] - } - } - }, - { - "id": 3149, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "defines if the channel is private or not and if RLS policies will be used to check data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3140, 3145, 3149] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 12, - "character": 12 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3138] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 11, - "character": 37 - } - ] - } - } - }, - { - "id": 3150, - "name": "RealtimeChannelSendResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 115, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 3151, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 115, - "character": 83 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 3273, - "name": "RealtimeClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 26, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3274, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3309, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 47, - "character": 18 - } - ], - "signatures": [ - { - "id": 3311, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 3291, - "name": "decode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - }, - { - "id": 3312, - "name": "disconnectOnEmptyChannelsAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 48, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3290, - "name": "encode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 33, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - }, - { - "id": 3306, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3296, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 36, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3297, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 36, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3298, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 37, - "character": 8 - } - ], - "parameters": [ - { - "id": 3299, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3278, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3279, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 30, - "character": 24 - } - ], - "signatures": [ - { - "id": 3280, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3281, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "HeartbeatStatus" - }, - "name": "HeartbeatStatus", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3282, - "name": "latency", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3277, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3304, - "name": "log_level", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 42, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3284, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 32, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3285, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 32, - "character": 13 - } - ], - "signatures": [ - { - "id": 3286, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3287, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3288, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3289, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3305, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3300, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 39, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3301, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 39, - "character": 13 - } - ], - "indexSignatures": [ - { - "id": 3302, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 40, - "character": 8 - } - ], - "parameters": [ - { - "id": 3303, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 3292, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 35, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3293, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 35, - "character": 23 - } - ], - "signatures": [ - { - "id": 3294, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3295, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - }, - { - "id": 3313, - "name": "sessionStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage compatible object used by the underlying socket for longpoll fallback history.\nProvide a custom implementation in environments where reading " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": "\nthrows (sandboxed iframes, in-app webviews, \"block third-party storage\" privacy modes).\nDefaults to " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": " when accessible, otherwise an in-memory store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 55, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - } - }, - { - "id": 3276, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 28, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3275, - "name": "transport", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 27, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3481, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3283, - "name": "vsn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3307, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3308, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 46, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3309, 3291, 3312, 3290, 3306, 3296, 3278, 3277, 3304, 3284, 3305, 3300, - 3292, 3313, 3276, 3275, 3283, 3307, 3308 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 26, - "character": 36 - } - ] - } - } - }, - { - "id": 3314, - "name": "RealtimeMessage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3315, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3317, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 10, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3320, - "name": "join_ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3318, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 11, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3319, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 12, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3316, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 9, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3317, 3320, 3318, 3319, 3316] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 8, - "character": 30 - } - ] - } - } - }, - { - "id": 3321, - "name": "RealtimePostgresChangesFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 97, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3327, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3398, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3322, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3323, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of database change to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 101, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3327, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3326, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive database changes when filter is matched." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 113, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3324, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database schema to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3325, - "name": "table", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database table to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3323, 3326, 3324, 3325] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 97, - "character": 99 - } - ] - } - } - }, - { - "id": 3328, - "name": "RealtimePostgresChangesPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 94, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3329, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3330, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 94, - "character": 53 - } - ], - "indexSignatures": [ - { - "id": 3331, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 95, - "character": 4 - } - ], - "parameters": [ - { - "id": 3332, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3333, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3343, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3352, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 3352, - "name": "RealtimePostgresDeletePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 87, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3358, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3359, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 87, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3360, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 88, - "character": 4 - } - ], - "parameters": [ - { - "id": 3361, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3353, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3354, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 90, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3402, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3355, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 91, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3356, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 91, - "character": 9 - } - ] - } - } - }, - { - "id": 3357, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 92, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3358, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3354, 3355, 3357] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 89, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3333, - "name": "RealtimePostgresInsertPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 73, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3339, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3340, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 73, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3341, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 74, - "character": 4 - } - ], - "parameters": [ - { - "id": 3342, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3334, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3335, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 76, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3400, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3336, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3339, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3337, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 78, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3335, 3336, 3337] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 75, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3343, - "name": "RealtimePostgresUpdatePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 80, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3348, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3349, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 80, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3350, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 81, - "character": 4 - } - ], - "parameters": [ - { - "id": 3351, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3344, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3345, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 83, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3401, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3346, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 84, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3348, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3347, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 85, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3348, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3345, 3346, 3347] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 82, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3362, - "name": "RealtimePresenceJoinPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 12, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3368, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3369, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 12, - "character": 50 - } - ], - "indexSignatures": [ - { - "id": 3370, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 13, - "character": 4 - } - ], - "parameters": [ - { - "id": 3371, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3363, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3366, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3368, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3364, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 15, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3405, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3365, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 16, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3367, - "name": "newPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3368, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3366, 3364, 3365, 3367] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 14, - "character": 5 - } - ] - } - } - }, - { - "id": 3372, - "name": "RealtimePresenceLeavePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 20, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3378, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 20, - "character": 51 - } - ], - "indexSignatures": [ - { - "id": 3380, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 21, - "character": 4 - } - ], - "parameters": [ - { - "id": 3381, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3373, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3376, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3378, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3374, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3406, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3375, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 24, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3377, - "name": "leftPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3378, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3376, 3374, 3375, 3377] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 22, - "character": 5 - } - ] - } - } - }, - { - "id": 3382, - "name": "RealtimePresenceState", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 7, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3386, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3387, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 7, - "character": 44 - } - ], - "indexSignatures": [ - { - "id": 3388, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 8, - "character": 4 - } - ], - "parameters": [ - { - "id": 3389, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 3390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 9, - "character": 4 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3383, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 9, - "character": 10 - } - ], - "indexSignatures": [ - { - "id": 3384, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 10, - "character": 4 - } - ], - "parameters": [ - { - "id": 3385, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3386, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ] - } - } - }, - { - "id": 3391, - "name": "RealtimeRemoveChannelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 3392, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 15, - "character": 85 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2450, - "name": "RegisterPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2354, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2451, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2452, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2355, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2453, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2454, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2356, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2454] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2355, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2452] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2354, - "character": 41 - } - ] - } - } - }, - { - "id": 1645, - "name": "RequestResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "a shared result type that encapsulates errors instead of throwing them, allows you to optionally specify the ErrorType" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 160, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1652, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 1653, - "name": "ErrorType", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "default": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1646, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1647, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1652, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1648, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1647, 1648] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 160, - "character": 68 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1649, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1650, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1651, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "extendsType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "trueType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "falseType": { - "type": "reference", - "target": 1653, - "name": "ErrorType", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1650, 1651] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 163, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1654, - "name": "RequestResultSafeDestructure", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "similar to RequestResult except it allows you to destructure the possible shape of the success response\n " - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "RequestResult" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 171, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1661, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1655, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1656, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 172, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1657, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 173, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1656, 1657] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 171, - "character": 46 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1658, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1659, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 175, - "character": 4 - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "object" - }, - "trueType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "literal", - "value": null - } - }, - "falseType": { - "type": "literal", - "value": null - } - } - }, - { - "id": 1660, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 178, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1659, 1660] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 174, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2136, - "name": "RequiredClaims", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1622, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2137, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2144, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1629, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - } - }, - { - "id": 2140, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1625, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2141, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1626, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2142, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1627, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2138, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1623, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2143, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1628, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2145, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2139, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1624, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2144, 2140, 2141, 2142, 2138, 2143, 2145, 2139] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1622, - "character": 29 - } - ] - } - }, - "extendedBy": [ - { - "type": "reference", - "target": 2146, - "name": "JwtPayload" - } - ] - }, - { - "id": 1910, - "name": "ResendParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 694, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1911, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1913, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 696, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1914, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 697, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1915, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1917, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 701, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1916, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 699, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1917, 1916] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 697, - "character": 14 - } - ] - } - } - }, - { - "id": 1912, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 695, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1913, 1914, 1912] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 694, - "character": 27 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1918, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1921, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 706, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1923, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 708, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1923] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 706, - "character": 14 - } - ] - } - } - }, - { - "id": 1920, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 705, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1919, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 704, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1906, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1921, 1920, 1919] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 703, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1774, - "name": "SignInAnonymouslyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 495, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1776, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 496, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1777, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1779, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 504, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1778, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 502, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1779, 1778] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 496, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1776] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 495, - "character": 43 - } - ] - } - } - }, - { - "id": 1824, - "name": "SignInWithIdTokenCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 579, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1825, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1829, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 585, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1830, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 587, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1831, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 588, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1832, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1833, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 590, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1833] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 588, - "character": 14 - } - ] - } - } - }, - { - "id": 1826, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider name or OIDC " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " value identifying which provider should be used to verify the provided token. Supported names: " - }, - { - "kind": "code", - "text": "`google`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`apple`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`azure`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`facebook`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`kakao`" - }, - { - "kind": "text", - "text": ". Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 581, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1827, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 581, - "character": 99 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1828, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC ID token issued by the specified provider. The " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " which require that you provide an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " value to be accepted properly. If the token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim you must supply the nonce used to obtain the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 583, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1829, 1830, 1831, 1826, 1828] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 579, - "character": 43 - } - ] - } - } - }, - { - "id": 1812, - "name": "SignInWithOAuthCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 563, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1813, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1815, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 566, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1819, - "name": "queryParams", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object of query params" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 572, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1820, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 572, - "character": 22 - } - ], - "indexSignatures": [ - { - "id": 1821, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 573, - "character": 12 - } - ], - "parameters": [ - { - "id": 1822, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1817, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 568, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1818, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A space-separated list of scopes granted to the OAuth application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 570, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1823, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 576, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1819, 1817, 1818, 1823] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 566, - "character": 14 - } - ] - } - } - }, - { - "id": 1814, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 565, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1815, 1814] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 563, - "character": 41 - } - ] - } - } - }, - { - "id": 2444, - "name": "SignInWithPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2348, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2446, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2349, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2448, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2449, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2351, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2448, 2449] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2349, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2446] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2348, - "character": 43 - } - ] - } - } - }, - { - "id": 1788, - "name": "SignInWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 522, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1789, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1790, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 523, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1791, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1792, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 524, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1792] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 523, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1790] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 522, - "character": 70 - } - ] - } - } - ] - } - }, - { - "id": 1793, - "name": "SignInWithPasswordlessCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 527, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1795, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 529, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1796, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 530, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1797, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1801, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 542, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1800, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 540, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1798, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The redirect url embedded in the email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 532, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1799, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 534, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1801, 1800, 1798, 1799] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 530, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1795, 1796] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 527, - "character": 48 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1802, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1804, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 547, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1805, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1808, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 557, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1809, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Messaging channel to use (e.g. whatsapp or sms)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 559, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 1807, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 555, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1806, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 549, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1808, 1809, 1807, 1806] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 547, - "character": 14 - } - ] - } - } - }, - { - "id": 1803, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 546, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1804, 1803] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 544, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1924, - "name": "SignInWithSSO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 711, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1925, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1927, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1928, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1930, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 718, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1929, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 716, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1931, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 724, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1930, 1929, 1931] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 714, - "character": 14 - } - ] - } - } - }, - { - "id": 1926, - "name": "providerId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the SSO provider to invoke single-sign on to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1927, 1926] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 711, - "character": 28 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1932, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1933, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Domain name of the organization for which to invoke single-sign on." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 728, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1934, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 729, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1935, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1937, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 733, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1936, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 731, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1938, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 739, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1937, 1936, 1938] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 729, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1933, 1934] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 726, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2121, - "name": "SignOut", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1544, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2122, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2123, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1555, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2123] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1544, - "character": 22 - } - ] - } - } - }, - { - "id": 2175, - "name": "SignOutScope", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1666, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": 2174, - "name": "SIGN_OUT_SCOPES", - "package": "@supabase/auth-js" - } - } - } - }, - { - "id": 1780, - "name": "SignUpWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 507, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1781, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1782, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 508, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1783, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1786, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 511, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1787, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 512, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 1785, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 510, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1784, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 509, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1786, 1787, 1785, 1784] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 508, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1782] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 507, - "character": 70 - } - ] - } - } - ] - } - }, - { - "id": 1834, - "name": "SolanaWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 593, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1835, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1840, - "name": "publicKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 595, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1841, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1842, - "name": "toBase58", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 596, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 596, - "character": 18 - } - ], - "signatures": [ - { - "id": 1844, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1842] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 595, - "character": 16 - } - ] - } - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1836, - "name": "signIn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 594, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1837, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 594, - "character": 13 - } - ], - "signatures": [ - { - "id": 1838, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1839, - "name": "inputs", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1845, - "name": "signMessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 598, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1846, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 598, - "character": 18 - } - ], - "signatures": [ - { - "id": 1847, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1848, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - }, - { - "id": 1849, - "name": "encoding", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "utf8" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1840, 1836, 1845] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 593, - "character": 27 - } - ] - } - } - }, - { - "id": 1850, - "name": "SolanaWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 600, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1852, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 601, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1855, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 606, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1856, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1858, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 610, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1859, - "name": "signInWithSolana", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 611, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "chain" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1857, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 608, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1858, 1859, 1857] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 606, - "character": 14 - } - ] - } - } - }, - { - "id": 1854, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 605, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1853, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.solana`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 603, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1834, - "name": "SolanaWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1852, 1855, 1854, 1853] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 600, - "character": 36 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1861, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 614, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1862, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Solana compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 616, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1864, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 619, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1865, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1866, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 621, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 619, - "character": 14 - } - ] - } - } - }, - { - "id": 1863, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ed25519 signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 618, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1861, 1862, 1864, 1863] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 613, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1698, - "name": "SSOResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 221, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1699, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1700, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " - }, - { - "kind": "code", - "text": "`window.location.href`" - }, - { - "kind": "text", - "text": " to take\nthe user to the authentication flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 229, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1700] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 221, - "character": 40 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2459, - "name": "StartPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2365, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2461, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2366, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2463, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2367, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2463] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2366, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2461] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2365, - "character": 47 - } - ] - } - } - }, - { - "id": 1642, - "name": "StrictOmit", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A stricter version of TypeScript's Omit that only allows omitting keys that actually exist.\nThis prevents typos and ensures type safety at compile time.\nUnlike regular Omit, this will error if you try to omit a non-existent key." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 156, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1643, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 1644, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1643, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1643, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1644, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1072, - "name": "SupabaseClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 96, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L96" - } - ], - "typeParameters": [ - { - "id": 1111, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1107, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth SDK. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the SDKs.\n\nWhen set, the " - }, - { - "kind": "code", - "text": "`auth`" - }, - { - "kind": "text", - "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 252, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L252" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 252, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L252" - } - ], - "signatures": [ - { - "id": 1109, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 1079, - "name": "auth", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L129" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1080, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1081, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Automatically refreshes the token for logged-in users. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 133, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L133" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1095, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 183, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L183" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "debug" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1084, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true.\n\nCan be set to a function to provide custom logic for determining if a URL contains\na Supabase auth callback. The function receives the current URL and parsed parameters,\nand should return true if the URL should be processed as a Supabase auth callback.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that\nalso return access_token in the URL fragment, which would otherwise be incorrectly\nintercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With custom detection logic", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1085, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "signatures": [ - { - "id": 1086, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1087, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1088, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1089, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "indexSignatures": [ - { - "id": 1090, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "parameters": [ - { - "id": 1091, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1098, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 206, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L206" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "experimental" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1094, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 179, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L179" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "flowType" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1096, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe auth client coordinates refreshes itself and the server resolves\ncross-tab races. Passing a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " opts into a legacy path that\nwraps every auth operation in your supplied lock." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\n" - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 194, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L194" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lock" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1099, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": ". Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is passed." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 216, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L216" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lockAcquireTimeout" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1083, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to persist a logged-in session to storage. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 141, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L141" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1100, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in the auth client constructor.\nUseful for SSR contexts where initialization timing must be controlled to\nprevent race conditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 224, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L224" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "skipAutoInitialize" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1092, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A storage provider. Used to store the logged-in session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 167, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L167" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1082, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional key name used for storing tokens in local storage." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 137, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L137" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1097, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 199, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "throwOnError" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1093, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 175, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L175" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "userStorage" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1081, 1095, 1084, 1098, 1094, 1096, 1099, 1083, 1100, 1092, 1082, - 1097, 1093 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 129, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L129" - } - ] - } - } - }, - { - "id": 1074, - "name": "db", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 100, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L100" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1075, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1076, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 101, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L101" - } - ], - "type": { - "type": "reference", - "target": 1111, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "id": 1077, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout in milliseconds for PostgREST requests.\nWhen set, requests will automatically abort after this duration to prevent indefinite hangs." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n db: { timeout: 30000 } // 30 second timeout\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 113, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1078, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length in characters before warnings/errors are triggered.\nDefaults to 8000 characters. Used to provide helpful hints when URLs\nexceed server limits." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With custom URL length limit", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n db: { urlLengthLimit: 10000 } // Custom limit\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1076, 1077, 1078] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 100, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L100" - } - ] - } - } - }, - { - "id": 1103, - "name": "global", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 231, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L231" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1105, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L235" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/supabase-js" - } - }, - { - "id": 1106, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional headers for initializing the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 239, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L239" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1105, 1106] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 231, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L231" - } - ] - } - } - }, - { - "id": 1101, - "name": "realtime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options passed to the realtime-js instance" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L229" - } - ], - "type": { - "type": "reference", - "target": 3273, - "name": "RealtimeClientOptions", - "package": "@supabase/realtime-js" - } - }, - { - "id": 1102, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 230, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L230" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageClientOptions" - }, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - }, - { - "id": 1110, - "name": "tracePropagation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable OpenTelemetry / W3C trace context propagation to Supabase services.\n\nDisabled by default. Pass " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " for the common case (auto-detect an\nactive OpenTelemetry context and inject " - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": " /\n" - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": " headers) or an object for fine-grained control.\n\nRequires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be installed in your application; if\nnot present, the SDK silently no-ops. Trace headers are only attached\nto requests targeting Supabase domains, so third-party hosts called\nthrough a custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " are never tagged.\n\nThe resulting " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " appears in Supabase logs (API Gateway, Edge\nFunctions), letting you correlate client-side spans with server-side\nlog entries — including logs forwarded via Log Drains." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Shorthand — opt in with defaults", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient(url, key, { tracePropagation: true })\n```" - } - ] - }, - { - "tag": "@example", - "name": "With an active OpenTelemetry span", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient(url, key, { tracePropagation: true })\nconst tracer = trace.getTracer('my-app')\n\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // Request carries the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Advanced — always propagate, even for non-sampled traces", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://supabase.com/docs/guides/telemetry/client-side-tracing" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://www.w3.org/TR/trace-context/" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1112, - "name": "TracePropagationOptions", - "package": "@supabase/supabase-js" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1107, 1079, 1074, 1103, 1101, 1102, 1110] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 96, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L96" - } - ] - } - } - }, - { - "id": 2103, - "name": "SupportedStorage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1518, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PromisifyMethods" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "PromisifyMethods", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 2104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2105, - "name": "isServer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1526, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2105] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1518, - "character": 103 - } - ] - } - } - ] - } - }, - { - "id": 2309, - "name": "UpdateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing custom provider.\nAll fields are optional. Only provided fields will be updated.\n" - }, - { - "kind": "code", - "text": "`provider_type`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " are immutable and cannot be changed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1983, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2314, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1991, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2317, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1997, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2318, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1999, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2324, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2011, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2312, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1987, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2313, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1989, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2322, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2007, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2320, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2003, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2319, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2001, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2321, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2005, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2327, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2017, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2311, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1985, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2316, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1995, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2315, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1993, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2323, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2009, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2325, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2013, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2326, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2015, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2314, 2317, 2318, 2324, 2312, 2313, 2322, 2320, 2319, 2321, 2327, 2311, - 2316, 2315, 2323, 2325, 2326 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1983, - "character": 41 - } - ] - } - } - }, - { - "id": 2207, - "name": "UpdateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing OAuth client.\nAll fields are optional. Only provided fields will be updated.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1751, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2208, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2209, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1753, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2210, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1755, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2213, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1761, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2211, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1757, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2212, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1759, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2214, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1763, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2209, 2210, 2213, 2211, 2212, 2214] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1751, - "character": 38 - } - ] - } - } - }, - { - "id": 1701, - "name": "UserResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 231, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1702, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1703, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 232, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1703] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 231, - "character": 56 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1886, - "name": "VerifyOtpParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 650, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1887, - "name": "VerifyMobileOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1895, - "name": "VerifyEmailOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1903, - "name": "VerifyTokenHashParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2464, - "name": "VerifyPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2370, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2465, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2466, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startAuthentication" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2372, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2467, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.get()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2374, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2466, 2467] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2370, - "character": 48 - } - ] - } - } - }, - { - "id": 2455, - "name": "VerifyPasskeyRegistrationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2359, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2456, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2457, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startRegistration" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2361, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2458, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.create()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2363, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2457, 2458] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2359, - "character": 46 - } - ] - } - } - }, - { - "id": 1636, - "name": "WeakPassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 140, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1637, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1639, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 142, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1638, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 141, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1635, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1639, 1638] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 140, - "character": 27 - } - ] - } - } - }, - { - "id": 1635, - "name": "WeakPasswordReasons", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 139, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1885, - "name": "Web3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 649, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1850, - "name": "SolanaWeb3Credentials", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1868, - "name": "EthereumWeb3Credentials", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1561, - "name": "AuthAdminApi", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/AuthAdminApi.d.ts", - "line": 2, - "character": 14 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1562, - "name": "AuthClient", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/AuthClient.d.ts", - "line": 2, - "character": 14 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1221, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1576, - "name": "lockInternals", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Debug flag for " - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": ". The auth\nclient ignores both, so this has no client-side effect." - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 14, - "character": 21 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1577, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1578, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1578] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 14, - "character": 32 - } - ] - } - } - }, - { - "id": 3412, - "name": "REALTIME_CHANNEL_STATES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 134, - "character": 21 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3414, - "name": "closed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 135, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "closed" - } - }, - { - "id": 3415, - "name": "errored", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 136, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "errored" - } - }, - { - "id": 3416, - "name": "joined", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 137, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "joined" - } - }, - { - "id": 3417, - "name": "joining", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 138, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "joining" - } - }, - { - "id": 3418, - "name": "leaving", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 139, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "leaving" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3414, 3415, 3416, 3417, 3418] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 134, - "character": 46 - } - ] - } - } - }, - { - "id": 2174, - "name": "SIGN_OUT_SCOPES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1665, - "character": 21 - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - }, - { - "id": 2, - "name": "createClient", - "variant": "declaration", - "kind": 64, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Supabase Client." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Creating a Supabase client", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('profiles').select('*')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 47, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L47" - } - ], - "signatures": [ - { - "id": 3, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 47, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L47" - } - ], - "typeParameters": [ - { - "id": 4, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 6, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 7, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 51, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [7] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 51, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L51" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 8, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "reference", - "target": 5, - "typeArguments": [ - { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - } - } - ], - "parameters": [ - { - "id": 9, - "name": "supabaseUrl", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 10, - "name": "supabaseKey", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 11, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1072, - "typeArguments": [ - { - "type": "reference", - "target": 8, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClientOptions", - "package": "@supabase/supabase-js" - } - } - ], - "type": { - "type": "reference", - "target": 941, - "typeArguments": [ - { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 8, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClient", - "package": "@supabase/supabase-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2522, - "name": "isAuthApiError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 47, - "character": 24 - } - ], - "signatures": [ - { - "id": 2523, - "name": "isAuthApiError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 47, - "character": 24 - } - ], - "parameters": [ - { - "id": 2524, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2561, - "name": "AuthApiError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2519, - "name": "isAuthError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 32, - "character": 24 - } - ], - "signatures": [ - { - "id": 2520, - "name": "isAuthError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 32, - "character": 24 - } - ], - "parameters": [ - { - "id": 2521, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2528, - "name": "isAuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 154, - "character": 24 - } - ], - "signatures": [ - { - "id": 2529, - "name": "isAuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 154, - "character": 24 - } - ], - "parameters": [ - { - "id": 2530, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2531, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 200, - "character": 24 - } - ], - "signatures": [ - { - "id": 2532, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 200, - "character": 24 - } - ], - "parameters": [ - { - "id": 2533, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2537, - "name": "isAuthRefreshDiscardedError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 238, - "character": 24 - } - ], - "signatures": [ - { - "id": 2538, - "name": "isAuthRefreshDiscardedError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 238, - "character": 24 - } - ], - "parameters": [ - { - "id": 2539, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2534, - "name": "isAuthRetryableFetchError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 214, - "character": 24 - } - ], - "signatures": [ - { - "id": 2535, - "name": "isAuthRetryableFetchError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 214, - "character": 24 - } - ], - "parameters": [ - { - "id": 2536, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2525, - "name": "isAuthSessionMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 94, - "character": 24 - } - ], - "signatures": [ - { - "id": 2526, - "name": "isAuthSessionMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 94, - "character": 24 - } - ], - "parameters": [ - { - "id": 2527, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2540, - "name": "isAuthWeakPasswordError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 268, - "character": 24 - } - ], - "signatures": [ - { - "id": 2541, - "name": "isAuthWeakPasswordError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 268, - "character": 24 - } - ], - "parameters": [ - { - "id": 2542, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1563, - "name": "navigatorLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 24 - } - ], - "signatures": [ - { - "id": 1564, - "name": "navigatorLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient", - "target": 1221 - }, - { - "kind": "text", - "text": ".\n\nYou can turn on debugging by setting the " - }, - { - "kind": "code", - "text": "`supabase.gotrue-js.locks.debug`" - }, - { - "kind": "text", - "text": "\nlocal storage item to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " - }, - { - "kind": "code", - "text": "`request`" - }, - { - "kind": "text", - "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: navigatorLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 24 - } - ], - "typeParameters": [ - { - "id": 1565, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1566, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1567, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1568, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1569, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 83 - } - ], - "signatures": [ - { - "id": 1570, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 83 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1579, - "name": "processLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 24 - } - ], - "signatures": [ - { - "id": 1580, - "name": "processLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#navigatorLock" - }, - { - "kind": "text", - "text": " in browser environments." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: processLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nawait processLock('migrate', 5000, async () => {\n await runMigration()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 24 - } - ], - "typeParameters": [ - { - "id": 1581, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1582, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1583, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1584, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1585, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 81 - } - ], - "signatures": [ - { - "id": 1586, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 81 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1581, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1581, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1704, - "name": "Session", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 234, - "character": 17 - } - ], - "target": 42 - }, - { - "id": 1742, - "name": "User", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 349, - "character": 17 - } - ], - "target": 15 - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [925, 3393, 3398, 3403, 3407] - }, - { - "title": "Classes", - "children": [ - 2561, 2543, 2666, 2649, 2796, 2633, 2724, 2695, 2758, 2740, 2617, 2579, 2775, 2597, - 912, 890, 879, 901, 1124, 1221, 1571, 57, 830, 141, 729, 559, 2822, 3152, 2813, 850, - 941, 3419 - ] - }, - { - "title": "Interfaces", - "children": [ - 1750, 1707, 2392, 2492, 42, 15, 1961, 2343, 2096, 2228, 2512, 2025, 2166, 2146, - 1764, 1112, 1734, 1743, 1710, 1739, 1895, 1887, 1903, 3431, 3481 - ] - }, - { - "title": "Type Aliases", - "children": [ - 1705, 1589, 1588, 2018, 1810, 2086, 2083, 2093, 2090, 2009, 2013, 2008, 2010, 2011, - 2012, 2128, 2004, 2127, 2129, 2020, 2014, 2005, 2003, 1996, 2382, 2383, 2389, 2390, - 1671, 2488, 2485, 2477, 2478, 2484, 2482, 2475, 2476, 2483, 1662, 1666, 1676, 1680, - 2109, 2288, 2198, 2264, 2332, 2331, 2251, 1122, 1908, 1867, 1868, 1632, 1723, 1722, - 868, 1955, 1945, 1964, 1969, 1965, 1976, 1950, 1939, 1599, 2106, 2130, 2328, 1590, - 1995, 1994, 1992, 1991, 1993, 1977, 2125, 2124, 2126, 1990, 1978, 1989, 1982, 1981, - 1983, 1987, 1906, 2363, 2369, 2182, 2176, 2216, 2180, 2215, 2178, 2181, 2179, 2384, - 2379, 1685, 2252, 2117, 2110, 2429, 2434, 2472, 2438, 2424, 2415, 2420, 2468, 55, - 51, 53, 1640, 1587, 1117, 1121, 1115, 3136, 3150, 3273, 3314, 3321, 3328, 3352, - 3333, 3343, 3362, 3372, 3382, 3391, 2450, 1645, 1654, 2136, 1910, 1774, 1824, 1812, - 2444, 1788, 1793, 1924, 2121, 2175, 1780, 1834, 1850, 1698, 2459, 1642, 1072, 2103, - 2309, 2207, 1701, 1886, 2464, 2455, 1636, 1635, 1885 - ] - }, - { - "title": "Variables", - "children": [1561, 1562, 1576, 3412, 2174] - }, - { - "title": "Functions", - "children": [2, 2522, 2519, 2528, 2531, 2537, 2534, 2525, 2540, 1563, 1579] - }, - { - "title": "References", - "children": [1704, 1742] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "children": [12, 1] - } - ], - "packageName": "@supabase/supabase-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase JS SDK

    \n\n

    Isomorphic JavaScript SDK for Supabase - combining Auth, Database, Storage, Functions, and Realtime.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/supabase-js)](https://www.npmjs.com/package/@supabase/supabase-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/supabase-js)](https://pkg.pr.new/~/supabase/supabase-js)\n\n
    \n\n## Usage\n\nFirst of all, you need to install the library:\n\n" - }, - { - "kind": "code", - "text": "```sh\nnpm install @supabase/supabase-js\n```" - }, - { - "kind": "text", - "text": "\n\nThen you're able to import the library and establish the connection with the database:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Create a single supabase client for interacting with your database\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n```" - }, - { - "kind": "text", - "text": "\n\n### UMD\n\nYou can use plain " - }, - { - "kind": "code", - "text": "`\n```" - }, - { - "kind": "text", - "text": "\n\nor even:\n\n" - }, - { - "kind": "code", - "text": "```html\n\n```" - }, - { - "kind": "text", - "text": "\n\nThen you can use it from a global " - }, - { - "kind": "code", - "text": "`supabase`" - }, - { - "kind": "text", - "text": " variable:\n\n" - }, - { - "kind": "code", - "text": "```html\n\n```" - }, - { - "kind": "text", - "text": "\n\n### ESM\n\nYou can use " - }, - { - "kind": "code", - "text": "`\n```" - }, - { - "kind": "text", - "text": "\n\n### Deno\n\nYou can use supabase-js in the Deno runtime via [JSR](https://jsr.io/@supabase/supabase-js):\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from 'jsr:@supabase/supabase-js@2'\n```" - }, - { - "kind": "text", - "text": "\n\n### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Provide a custom `fetch` implementation as an option\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n global: {\n fetch: (...args) => fetch(...args),\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n### Distributed Tracing with OpenTelemetry\n\nThe Supabase JS SDK can attach W3C/OpenTelemetry trace context headers (" - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": ") to outgoing requests, enabling end-to-end request tracing from your client application through Supabase services.\n\nTrace propagation is **opt-in** and disabled by default. When enabled, headers are only attached to requests targeting Supabase domains (" - }, - { - "kind": "code", - "text": "`*.supabase.co`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`*.supabase.in`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`localhost`" - }, - { - "kind": "text", - "text": ").\n\n#### Enable trace propagation\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {\n tracePropagation: true,\n})\n\nconst tracer = trace.getTracer('my-app')\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // This request now includes the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - }, - { - "kind": "text", - "text": "\n\nIf " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " is not installed or no active context exists, the SDK silently no-ops.\n\n#### Advanced configuration\n\n" - }, - { - "kind": "code", - "text": "```typescript\ninterface TracePropagationOptions {\n // Enable trace propagation (default: false).\n enabled?: boolean\n\n // Respect upstream sampling decisions (default: true).\n // When true, headers are skipped if the upstream trace is not sampled.\n respectSamplingDecision?: boolean\n}\n```" - }, - { - "kind": "text", - "text": "\n\n" - }, - { - "kind": "code", - "text": "```js\n// Always propagate, even for non-sampled traces.\nconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Support Policy\n\nThis section outlines the scope of support for various runtime environments in Supabase JavaScript client.\n\n### Node.js\n\nWe only support Node.js versions that are in **Active LTS** or **Maintenance** status as defined by the [official Node.js release schedule](https://nodejs.org/en/about/previous-releases#release-schedule). This means we support versions that are currently receiving long-term support and critical bug fixes.\n\nWhen a Node.js version reaches end-of-life and is no longer in Active LTS or Maintenance status, Supabase will drop it in a **minor release**, and **this won't be considered a breaking change**.\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped in version " - }, - { - "kind": "code", - "text": "`2.79.0`" - }, - { - "kind": "text", - "text": ".\n>\n> If you must use Node.js 18, please use version " - }, - { - "kind": "code", - "text": "`2.78.0`" - }, - { - "kind": "text", - "text": ", which is the last version that supported Node.js 18.\n\n### Deno\n\nWe support Deno versions that are currently receiving active development and security updates. We follow the [official Deno release schedule](https://docs.deno.com/runtime/fundamentals/stability_and_releases/) and only support versions from the " - }, - { - "kind": "code", - "text": "`stable`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`lts`" - }, - { - "kind": "text", - "text": " release channels.\n\nWhen a Deno version reaches end-of-life and is no longer receiving security updates, Supabase will drop it in a **minor release**, and **this won't be considered a breaking change**.\n\n### Browsers\n\nAll modern browsers are supported. We support browsers that provide native " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " API. For Realtime features, browsers must also support native " - }, - { - "kind": "code", - "text": "`WebSocket`" - }, - { - "kind": "text", - "text": " API.\n\n### Bun\n\nWe support Bun runtime environments. Bun provides native fetch support and is compatible with Node.js APIs. Since Bun does not follow a structured release schedule like Node.js or Deno, we support current stable versions of Bun and may drop support for older versions in minor releases without considering it a breaking change.\n\n### React Native\n\nWe support React Native environments with fetch polyfills provided by the framework. Since React Native does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.\n\n### Cloudflare Workers\n\nWe support Cloudflare Workers runtime environments. Cloudflare Workers provides native fetch support. Since Cloudflare Workers does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.\n\n### Important Notes\n\n- **Experimental features**: Features marked as experimental may be removed or changed without notice\n\n## Known Build Warnings\n\n### " - }, - { - "kind": "code", - "text": "`UNUSED_EXTERNAL_IMPORT`" - }, - { - "kind": "text", - "text": " in Vite / Rollup / Nuxt\n\nWhen bundling your app, you may see warnings like:\n\n" - }, - { - "kind": "code", - "text": "```\n\"PostgrestError\" is imported from external module \"@supabase/postgrest-js\" but never used in \"...supabase-js/dist/index.mjs\".\n\"FunctionRegion\", \"FunctionsError\", \"FunctionsFetchError\", \"FunctionsHttpError\" and \"FunctionsRelayError\" are imported from external module \"@supabase/functions-js\" but never used in \"...\".\n```" - }, - { - "kind": "text", - "text": "\n\n**This is a false positive — your bundle is fine.** Here is why it happens:\n\n" - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": " re-exports " - }, - { - "kind": "code", - "text": "`PostgrestError`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FunctionsError`" - }, - { - "kind": "text", - "text": ", and related symbols so you can import them directly from " - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": ". However, our build tool merges all imports from the same package into a single import statement in the built output:\n\n" - }, - { - "kind": "code", - "text": "```js\n// dist/index.mjs (simplified)\nimport { PostgrestClient, PostgrestError } from '@supabase/postgrest-js'\n// ^ used internally ^ re-exported for you\n```" - }, - { - "kind": "text", - "text": "\n\nYour bundler checks which names from that import are used _in the code body_, and flags " - }, - { - "kind": "code", - "text": "`PostgrestError`" - }, - { - "kind": "text", - "text": " as unused because it only appears in an " - }, - { - "kind": "code", - "text": "`export`" - }, - { - "kind": "text", - "text": " statement — not called or assigned. The export itself is the usage, but downstream bundlers don't track this correctly. This is a known Rollup/Vite limitation with re-exported external imports.\n\n**Nothing is broken.** Tree-shaking and bundle size are unaffected.\n\nTo suppress the warning:\n\n**Vite / Rollup (" - }, - { - "kind": "code", - "text": "`vite.config.js`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`rollup.config.js`" - }, - { - "kind": "text", - "text": "):**\n\n" - }, - { - "kind": "code", - "text": "```js\nexport default {\n build: {\n rollupOptions: {\n onwarn(warning, warn) {\n if (warning.code === 'UNUSED_EXTERNAL_IMPORT' && warning.exporter?.includes('@supabase/'))\n return\n warn(warning)\n },\n },\n },\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Nuxt (" - }, - { - "kind": "code", - "text": "`nuxt.config.ts`" - }, - { - "kind": "text", - "text": "):**\n\n" - }, - { - "kind": "code", - "text": "```ts\nexport default defineNuxtConfig({\n vite: {\n build: {\n rollupOptions: {\n onwarn(warning, warn) {\n if (warning.code === 'UNUSED_EXTERNAL_IMPORT' && warning.exporter?.includes('@supabase/'))\n return\n warn(warning)\n },\n },\n },\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 3 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From the monorepo root\npnpm nx build supabase-js\n\n# Or with watch mode for development\npnpm nx build supabase-js --watch\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\nThere's a complete guide on how to set up your environment for running locally the " - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " integration tests. Please refer to [TESTING.md](" - }, - { - "kind": "relative-link", - "text": "./TESTING.md", - "target": 4 - }, - { - "kind": "text", - "text": ").\n\n## Badges\n\n[![Coverage Status](https://coveralls.io/repos/github/supabase/supabase-js/badge.svg?branch=master)](https://coveralls.io/github/supabase/supabase-js?branch=master)" - } - ], - "symbolIdMap": { - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "2": { - "sourceFileName": "src/index.ts", - "qualifiedName": "createClient" - }, - "3": { - "sourceFileName": "src/index.ts", - "qualifiedName": "createClient" - }, - "4": { - "sourceFileName": "src/index.ts", - "qualifiedName": "Database" - }, - "5": { - "sourceFileName": "src/index.ts", - "qualifiedName": "SchemaNameOrClientOptions" - }, - "6": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__type" - }, - "7": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "8": { - "sourceFileName": "src/index.ts", - "qualifiedName": "SchemaName" - }, - "9": { - "sourceFileName": "src/index.ts", - "qualifiedName": "supabaseUrl" - }, - "10": { - "sourceFileName": "src/index.ts", - "qualifiedName": "supabaseKey" - }, - "11": { - "sourceFileName": "src/index.ts", - "qualifiedName": "options" - }, - "12": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "" - }, - "13": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "CorsHeaders" - }, - "14": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "corsHeaders" - }, - "15": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User" - }, - "16": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.id" - }, - "17": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.app_metadata" - }, - "18": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.user_metadata" - }, - "19": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.aud" - }, - "20": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.confirmation_sent_at" - }, - "21": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.recovery_sent_at" - }, - "22": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email_change_sent_at" - }, - "23": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.new_email" - }, - "24": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.new_phone" - }, - "25": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.invited_at" - }, - "26": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.action_link" - }, - "27": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email" - }, - "28": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.phone" - }, - "29": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.created_at" - }, - "30": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.confirmed_at" - }, - "31": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email_confirmed_at" - }, - "32": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.phone_confirmed_at" - }, - "33": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.last_sign_in_at" - }, - "34": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.role" - }, - "35": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.updated_at" - }, - "36": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.identities" - }, - "37": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.is_anonymous" - }, - "38": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.is_sso_user" - }, - "39": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.factors" - }, - "40": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.deleted_at" - }, - "41": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.banned_until" - }, - "42": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session" - }, - "43": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.provider_token" - }, - "44": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.provider_refresh_token" - }, - "45": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.access_token" - }, - "46": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.refresh_token" - }, - "47": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.expires_in" - }, - "48": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.expires_at" - }, - "49": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.token_type" - }, - "50": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.user" - }, - "51": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponse" - }, - "52": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "53": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestSingleResponse" - }, - "54": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "55": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestMaybeSingleResponse" - }, - "56": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "57": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder" - }, - "58": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "59": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder" - }, - "60": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ClientOptions" - }, - "61": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.Result$1" - }, - "62": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ThrowOnError" - }, - "63": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "64": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "65": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "66": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "67": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "68": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "69": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "70": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "71": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "72": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "73": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "74": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "75": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "76": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "77": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "78": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "79": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "80": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "81": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "82": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "83": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "84": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "85": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "86": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "87": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "88": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "89": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "90": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "91": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "92": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "93": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "94": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "95": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "96": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "97": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "98": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "99": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "100": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "101": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "102": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "103": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "104": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "105": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "106": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "107": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "108": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "109": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "110": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "111": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "112": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "113": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "114": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "115": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "116": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "117": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "118": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "119": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "120": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "121": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "122": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "123": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "124": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "125": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "127": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.returns" - }, - "128": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.returns" - }, - "129": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "130": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "131": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "132": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "133": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "134": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "135": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "136": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "137": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "138": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ClientOptions" - }, - "139": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.Result$1" - }, - "140": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ThrowOnError" - }, - "141": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder" - }, - "142": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "143": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder" - }, - "144": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions" - }, - "145": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Schema" - }, - "146": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Row" - }, - "147": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Result$1" - }, - "148": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.RelationName" - }, - "149": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Relationships" - }, - "150": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Method" - }, - "151": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "152": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "153": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "154": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "155": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "156": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "157": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "158": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "159": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "160": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "161": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "162": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "163": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "164": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "165": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "166": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "167": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "168": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "169": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "170": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "171": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "172": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.eq" - }, - "173": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.eq" - }, - "174": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "175": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "176": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "177": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "178": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.neq" - }, - "179": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.neq" - }, - "180": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "181": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "182": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "183": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "184": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "185": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "186": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "187": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "188": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "189": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "190": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "191": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "192": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "193": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "194": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "195": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "196": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "197": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "198": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "199": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "200": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "201": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "202": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "203": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "204": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "205": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "206": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "207": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "208": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "209": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "210": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "211": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "212": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "213": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "214": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "215": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "216": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "217": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "218": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "219": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "220": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "221": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "222": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "223": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "224": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "225": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "226": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "227": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "228": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "229": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "230": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "231": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "232": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "233": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "234": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "235": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "236": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "237": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "238": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "239": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "240": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "241": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "242": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "243": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "244": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "245": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "246": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "247": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "248": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "249": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "250": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "251": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "252": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "253": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "254": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "255": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "256": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "257": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "258": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "259": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "260": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "261": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "262": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "263": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "264": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "265": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "266": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "267": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "268": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "269": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "270": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "271": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "272": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "273": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "274": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "275": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "276": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "277": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "278": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "279": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "280": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "281": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "282": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "283": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "284": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "285": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "286": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "287": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.isDistinct" - }, - "288": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.isDistinct" - }, - "289": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "290": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "291": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "292": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.in" - }, - "293": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.in" - }, - "294": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "295": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "296": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "297": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.notIn" - }, - "298": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.notIn" - }, - "299": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "300": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "301": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "302": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "303": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "304": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "305": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "306": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "307": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "308": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "309": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "310": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "311": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "312": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "313": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "314": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "315": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "316": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "317": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "318": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "319": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "320": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "321": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "322": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "323": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "324": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "325": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "326": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "327": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "328": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "329": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "330": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "331": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "332": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "333": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "334": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "335": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "336": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "337": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "338": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "339": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "340": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "341": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "342": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "343": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "344": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "345": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "346": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "347": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "348": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "349": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "350": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "351": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "352": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "353": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "354": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "355": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "356": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "357": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "358": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "359": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "360": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "361": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "362": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "363": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "364": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "365": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "366": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "367": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "368": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "369": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "370": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "371": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "372": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "373": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.config" - }, - "374": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.type" - }, - "375": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "376": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "377": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "378": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "379": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "380": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.config" - }, - "381": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.type" - }, - "382": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "383": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "384": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "385": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "386": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "387": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "388": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "389": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "390": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "391": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "392": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "393": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "394": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "395": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "396": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "397": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "398": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "399": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "400": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "401": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "402": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "403": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.or" - }, - "404": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.or" - }, - "405": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "filters" - }, - "406": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "407": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "408": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "409": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "410": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "411": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "412": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "413": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "414": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "415": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "416": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "417": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "418": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "419": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "420": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "421": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "422": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "423": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResultOne" - }, - "424": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "425": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "426": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "427": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "428": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "429": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "430": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "431": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "432": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "433": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "434": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "435": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "436": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "437": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "438": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "439": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "440": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "441": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "442": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "443": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "444": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "445": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "446": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "447": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "448": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "449": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "450": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "451": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "452": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "454": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "455": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "456": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "457": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "458": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "count" - }, - "459": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "460": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "461": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "462": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "463": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "464": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "465": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "from" - }, - "466": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "to" - }, - "467": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__2" - }, - "468": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "469": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "470": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "471": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "472": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "473": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "signal" - }, - "474": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "475": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "476": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "477": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "478": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "479": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "480": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "481": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "482": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "483": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "484": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "485": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "486": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "487": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "488": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.analyze" - }, - "489": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.verbose" - }, - "490": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.settings" - }, - "491": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.buffers" - }, - "492": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.wal" - }, - "493": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.format" - }, - "494": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "495": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "496": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "497": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "498": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "499": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "500": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "501": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "502": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "503": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "504": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "505": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "506": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "507": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "508": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "509": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "510": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "511": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "512": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "513": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "514": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "515": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "516": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "517": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "518": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "519": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "520": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "521": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "522": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "523": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "524": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "525": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "526": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "527": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "528": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "529": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "530": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "531": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "532": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "533": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "534": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "535": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "536": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "537": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "538": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "539": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "540": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "541": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "542": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "543": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "544": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "545": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "546": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "547": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "548": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "549": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "550": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "551": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "552": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions" - }, - "553": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Schema" - }, - "554": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Row" - }, - "555": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Result$1" - }, - "556": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.RelationName" - }, - "557": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Relationships" - }, - "558": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Method" - }, - "559": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder" - }, - "560": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "561": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder" - }, - "562": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions" - }, - "563": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Schema" - }, - "564": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Row" - }, - "565": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Result$1" - }, - "566": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.RelationName" - }, - "567": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Relationships" - }, - "568": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Method" - }, - "569": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "570": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "571": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "572": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "573": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "574": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "575": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "576": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "577": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "578": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "579": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "580": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "581": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "582": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "583": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "584": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "585": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "586": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "587": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "588": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "589": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "590": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "591": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "592": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "593": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResultOne" - }, - "594": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "595": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "596": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "597": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "598": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "599": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "600": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "601": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "602": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "603": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "604": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "605": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "606": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "607": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "608": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "609": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "610": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "611": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "612": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "613": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "614": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "615": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "617": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "618": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "619": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "620": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "621": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "622": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "623": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "624": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "625": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "626": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "627": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "628": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "count" - }, - "629": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "630": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "631": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "632": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "633": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "634": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "635": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "from" - }, - "636": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "to" - }, - "637": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__2" - }, - "638": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "639": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "640": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "641": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "642": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "643": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "signal" - }, - "644": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "645": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "646": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "647": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "648": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "649": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "650": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "651": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "652": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "653": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "654": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "655": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "656": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "657": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "658": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.analyze" - }, - "659": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.verbose" - }, - "660": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.settings" - }, - "661": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.buffers" - }, - "662": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.wal" - }, - "663": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.format" - }, - "664": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "665": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "666": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "667": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "668": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "669": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "670": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "671": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "672": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "673": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "674": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "675": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "676": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "677": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "678": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "679": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "680": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "681": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "682": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "683": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "684": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "685": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "686": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "687": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "688": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "689": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "690": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "691": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "692": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "693": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "694": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "695": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "696": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "697": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "698": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "699": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "700": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "701": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "702": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "703": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "704": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "705": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "706": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "707": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "708": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "709": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "710": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "711": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "712": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "713": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "714": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "715": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "716": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "717": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "718": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "719": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "720": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "721": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "722": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions" - }, - "723": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Schema" - }, - "724": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Row" - }, - "725": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Result$1" - }, - "726": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.RelationName" - }, - "727": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Relationships" - }, - "728": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Method" - }, - "729": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder" - }, - "730": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.__constructor" - }, - "731": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder" - }, - "732": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions" - }, - "733": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Schema" - }, - "734": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relation$1" - }, - "735": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.RelationName" - }, - "736": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relationships" - }, - "737": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "738": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Relationships" - }, - "739": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "url" - }, - "740": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "741": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "742": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "743": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "744": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "745": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "746": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "747": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "748": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "749": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "750": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "751": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "752": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "753": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "754": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.url" - }, - "755": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.headers" - }, - "756": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.schema" - }, - "757": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.signal" - }, - "758": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.fetch" - }, - "759": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "760": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "761": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "762": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "763": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "764": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "765": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "766": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.urlLengthLimit" - }, - "767": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.retry" - }, - "769": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.select" - }, - "770": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.select" - }, - "771": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "772": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "773": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "774": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "775": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "776": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.head" - }, - "777": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "778": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "779": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.insert" - }, - "780": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.insert" - }, - "781": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "782": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "783": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "784": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "785": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "786": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "787": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "788": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "789": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "790": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "791": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.defaultToNull" - }, - "792": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.upsert" - }, - "793": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.upsert" - }, - "794": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "795": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "796": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "797": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "798": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "799": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "800": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "801": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "802": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.onConflict" - }, - "803": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ignoreDuplicates" - }, - "804": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "805": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "806": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.defaultToNull" - }, - "807": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.update" - }, - "808": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.update" - }, - "809": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "810": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "811": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "812": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Update" - }, - "813": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "814": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "815": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "816": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "817": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.delete" - }, - "818": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.delete" - }, - "819": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "820": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "821": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "822": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "823": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions" - }, - "824": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Schema" - }, - "825": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relation$1" - }, - "826": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.RelationName" - }, - "827": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relationships" - }, - "828": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "829": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Relationships" - }, - "830": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError" - }, - "831": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.__constructor" - }, - "832": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError" - }, - "833": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "context" - }, - "834": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "835": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "836": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "837": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "838": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "839": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.details" - }, - "840": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.hint" - }, - "841": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.code" - }, - "842": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.toJSON" - }, - "843": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.toJSON" - }, - "844": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "845": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.name" - }, - "846": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "847": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "848": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "849": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "850": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "851": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.__constructor" - }, - "852": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "853": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "854": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "855": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "856": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "857": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "858": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "859": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "860": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "861": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "862": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "863": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "864": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "865": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "866": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError.__isStorageError" - }, - "867": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError.namespace" - }, - "868": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionInvokeOptions" - }, - "869": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "870": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.headers" - }, - "871": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.__index" - }, - "874": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.method" - }, - "875": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.region" - }, - "876": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.body" - }, - "877": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.signal" - }, - "878": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.timeout" - }, - "879": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "880": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError.__constructor" - }, - "881": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "882": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "883": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "884": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "885": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "886": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "887": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "888": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "889": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "890": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "891": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError.__constructor" - }, - "892": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "893": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "894": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "895": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "896": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "897": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "898": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "899": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "900": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "901": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "902": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError.__constructor" - }, - "903": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "904": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "905": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "906": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "907": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "908": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "909": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "910": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "911": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "912": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError" - }, - "913": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.__constructor" - }, - "914": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError" - }, - "915": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "message" - }, - "916": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "name" - }, - "917": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "918": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "919": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "920": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "921": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "922": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "923": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "924": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "925": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion" - }, - "926": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.Any" - }, - "927": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast1" - }, - "928": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast2" - }, - "929": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSouth1" - }, - "930": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast1" - }, - "931": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast2" - }, - "932": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.CaCentral1" - }, - "933": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuCentral1" - }, - "934": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest1" - }, - "935": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest2" - }, - "936": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest3" - }, - "937": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.SaEast1" - }, - "938": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsEast1" - }, - "939": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsWest1" - }, - "940": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsWest2" - }, - "941": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default" - }, - "942": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.__constructor" - }, - "943": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default" - }, - "944": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Database" - }, - "945": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaNameOrClientOptions" - }, - "946": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "947": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "948": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaName" - }, - "949": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Schema" - }, - "950": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "951": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "952": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "953": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "954": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "955": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "956": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "957": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "958": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "959": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "960": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "961": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "supabaseUrl" - }, - "962": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "supabaseKey" - }, - "963": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "options" - }, - "964": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.auth" - }, - "965": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.realtime" - }, - "966": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storage" - }, - "967": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.realtimeUrl" - }, - "968": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.authUrl" - }, - "969": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storageUrl" - }, - "970": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functionsUrl" - }, - "971": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rest" - }, - "972": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storageKey" - }, - "973": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.fetch" - }, - "974": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "975": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "976": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "977": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "978": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "979": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "980": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "981": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.changedAccessToken" - }, - "982": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.accessToken" - }, - "983": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "984": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "985": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.headers" - }, - "986": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.settings" - }, - "987": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.supabaseUrl" - }, - "988": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.supabaseKey" - }, - "989": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functions" - }, - "990": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functions" - }, - "991": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "992": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "993": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "TableName" - }, - "994": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "Table" - }, - "995": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "relation" - }, - "996": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "997": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "ViewName" - }, - "998": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "View" - }, - "999": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "relation" - }, - "1000": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.schema" - }, - "1001": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.schema" - }, - "1002": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "DynamicSchema" - }, - "1003": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "schema" - }, - "1004": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rpc" - }, - "1005": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rpc" - }, - "1006": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "FnName" - }, - "1007": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "Args" - }, - "1008": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "FilterBuilder" - }, - "1009": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "fn" - }, - "1010": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "args" - }, - "1011": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "options" - }, - "1012": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1013": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.head" - }, - "1014": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.get" - }, - "1015": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.count" - }, - "1016": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.channel" - }, - "1017": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.channel" - }, - "1018": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "name" - }, - "1019": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "opts" - }, - "1020": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.getChannels" - }, - "1021": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.getChannels" - }, - "1022": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeChannel" - }, - "1023": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeChannel" - }, - "1024": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "channel" - }, - "1025": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "1026": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "1055": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Database" - }, - "1056": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaNameOrClientOptions" - }, - "1057": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1058": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1059": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaName" - }, - "1060": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Schema" - }, - "1061": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "1062": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1063": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1064": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1065": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "1066": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1067": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1068": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1069": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1070": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1071": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1072": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseClientOptions" - }, - "1073": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1074": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.db" - }, - "1075": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1076": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.schema" - }, - "1077": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.timeout" - }, - "1078": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "1079": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.auth" - }, - "1080": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1081": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "1082": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "1083": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "1084": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "1085": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1086": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1087": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "url" - }, - "1088": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1089": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1090": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1092": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1093": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "1094": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "1095": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "1096": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "1097": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "1098": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "1099": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "1100": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "1101": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.realtime" - }, - "1102": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1103": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.global" - }, - "1104": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1105": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "1106": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "1107": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.accessToken" - }, - "1108": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1109": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1110": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.tracePropagation" - }, - "1111": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SchemaName" - }, - "1112": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions" - }, - "1113": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions.enabled" - }, - "1114": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions.respectSamplingDecision" - }, - "1115": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryResult" - }, - "1116": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1117": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryData" - }, - "1118": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1119": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1120": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1121": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryError" - }, - "1122": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DatabaseWithoutInternals" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DB" - }, - "1124": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "1125": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.__constructor" - }, - "1126": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "1127": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__0" - }, - "1128": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1129": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.url" - }, - "1130": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.headers" - }, - "1131": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1132": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "1134": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.fetch" - }, - "1135": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1136": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1137": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1138": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1139": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1140": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1141": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1142": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.experimental" - }, - "1143": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.mfa" - }, - "1144": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.oauth" - }, - "1145": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.customProviders" - }, - "1146": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.passkey" - }, - "1147": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.url" - }, - "1148": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.headers" - }, - "1149": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1150": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "1152": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.fetch" - }, - "1153": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1154": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1155": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1156": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1157": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1158": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1159": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1160": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.experimental" - }, - "1161": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "1162": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "1163": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "jwt" - }, - "1164": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "scope" - }, - "1165": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1166": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1167": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1168": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "1169": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "1170": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "email" - }, - "1171": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "options" - }, - "1172": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1173": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1174": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.redirectTo" - }, - "1175": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "1176": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "1177": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "1178": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "1179": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "1180": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "1181": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "1182": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "1183": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "1184": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1185": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1186": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1187": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "1188": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.aud" - }, - "1189": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1190": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1191": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1192": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1193": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "1194": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1195": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "1196": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "1197": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "1198": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "1199": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "1200": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "1201": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "1202": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "1203": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "1204": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "id" - }, - "1205": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "shouldSoftDelete" - }, - "1221": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "1223": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.__constructor" - }, - "1224": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "1225": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1227": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.admin" - }, - "1228": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.mfa" - }, - "1229": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.oauth" - }, - "1230": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.passkey" - }, - "1231": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.storageKey" - }, - "1232": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.flowType" - }, - "1233": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1234": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1235": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1236": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1237": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1238": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "value" - }, - "1239": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1240": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1241": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1242": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1243": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1244": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "value" - }, - "1245": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshToken" - }, - "1246": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.persistSession" - }, - "1247": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.storage" - }, - "1248": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.userStorage" - }, - "1249": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.memoryStorage" - }, - "1250": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1251": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1253": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stateChangeEmitters" - }, - "1254": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshTicker" - }, - "1255": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshTickTimeout" - }, - "1256": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.visibilityChangedCallback" - }, - "1257": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1258": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1259": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshingDeferred" - }, - "1260": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._sessionRemovalEpoch" - }, - "1261": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initializePromise" - }, - "1262": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.detectSessionInUrl" - }, - "1263": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1264": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1265": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "url" - }, - "1266": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1267": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1268": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1270": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.url" - }, - "1271": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.headers" - }, - "1272": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1273": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1275": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.hasCustomAuthorizationHeader" - }, - "1276": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.suppressGetSessionWarning" - }, - "1277": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.fetch" - }, - "1278": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1279": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1280": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1281": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1282": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1283": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1284": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1285": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lock" - }, - "1286": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lockAcquired" - }, - "1287": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.pendingInLock" - }, - "1288": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1289": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lockAcquireTimeout" - }, - "1290": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.experimental" - }, - "1291": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.broadcastChannel" - }, - "1292": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.logDebugMessages" - }, - "1293": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.logger" - }, - "1294": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1295": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1296": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "message" - }, - "1297": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "args" - }, - "1298": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "1299": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "1303": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "1304": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "1306": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "1307": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "1308": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1309": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "1310": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "1311": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1312": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "1313": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "1314": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1315": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "1316": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "1317": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1318": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "1319": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "1320": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "authCode" - }, - "1321": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "1322": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "1323": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1324": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1325": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1326": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1327": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1328": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "1329": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1330": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1331": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1332": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1333": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1334": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "1335": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1339": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "1340": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "1341": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1342": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "1343": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "1344": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1345": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "1346": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "1347": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1348": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "1349": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "1350": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1351": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "1352": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "1354": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "1355": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "1356": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1357": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "1358": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "1359": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1360": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1361": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1362": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1363": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1364": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1365": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1366": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1368": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1369": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1370": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1371": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1372": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1373": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1377": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "1378": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "1379": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "1381": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "1382": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "1383": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "1384": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1385": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1386": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1387": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._updateUser" - }, - "1388": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._updateUser" - }, - "1389": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "1390": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1391": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1392": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1393": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "1394": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "1395": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1396": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1397": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "1398": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1399": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._setSession" - }, - "1400": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._setSession" - }, - "1401": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1402": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "1404": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1405": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "1406": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "1407": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1408": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1409": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1410": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._refreshSession" - }, - "1411": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._refreshSession" - }, - "1412": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1413": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1414": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1418": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "1419": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "1420": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1421": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1422": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1423": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._signOut" - }, - "1424": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._signOut" - }, - "1425": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__0" - }, - "1426": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1427": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1428": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1429": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1430": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "1431": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1432": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1433": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "1434": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "1435": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1436": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1437": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1438": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "1439": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1440": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "1441": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1442": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1443": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "1444": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "1445": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1446": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1447": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1448": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "1450": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "1451": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "1452": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "email" - }, - "1453": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1454": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1455": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.redirectTo" - }, - "1456": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.captchaToken" - }, - "1457": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1458": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1459": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1460": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1461": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1462": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1463": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1464": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "1465": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "1466": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1467": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1468": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1469": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.identities" - }, - "1470": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1471": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1472": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1473": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1474": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1475": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1476": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1477": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1478": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1481": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "1482": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "1483": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "identity" - }, - "1484": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1485": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1486": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1487": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1488": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1489": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1490": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1502": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "1503": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "1504": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "1505": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "1506": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "1507": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "1525": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "1526": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "1527": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "1528": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1529": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1530": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1531": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.allowExpired" - }, - "1532": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.jwks" - }, - "1533": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1534": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1535": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1536": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1537": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1538": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.claims" - }, - "1539": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.header" - }, - "1540": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.signature" - }, - "1541": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1542": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1543": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1544": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1545": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1546": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1547": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1548": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "1549": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "1550": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1551": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "1552": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "1553": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1561": { - "sourceFileName": "../auth-js/src/AuthAdminApi.ts", - "qualifiedName": "AuthAdminApi" - }, - "1562": { - "sourceFileName": "../auth-js/src/AuthClient.ts", - "qualifiedName": "AuthClient" - }, - "1563": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "1564": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "1565": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "R" - }, - "1566": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "name" - }, - "1567": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "1568": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "fn" - }, - "1569": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1570": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1571": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "1572": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.__constructor" - }, - "1573": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "1574": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "message" - }, - "1575": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.isAcquireTimeout" - }, - "1576": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "internals" - }, - "1577": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1578": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type.debug" - }, - "1579": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "1580": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "1581": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "R" - }, - "1582": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "name" - }, - "1583": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "1584": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "fn" - }, - "1585": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1586": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1587": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Provider" - }, - "1588": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthChangeEventMFA" - }, - "1589": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthChangeEvent" - }, - "1590": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "LockFunc" - }, - "1591": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1592": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1593": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "name" - }, - "1594": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "acquireTimeout" - }, - "1595": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "fn" - }, - "1596": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1597": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1598": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "R" - }, - "1599": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueClientOptions" - }, - "1600": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1601": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1602": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "1603": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1604": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1606": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "1607": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "1608": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1609": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1610": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "url" - }, - "1611": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "1612": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1613": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1615": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "1616": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "1617": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1618": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "1619": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "1620": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "1621": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "1622": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1623": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1624": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "message" - }, - "1625": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "args" - }, - "1626": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "1627": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.hasCustomAuthorizationHeader" - }, - "1628": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "1629": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "1630": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "1631": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "1632": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ExperimentalFeatureFlags" - }, - "1633": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1634": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkey" - }, - "1635": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "1636": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPassword" - }, - "1637": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1638": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.reasons" - }, - "1639": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1640": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Prettify" - }, - "1641": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1642": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "StrictOmit" - }, - "1643": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1644": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "1645": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequestResult" - }, - "1646": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1647": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1648": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1649": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1650": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1651": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1652": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1653": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ErrorType" - }, - "1654": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequestResultSafeDestructure" - }, - "1655": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1656": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1657": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1658": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1659": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1660": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1661": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1662": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthResponse" - }, - "1663": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1664": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1665": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1666": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthResponsePassword" - }, - "1667": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1668": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1669": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1670": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.weak_password" - }, - "1671": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOtpResponse" - }, - "1672": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1673": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1674": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1675": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.messageId" - }, - "1676": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthTokenResponse" - }, - "1677": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1678": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1679": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1680": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthTokenResponsePassword" - }, - "1681": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1682": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1683": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1684": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.weakPassword" - }, - "1685": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthResponse" - }, - "1686": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1687": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1688": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1689": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1690": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1691": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1692": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1693": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1694": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1695": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1696": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1697": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1698": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SSOResponse" - }, - "1699": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1700": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1701": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserResponse" - }, - "1702": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1703": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1704": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session" - }, - "1705": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMRMethod" - }, - "1706": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1707": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry" - }, - "1708": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry.method" - }, - "1709": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry.timestamp" - }, - "1710": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity" - }, - "1711": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.id" - }, - "1712": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.user_id" - }, - "1713": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_data" - }, - "1714": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1715": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1717": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_id" - }, - "1718": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.provider" - }, - "1719": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.created_at" - }, - "1720": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.last_sign_in_at" - }, - "1721": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.updated_at" - }, - "1722": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorType" - }, - "1723": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Factor" - }, - "1724": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1725": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1726": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1727": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factor_type" - }, - "1728": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.status" - }, - "1729": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1730": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1731": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.last_challenged_at" - }, - "1732": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Type" - }, - "1733": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Status" - }, - "1734": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata" - }, - "1735": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.provider" - }, - "1736": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.providers" - }, - "1737": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.__index" - }, - "1739": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserMetadata" - }, - "1740": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserMetadata.__index" - }, - "1742": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User" - }, - "1743": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes" - }, - "1744": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.current_password" - }, - "1745": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.email" - }, - "1746": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.phone" - }, - "1747": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.password" - }, - "1748": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.nonce" - }, - "1749": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.data" - }, - "1750": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes" - }, - "1751": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.user_metadata" - }, - "1752": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.app_metadata" - }, - "1753": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.email_confirm" - }, - "1754": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.phone_confirm" - }, - "1755": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.ban_duration" - }, - "1756": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.role" - }, - "1757": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.password_hash" - }, - "1758": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.id" - }, - "1759": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "nonce" - }, - "1760": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "email" - }, - "1761": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "password" - }, - "1762": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "phone" - }, - "1763": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "current_password" - }, - "1764": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription" - }, - "1765": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.id" - }, - "1766": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.callback" - }, - "1767": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1768": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1769": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "event" - }, - "1770": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "session" - }, - "1771": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.unsubscribe" - }, - "1772": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1773": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1774": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInAnonymouslyCredentials" - }, - "1775": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1776": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1777": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1778": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1779": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1780": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignUpWithPasswordCredentials" - }, - "1781": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1782": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1783": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1784": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1785": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1786": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1787": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "1788": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasswordCredentials" - }, - "1789": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1790": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1791": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1792": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1793": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasswordlessCredentials" - }, - "1794": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1795": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1796": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1797": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1798": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1799": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "1800": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1801": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1802": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1803": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1804": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1805": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1806": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "1807": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1808": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1809": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "1810": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthFlowType" - }, - "1811": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1812": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithOAuthCredentials" - }, - "1813": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1814": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1815": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1816": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1817": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1818": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1819": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.queryParams" - }, - "1820": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1821": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1823": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1824": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithIdTokenCredentials" - }, - "1825": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1826": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1827": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1828": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token" - }, - "1829": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1830": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nonce" - }, - "1831": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1832": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1833": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1834": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SolanaWallet" - }, - "1835": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1836": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signIn" - }, - "1837": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1838": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1839": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "inputs" - }, - "1840": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.publicKey" - }, - "1841": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1842": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.toBase58" - }, - "1843": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1844": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1845": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signMessage" - }, - "1846": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1847": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1848": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "message" - }, - "1849": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "encoding" - }, - "1850": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SolanaWeb3Credentials" - }, - "1851": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1852": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1853": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1854": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1855": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1856": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1857": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1858": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1859": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signInWithSolana" - }, - "1860": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1861": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1862": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1863": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1864": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1865": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1866": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1867": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EthereumWallet" - }, - "1868": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EthereumWeb3Credentials" - }, - "1869": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1870": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1871": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1872": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1873": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1874": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1875": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1876": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1877": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signInWithEthereum" - }, - "1878": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1879": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1880": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1881": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1882": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1883": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1884": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1885": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Web3Credentials" - }, - "1886": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyOtpParams" - }, - "1887": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams" - }, - "1888": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.phone" - }, - "1889": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.token" - }, - "1890": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.type" - }, - "1891": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.options" - }, - "1892": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1893": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1894": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1895": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams" - }, - "1896": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.email" - }, - "1897": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.token" - }, - "1898": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.type" - }, - "1899": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.options" - }, - "1900": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1901": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1902": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1903": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams" - }, - "1904": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.token_hash" - }, - "1905": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.type" - }, - "1906": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MobileOtpType" - }, - "1907": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1908": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EmailOtpType" - }, - "1909": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1910": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ResendParams" - }, - "1911": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1912": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1913": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1914": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1915": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1916": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1917": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1918": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1919": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1920": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1921": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1922": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1923": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1924": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithSSO" - }, - "1925": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1926": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providerId" - }, - "1927": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1928": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1929": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1930": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1931": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1932": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1933": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.domain" - }, - "1934": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1935": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1936": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1937": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1938": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1939": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateSignupLinkParams" - }, - "1940": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1941": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1942": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1943": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.password" - }, - "1944": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1945": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateInviteOrMagiclinkParams" - }, - "1946": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1947": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1948": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1949": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1950": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateRecoveryLinkParams" - }, - "1951": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1952": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1953": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1954": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1955": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateEmailChangeLinkParams" - }, - "1956": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1957": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1958": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1959": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.newEmail" - }, - "1960": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1961": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions" - }, - "1962": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.data" - }, - "1963": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.redirectTo" - }, - "1964": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkParams" - }, - "1965": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkResponse" - }, - "1966": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1967": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.properties" - }, - "1968": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1969": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkProperties" - }, - "1970": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1971": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.action_link" - }, - "1972": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_otp" - }, - "1973": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.hashed_token" - }, - "1974": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_to" - }, - "1975": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.verification_type" - }, - "1976": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkType" - }, - "1977": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParams" - }, - "1978": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAUnenrollParams" - }, - "1979": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1980": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factorId" - }, - "1981": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParams" - }, - "1982": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParams" - }, - "1983": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFields" - }, - "1984": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1985": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.webauthn" - }, - "1986": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1987": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParams" - }, - "1988": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1989": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParams" - }, - "1990": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFATOTPChannel" - }, - "1991": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeTOTPParams" - }, - "1992": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParams" - }, - "1993": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParams" - }, - "1994": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParams" - }, - "1995": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyParams" - }, - "1996": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponseData" - }, - "1997": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1998": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1999": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_type" - }, - "2000": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_in" - }, - "2001": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.refresh_token" - }, - "2002": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2003": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponse" - }, - "2004": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponse" - }, - "2005": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAUnenrollResponse" - }, - "2006": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2007": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2008": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponse" - }, - "2009": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponse" - }, - "2010": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponse" - }, - "2011": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseDataJSON" - }, - "2012": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnServerResponse" - }, - "2013": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponse" - }, - "2014": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAListFactorsResponse" - }, - "2015": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2016": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.all" - }, - "2017": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "2018": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthenticatorAssuranceLevels" - }, - "2019": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2020": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - }, - "2021": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2022": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.currentLevel" - }, - "2023": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nextLevel" - }, - "2024": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.currentAuthenticationMethods" - }, - "2025": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi" - }, - "2026": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2027": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2028": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2029": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2030": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2031": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2032": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2033": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2034": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2035": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2036": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2037": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2038": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2039": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2040": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2041": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2042": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2043": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2044": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2045": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2046": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2047": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2048": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2049": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2050": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2051": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2052": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2053": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2054": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2055": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2056": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2057": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2058": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2059": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2060": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2061": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2062": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2063": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2064": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2065": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2066": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2067": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2068": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2069": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2070": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2071": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "2072": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "2073": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2074": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "2075": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "2076": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2077": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "2078": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "2079": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "2080": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "2081": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "jwt" - }, - "2082": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.webauthn" - }, - "2083": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorResponse" - }, - "2084": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2085": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2086": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorParams" - }, - "2087": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2088": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2089": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2090": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsResponse" - }, - "2091": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2092": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factors" - }, - "2093": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsParams" - }, - "2094": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2095": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2096": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi" - }, - "2097": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "2098": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "2099": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2100": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "2101": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "2102": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2103": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SupportedStorage" - }, - "2104": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2105": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.isServer" - }, - "2106": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "InitializeResult" - }, - "2107": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2108": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2109": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CallRefreshTokenResult" - }, - "2110": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Pagination" - }, - "2111": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2112": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nextPage" - }, - "2113": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lastPage" - }, - "2114": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.total" - }, - "2115": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "2117": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PageParams" - }, - "2118": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2119": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.page" - }, - "2120": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.perPage" - }, - "2121": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignOut" - }, - "2122": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2123": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2124": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParams" - }, - "2125": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParams" - }, - "2126": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnParams" - }, - "2127": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponse" - }, - "2128": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponse" - }, - "2129": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnResponse" - }, - "2130": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtHeader" - }, - "2131": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2132": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.alg" - }, - "2133": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2134": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.kid" - }, - "2135": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.typ" - }, - "2136": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequiredClaims" - }, - "2137": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2138": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "2139": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "2140": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2141": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "2142": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "2143": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "2144": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "2145": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "2146": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload" - }, - "2147": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.email" - }, - "2148": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.phone" - }, - "2149": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.is_anonymous" - }, - "2150": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.jti" - }, - "2151": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.nbf" - }, - "2152": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.app_metadata" - }, - "2153": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.user_metadata" - }, - "2154": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.amr" - }, - "2155": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.ref" - }, - "2156": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "2157": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "2158": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2159": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "2160": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "2161": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "2162": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "2163": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "2164": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.__index" - }, - "2166": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK" - }, - "2167": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.kty" - }, - "2168": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2169": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.key_ops" - }, - "2170": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.alg" - }, - "2171": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.kid" - }, - "2172": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.__index" - }, - "2174": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SIGN_OUT_SCOPES" - }, - "2175": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignOutScope" - }, - "2176": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientGrantType" - }, - "2177": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2178": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientResponseType" - }, - "2179": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientType" - }, - "2180": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientRegistrationType" - }, - "2181": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientTokenEndpointAuthMethod" - }, - "2182": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClient" - }, - "2183": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2184": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2185": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2186": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2187": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_type" - }, - "2188": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2189": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.registration_type" - }, - "2190": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2191": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2192": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2193": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2194": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "2195": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2196": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2197": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "2198": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CreateOAuthClientParams" - }, - "2199": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2200": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2201": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2202": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2203": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2204": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "2205": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2206": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2207": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UpdateOAuthClientParams" - }, - "2208": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2209": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2210": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2211": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2212": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2213": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2214": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2215": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientResponse" - }, - "2216": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientListResponse" - }, - "2217": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2218": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2219": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2220": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "2221": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2222": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2223": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2224": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2225": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2226": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "2227": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2228": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi" - }, - "2229": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "2230": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "2231": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2232": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "2233": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "2234": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2235": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "2236": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "2237": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2238": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "2239": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "2240": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2241": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2242": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "2243": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "2244": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2245": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2246": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2247": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2248": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "2249": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "2250": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2251": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderType" - }, - "2252": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OIDCDiscoveryDocument" - }, - "2253": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2254": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2255": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_endpoint" - }, - "2256": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint" - }, - "2257": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2258": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_endpoint" - }, - "2259": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.revocation_endpoint" - }, - "2260": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_scopes" - }, - "2261": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_response_types" - }, - "2262": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_subject_types" - }, - "2263": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_id_token_signing_algs" - }, - "2264": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomOAuthProvider" - }, - "2265": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2266": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2267": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "2268": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "2269": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2270": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2271": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2272": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2273": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2274": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2275": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2276": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2277": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2278": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2279": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2280": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2281": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2282": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2283": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2284": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2285": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_document" - }, - "2286": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2287": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "2288": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CreateCustomProviderParams" - }, - "2289": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2290": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "2291": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "2292": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2293": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2294": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2295": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2296": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2297": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2298": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2299": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2300": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2301": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2302": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2303": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2304": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2305": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2306": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2307": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2308": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2309": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UpdateCustomProviderParams" - }, - "2310": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2311": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2312": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2313": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2314": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2315": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2316": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2317": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2318": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2319": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2320": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2321": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2322": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2323": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2324": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2325": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2326": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2327": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2328": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ListCustomProvidersParams" - }, - "2329": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2330": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "2331": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderResponse" - }, - "2332": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderListResponse" - }, - "2333": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2334": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2335": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2336": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "2337": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2338": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2339": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2340": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2341": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "2342": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2343": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi" - }, - "2344": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "2345": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "2346": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2347": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "2348": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "2349": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2350": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "2351": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "2352": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2353": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "2354": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "2355": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2356": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2357": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "2358": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "2359": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2360": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2361": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2362": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2363": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationClient" - }, - "2364": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2365": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2366": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2367": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.uri" - }, - "2368": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2369": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationDetails" - }, - "2370": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2371": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_id" - }, - "2372": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uri" - }, - "2373": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "2374": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2375": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2376": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2377": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "2378": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2379": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthRedirect" - }, - "2380": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2381": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_url" - }, - "2382": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthAuthorizationDetailsResponse" - }, - "2383": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthConsentResponse" - }, - "2384": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthGrant" - }, - "2385": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2386": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "2387": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2388": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.granted_at" - }, - "2389": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthGrantsResponse" - }, - "2390": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthRevokeGrantResponse" - }, - "2391": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2392": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi" - }, - "2393": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "2394": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "2395": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2396": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "2397": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "2398": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2399": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2400": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2401": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "2402": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "2403": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "2404": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2405": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2406": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2407": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "2408": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "2409": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "2410": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "2411": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "2412": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2413": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2414": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clientId" - }, - "2415": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationOptionsResponse" - }, - "2416": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2417": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2418": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2419": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "2420": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationVerifyParams" - }, - "2421": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2422": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2423": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2424": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyMetadata" - }, - "2425": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2426": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2427": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "2428": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2429": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationOptionsResponse" - }, - "2430": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2431": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2432": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2433": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "2434": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationVerifyParams" - }, - "2435": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2436": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2437": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2438": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyListItem" - }, - "2439": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2440": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2441": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "2442": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2443": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.last_used_at" - }, - "2444": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasskeyCredentials" - }, - "2445": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2446": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2447": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2448": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "2449": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "2450": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RegisterPasskeyCredentials" - }, - "2451": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2452": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2453": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2454": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "2455": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyPasskeyRegistrationParams" - }, - "2456": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2457": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "2458": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2459": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "StartPasskeyAuthenticationParams" - }, - "2460": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2461": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2462": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2463": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "2464": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyPasskeyAuthenticationParams" - }, - "2465": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2466": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "2467": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2468": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyUpdateParams" - }, - "2469": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2470": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2471": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendlyName" - }, - "2472": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyDeleteParams" - }, - "2473": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2474": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2475": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationOptionsResponse" - }, - "2476": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationVerifyResponse" - }, - "2477": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationOptionsResponse" - }, - "2478": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationVerifyResponse" - }, - "2479": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2480": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "2481": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2482": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyListResponse" - }, - "2483": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyUpdateResponse" - }, - "2484": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyDeleteResponse" - }, - "2485": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminListParams" - }, - "2486": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2487": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2488": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminDeleteParams" - }, - "2489": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2490": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2491": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2492": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi" - }, - "2493": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "2494": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "2495": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "2496": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "2497": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2498": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "2499": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "2500": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2501": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "2502": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "2503": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2504": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "2505": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "2506": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "2507": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "2508": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2509": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "2510": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "2511": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2512": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi" - }, - "2513": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "2514": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "2515": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2516": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "2517": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "2518": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2519": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "2520": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "2521": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2522": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "2523": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "2524": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2525": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "2526": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "2527": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2528": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "2529": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "2530": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2531": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "2532": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "2533": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2534": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "2535": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "2536": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2537": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "2538": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "2539": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2540": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "2541": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "2542": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2543": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "2544": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__constructor" - }, - "2545": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "2546": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2547": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2548": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2549": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2550": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2551": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "2552": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2553": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2554": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2555": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2556": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2557": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2558": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2559": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2560": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2561": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "2562": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError.__constructor" - }, - "2563": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "2564": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2565": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2566": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2567": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError.status" - }, - "2568": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2569": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2570": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2571": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2572": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2573": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2574": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2575": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2576": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2577": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2578": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2579": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "2580": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.__constructor" - }, - "2581": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "2582": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2583": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "originalError" - }, - "2584": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.originalError" - }, - "2585": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2586": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2587": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "2588": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2589": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2590": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2591": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2592": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2593": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2594": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2595": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2596": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2597": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "2598": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.__constructor" - }, - "2599": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "2600": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2601": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "name" - }, - "2602": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2603": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2604": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2605": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2606": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2607": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2608": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2609": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2610": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2611": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2612": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2613": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2614": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2615": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2616": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2617": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "2618": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError.__constructor" - }, - "2619": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "2620": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2621": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2622": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2623": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2624": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2625": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2626": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2627": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2628": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2629": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2630": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2631": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2632": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2633": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "2634": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError.__constructor" - }, - "2635": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "2636": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2637": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2638": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2639": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2640": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2641": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2642": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2643": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2644": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2645": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2646": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2647": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2648": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2649": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "2650": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError.__constructor" - }, - "2651": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "2652": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2653": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2654": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2655": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2656": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2657": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2658": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2659": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2660": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2661": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2662": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2663": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2664": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2665": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2666": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "2667": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.__constructor" - }, - "2668": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "2669": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2670": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "details" - }, - "2671": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2672": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2673": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2674": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.details" - }, - "2675": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2676": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2677": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2678": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "2679": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "2680": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2681": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2682": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2683": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2684": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2685": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2686": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "2687": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2688": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2689": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2690": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2691": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2692": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2693": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2694": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2695": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "2696": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.__constructor" - }, - "2697": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "2698": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2699": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "details" - }, - "2700": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2701": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2702": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2703": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.details" - }, - "2704": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2705": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2706": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2707": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "2708": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "2709": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2710": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2711": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2712": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2713": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2714": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2715": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "2716": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2717": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2718": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2719": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2720": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2721": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2722": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2723": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2724": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "2725": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError.__constructor" - }, - "2726": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "2727": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2728": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2729": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2730": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2731": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2732": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2733": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2734": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2735": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2736": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2737": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2738": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2739": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2740": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "2741": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError.__constructor" - }, - "2742": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "2743": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2744": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2745": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2746": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2747": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2748": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2749": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2750": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2751": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2752": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2753": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2754": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2755": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2756": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2757": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2758": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "2759": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError.__constructor" - }, - "2760": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "2761": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2762": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2763": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2764": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2765": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2766": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2767": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2768": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2769": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2770": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2771": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2772": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2773": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2774": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2775": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "2776": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.__constructor" - }, - "2777": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "2778": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2779": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2780": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "reasons" - }, - "2781": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.reasons" - }, - "2782": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "2783": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "2784": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2785": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2786": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2787": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2788": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2789": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2790": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.reasons" - }, - "2791": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2792": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2793": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2794": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2795": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2796": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "2797": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError.__constructor" - }, - "2798": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "2799": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2800": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2801": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2802": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2803": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2804": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2805": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2806": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2807": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2808": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2809": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2810": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2811": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2812": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2813": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "2814": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.__constructor" - }, - "2815": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "2816": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "channel" - }, - "2817": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "opts" - }, - "2818": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.channel" - }, - "2819": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "2820": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "2822": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "2823": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.__constructor" - }, - "2824": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "2825": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "topic" - }, - "2826": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "params" - }, - "2827": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "socket" - }, - "2828": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.topic" - }, - "2829": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.params" - }, - "2830": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.socket" - }, - "2831": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.bindings" - }, - "2832": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subTopic" - }, - "2833": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.broadcastEndpointURL" - }, - "2834": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.private" - }, - "2835": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presence" - }, - "2836": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2837": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2838": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2839": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "state" - }, - "2840": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "2841": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "2842": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "2843": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "2844": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "2845": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "2846": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "2847": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "2848": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "2849": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "2850": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2851": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2852": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2853": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "status" - }, - "2854": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "err" - }, - "2855": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "2857": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "2858": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "2859": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2860": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2861": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2863": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2864": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "2865": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "2866": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2867": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2868": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2870": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "2871": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2872": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2874": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "2875": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "2876": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "2877": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2878": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2880": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2881": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2882": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2883": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2884": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2885": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2886": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2887": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2888": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2889": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2890": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2891": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2892": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2894": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2895": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2896": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2897": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2898": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2899": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2900": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2901": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2902": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2903": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2904": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2905": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2907": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2908": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2909": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2910": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2911": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2912": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2913": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2914": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2915": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2916": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2917": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2918": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2920": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2921": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2922": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2923": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2924": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2925": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2926": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2927": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2928": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2929": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2930": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2931": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2933": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2934": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2935": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2936": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2937": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2938": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2939": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2940": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2941": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2942": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2944": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2945": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2946": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2947": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2948": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2949": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2950": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2951": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2952": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2953": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2955": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2956": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2957": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2958": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2959": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2960": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2961": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2962": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2963": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2964": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2966": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2967": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2968": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2969": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2970": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2971": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2972": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2973": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2974": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2975": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2977": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2978": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2979": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2980": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2981": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2982": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2983": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2984": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2985": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2986": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2987": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2988": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2989": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2990": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2991": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2992": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2993": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "2994": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2995": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "2996": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2997": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "2998": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "2999": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3001": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3002": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3003": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3004": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3006": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3007": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3008": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3009": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3010": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3011": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3012": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3013": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3014": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3015": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3016": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3017": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "3018": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3019": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "3020": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "3021": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3022": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3023": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3024": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3025": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3026": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3027": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3028": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3029": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3030": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3031": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3032": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3033": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3034": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3035": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3036": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3037": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3038": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3039": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3041": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3042": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3043": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3044": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3045": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3046": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3047": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3048": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3049": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3050": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3051": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3052": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3053": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3054": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3055": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3056": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3058": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3059": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3060": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3061": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3062": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3063": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3064": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3065": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3066": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3067": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3068": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3069": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3070": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3071": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3072": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3073": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3075": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3076": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3077": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3078": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3079": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3080": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3081": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3082": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3083": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3084": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3085": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3086": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3087": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3088": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3089": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3090": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3092": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3093": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3094": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "3095": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3096": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3097": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3098": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3099": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "3100": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "3101": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "event" - }, - "3102": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3103": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "3104": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3105": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.timeout" - }, - "3106": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3107": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "3108": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3109": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "3110": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.status" - }, - "3111": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.error" - }, - "3112": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "3113": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "3114": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "args" - }, - "3115": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3116": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3117": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3118": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3119": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3121": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "3122": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3123": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3125": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "3126": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "3127": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3128": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "3129": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "3130": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "3131": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "3132": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "3133": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "3134": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "3135": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "other" - }, - "3136": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelOptions" - }, - "3137": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3138": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.config" - }, - "3139": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3140": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.broadcast" - }, - "3141": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3142": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.self" - }, - "3143": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.ack" - }, - "3144": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replay" - }, - "3145": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.presence" - }, - "3146": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3147": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.key" - }, - "3148": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.enabled" - }, - "3149": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.private" - }, - "3150": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelSendResponse" - }, - "3151": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3152": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "3153": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.__constructor" - }, - "3154": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "3155": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "endPoint" - }, - "3156": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "options" - }, - "3157": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channels" - }, - "3158": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.accessTokenValue" - }, - "3159": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.accessToken" - }, - "3160": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3161": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3162": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.apiKey" - }, - "3163": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.httpEndpoint" - }, - "3164": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.headers" - }, - "3165": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3166": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3168": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.params" - }, - "3169": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3170": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3172": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.ref" - }, - "3173": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.logLevel" - }, - "3174": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.fetch" - }, - "3175": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "3176": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "3177": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "3178": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "3179": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "3180": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "3181": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "3182": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.worker" - }, - "3183": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.workerUrl" - }, - "3184": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.workerRef" - }, - "3185": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.serializer" - }, - "3186": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "3187": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "3188": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "3189": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "3190": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "3191": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "3192": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "3193": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "3194": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "3195": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "3196": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "3197": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "3198": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "3199": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "3200": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "3201": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "3202": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "3203": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "3204": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "3205": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "3206": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "3207": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "3208": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "3209": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "3210": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3211": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3212": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "3213": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "3214": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "3215": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3216": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3217": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "3218": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "3219": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3220": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.open" - }, - "3221": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.close" - }, - "3222": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.error" - }, - "3223": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.message" - }, - "3230": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "3231": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "3232": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "3233": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "3234": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "3235": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "3236": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "code" - }, - "3237": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "reason" - }, - "3238": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "3239": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "3240": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "3241": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "3242": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "channel" - }, - "3243": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "3244": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "3245": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "3246": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "3247": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "3248": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "3249": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3250": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "3251": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "3252": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "3253": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "3254": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "3255": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "3256": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "3257": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "3258": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "3259": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "3260": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "topic" - }, - "3261": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "params" - }, - "3262": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "3263": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "3264": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3265": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "3266": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "3267": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "token" - }, - "3268": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "3269": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "3270": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "3271": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "3272": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "callback" - }, - "3273": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeClientOptions" - }, - "3274": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3275": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.transport" - }, - "3276": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.timeout" - }, - "3277": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatIntervalMs" - }, - "3278": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatCallback" - }, - "3279": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3280": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3281": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "status" - }, - "3282": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "latency" - }, - "3283": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.vsn" - }, - "3284": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.logger" - }, - "3285": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3286": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3287": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "3288": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "3289": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3290": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.encode" - }, - "3291": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.decode" - }, - "3292": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.reconnectAfterMs" - }, - "3293": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3294": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3295": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "3296": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.headers" - }, - "3297": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3298": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3300": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.params" - }, - "3301": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3302": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3304": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.log_level" - }, - "3305": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.logLevel" - }, - "3306": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.fetch" - }, - "3307": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.worker" - }, - "3308": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.workerUrl" - }, - "3309": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.accessToken" - }, - "3310": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3311": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3312": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.disconnectOnEmptyChannelsAfterMs" - }, - "3313": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.sessionStorage" - }, - "3314": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeMessage" - }, - "3315": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3316": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.topic" - }, - "3317": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.event" - }, - "3318": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.payload" - }, - "3319": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.ref" - }, - "3320": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.join_ref" - }, - "3321": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesFilter" - }, - "3322": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3323": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3324": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.schema" - }, - "3325": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.table" - }, - "3326": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.filter" - }, - "3327": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3328": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayload" - }, - "3329": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3330": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3331": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3333": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresInsertPayload" - }, - "3334": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3335": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3336": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3337": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3338": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3339": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3340": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3341": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3343": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresUpdatePayload" - }, - "3344": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3345": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3346": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3347": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3348": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3349": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3350": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3352": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresDeletePayload" - }, - "3353": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3354": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3355": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3356": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3357": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3358": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3359": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3360": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3362": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceJoinPayload" - }, - "3363": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3364": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "3365": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "3366": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "3367": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.newPresences" - }, - "3368": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3369": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3370": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3372": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceLeavePayload" - }, - "3373": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3374": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "3375": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "3376": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "3377": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.leftPresences" - }, - "3378": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3379": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3380": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3382": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceState" - }, - "3383": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3384": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3386": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3387": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3388": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3390": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3391": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeRemoveChannelResponse" - }, - "3392": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3393": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES" - }, - "3394": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" - }, - "3395": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" - }, - "3396": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" - }, - "3397": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" - }, - "3398": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "3399": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - }, - "3400": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "3401": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "3402": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "3403": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" - }, - "3404": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" - }, - "3405": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "3406": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "3407": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES" - }, - "3408": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" - }, - "3409": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" - }, - "3410": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" - }, - "3411": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" - }, - "3412": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_CHANNEL_STATES" - }, - "3413": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3414": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.closed" - }, - "3415": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.errored" - }, - "3416": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.joined" - }, - "3417": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.joining" - }, - "3418": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.leaving" - }, - "3419": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory" - }, - "3421": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "3422": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "3423": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "3424": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "3425": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "url" - }, - "3426": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "protocols" - }, - "3427": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "3428": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "3431": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike" - }, - "3432": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CONNECTING" - }, - "3433": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.OPEN" - }, - "3434": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSING" - }, - "3435": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSED" - }, - "3436": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.readyState" - }, - "3437": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.url" - }, - "3438": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.protocol" - }, - "3439": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "3440": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "3441": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "code" - }, - "3442": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "reason" - }, - "3443": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "3444": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "3445": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "data" - }, - "3446": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onopen" - }, - "3447": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3448": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3449": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3450": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3451": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onmessage" - }, - "3452": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3453": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3454": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3455": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3456": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onclose" - }, - "3457": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3458": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3459": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3460": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3461": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onerror" - }, - "3462": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3463": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3464": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3465": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3466": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "3467": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "3468": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "3469": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "3470": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "3471": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "3472": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "3473": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "3474": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.binaryType" - }, - "3475": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.bufferedAmount" - }, - "3476": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.extensions" - }, - "3477": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.dispatchEvent" - }, - "3478": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3479": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3480": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "event" - }, - "3481": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3482": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3483": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3484": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "address" - }, - "3485": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "subprotocols" - }, - "3486": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor.__index" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "src/cors.ts", - "3": "../../../CONTRIBUTING.md", - "4": "TESTING.md" - }, - "reflections": { - "1": 1, - "2": 12 - } - } - }, - { - "id": 0, - "name": "@supabase/auth-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1744, - "name": "AuthApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error returned directly from the GoTrue REST API." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthApiError } from '@supabase/auth-js'\n\nthrow new AuthApiError('Invalid credentials', 400, 'invalid_credentials')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1745, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L67" - } - ], - "signatures": [ - { - "id": 1746, - "name": "AuthApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L67" - } - ], - "parameters": [ - { - "id": 1747, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1748, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1749, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 1744, - "name": "AuthApiError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1751, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1750, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L65" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1754, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1755, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1756, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1760, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1761, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1758, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1757, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1759, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1760, 1758, 1757, 1759] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1745] - }, - { - "title": "Properties", - "children": [1751, 1750] - }, - { - "title": "Methods", - "children": [1754] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 64, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L64" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1726, - "name": "AuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error thrown by Supabase Auth helpers." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthError } from '@supabase/auth-js'\n\nthrow new AuthError('Unexpected auth error', 500, 'unexpected')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1727, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L28" - } - ], - "signatures": [ - { - "id": 1728, - "name": "AuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L28" - } - ], - "parameters": [ - { - "id": 1729, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1730, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1731, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 1732, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1733, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1734, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1736, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1737, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1738, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1742, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1743, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1740, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1739, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1741, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1742, 1740, 1739, 1741] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1727] - }, - { - "title": "Properties", - "children": [1732, 1734] - }, - { - "title": "Methods", - "children": [1736] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 14, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L14" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1744, - "name": "AuthApiError" - }, - { - "type": "reference", - "target": 1762, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1849, - "name": "AuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when implicit grant redirects contain an error." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthImplicitGrantRedirectError } from '@supabase/auth-js'\n\nthrow new AuthImplicitGrantRedirectError('OAuth redirect failed', {\n error: 'access_denied',\n code: 'oauth_error',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1850, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "signatures": [ - { - "id": 1851, - "name": "AuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "parameters": [ - { - "id": 1852, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1853, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1854, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1856, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1855, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1856, 1855] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1875, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1876, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1857, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1858, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1860, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1859, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1860, 1859] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1873, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1874, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1861, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ], - "signatures": [ - { - "id": 1862, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1867, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 200, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L200" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1868, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1869, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1870, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1872, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1871, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1872, 1871] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ] - } - } - ] - } - }, - { - "id": 1865, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 198, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L198" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1864, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 197, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L197" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1866, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 199, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L199" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1867, 1869, 1865, 1864, 1866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1850] - }, - { - "title": "Properties", - "children": [1875, 1857, 1873, 1874] - }, - { - "title": "Methods", - "children": [1861] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 189, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L189" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1832, - "name": "AuthInvalidCredentialsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when email/password credentials are invalid." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidCredentialsError } from '@supabase/auth-js'\n\nthrow new AuthInvalidCredentialsError('Email or password is incorrect')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1833, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L171" - } - ], - "signatures": [ - { - "id": 1834, - "name": "AuthInvalidCredentialsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L171" - } - ], - "parameters": [ - { - "id": 1835, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1832, - "name": "AuthInvalidCredentialsError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1838, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1839, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1836, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1837, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1841, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1842, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1847, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1848, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1845, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1844, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1846, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1847, 1845, 1844, 1846] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1833] - }, - { - "title": "Properties", - "children": [1838, 1836, 1837] - }, - { - "title": "Methods", - "children": [1841] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 170, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L170" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1979, - "name": "AuthInvalidJwtError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a JWT cannot be verified or parsed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidJwtError } from '@supabase/auth-js'\n\nthrow new AuthInvalidJwtError('Token signature is invalid')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1980, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L388" - } - ], - "signatures": [ - { - "id": 1981, - "name": "AuthInvalidJwtError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L388" - } - ], - "parameters": [ - { - "id": 1982, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1979, - "name": "AuthInvalidJwtError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1985, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1986, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1983, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1984, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1988, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1989, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1990, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1994, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1995, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1992, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1991, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1993, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1994, 1992, 1991, 1993] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1980] - }, - { - "title": "Properties", - "children": [1985, 1983, 1984] - }, - { - "title": "Methods", - "children": [1988] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 387, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L387" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1816, - "name": "AuthInvalidTokenResponseError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the token response is malformed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidTokenResponseError } from '@supabase/auth-js'\n\nthrow new AuthInvalidTokenResponseError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1817, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L155" - } - ], - "signatures": [ - { - "id": 1818, - "name": "AuthInvalidTokenResponseError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L155" - } - ], - "type": { - "type": "reference", - "target": 1816, - "name": "AuthInvalidTokenResponseError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1821, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1822, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1819, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1820, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1824, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1825, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1826, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1830, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1831, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1828, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1827, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1829, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1830, 1828, 1827, 1829] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1817] - }, - { - "title": "Properties", - "children": [1821, 1819, 1820] - }, - { - "title": "Methods", - "children": [1824] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 154, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L154" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the PKCE code verifier is not found in storage.\nThis typically happens when the auth flow was initiated in a different\nbrowser, device, or the storage was cleared." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCECodeVerifierMissingError } from '@supabase/auth-js'\n\nthrow new AuthPKCECodeVerifierMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1908, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L261" - } - ], - "signatures": [ - { - "id": 1909, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L261" - } - ], - "type": { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1912, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1913, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1910, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1911, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1915, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1916, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1917, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1921, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1919, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1918, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1920, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1921, 1919, 1918, 1920] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1908] - }, - { - "title": "Properties", - "children": [1912, 1910, 1911] - }, - { - "title": "Methods", - "children": [1915] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 260, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L260" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1878, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown during PKCE code exchanges." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'\n\nthrow new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1879, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "signatures": [ - { - "id": 1880, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "parameters": [ - { - "id": 1881, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1882, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1883, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1885, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1884, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1885, 1884] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": 1878, - "name": "AuthPKCEGrantCodeExchangeError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1904, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1905, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1886, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1887, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1889, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1888, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1889, 1888] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1902, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1903, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1890, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ], - "signatures": [ - { - "id": 1891, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1892, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1896, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 238, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L238" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1897, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1898, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1899, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1901, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1900, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1901, 1900] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ] - } - } - ] - } - }, - { - "id": 1894, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 236, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L236" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1893, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L235" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1895, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 237, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L237" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1896, 1898, 1894, 1893, 1895] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1879] - }, - { - "title": "Properties", - "children": [1904, 1886, 1902, 1903] - }, - { - "title": "Methods", - "children": [1890] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 226, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L226" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1941, - "name": "AuthRefreshDiscardedError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returned when the server rotated a refresh token successfully but the\nclient chose not to persist the rotated tokens because the local session\nchanged mid-flight. Usually means a concurrent " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " cleared storage\nbetween when the refresh started and when it came back.\n\nSet on the " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " field of the refresh result so callers can tell \"we\ngot rotated tokens but threw them away\" apart from \"the refresh failed.\"\nThe rotated session on the server will be picked up on the next refresh\nvia GoTrue's parent-of-active path." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { isAuthRefreshDiscardedError } from '@supabase/auth-js'\n\nif (isAuthRefreshDiscardedError(error)) {\n // Concurrent signOut/sign-in raced our refresh. Treat as a no-op.\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1942, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L321" - } - ], - "signatures": [ - { - "id": 1943, - "name": "AuthRefreshDiscardedError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L321" - } - ], - "parameters": [ - { - "id": 1944, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'Refresh result discarded: session state changed mid-flight (e.g., concurrent signOut)'" - } - ], - "type": { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1947, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1948, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1945, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1946, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1950, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1951, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1952, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1956, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1957, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1954, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1953, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1955, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1956, 1954, 1953, 1955] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1942] - }, - { - "title": "Properties", - "children": [1947, 1945, 1946] - }, - { - "title": "Methods", - "children": [1950] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 320, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L320" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1923, - "name": "AuthRetryableFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a transient fetch issue occurs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthRetryableFetchError } from '@supabase/auth-js'\n\nthrow new AuthRetryableFetchError('Service temporarily unavailable', 503)\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1924, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 291, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L291" - } - ], - "signatures": [ - { - "id": 1925, - "name": "AuthRetryableFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 291, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L291" - } - ], - "parameters": [ - { - "id": 1926, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1927, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1930, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1931, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1928, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1929, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1933, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1934, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1935, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1939, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1940, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1937, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1936, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1938, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1939, 1937, 1936, 1938] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1924] - }, - { - "title": "Properties", - "children": [1930, 1928, 1929] - }, - { - "title": "Methods", - "children": [1933] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 290, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L290" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1800, - "name": "AuthSessionMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when an operation requires a session but none is present." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthSessionMissingError } from '@supabase/auth-js'\n\nthrow new AuthSessionMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1801, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 135, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L135" - } - ], - "signatures": [ - { - "id": 1802, - "name": "AuthSessionMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 135, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L135" - } - ], - "type": { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1805, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1806, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1803, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1804, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1808, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1809, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1810, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1814, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1815, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1812, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1811, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1813, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1814, 1812, 1811, 1813] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1801] - }, - { - "title": "Properties", - "children": [1805, 1803, 1804] - }, - { - "title": "Methods", - "children": [1808] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 134, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L134" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1762, - "name": "AuthUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps non-standard errors so callers can inspect the root cause." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthUnknownError } from '@supabase/auth-js'\n\ntry {\n await someAuthCall()\n} catch (err) {\n throw new AuthUnknownError('Auth failed', err)\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1763, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L96" - } - ], - "signatures": [ - { - "id": 1764, - "name": "AuthUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L96" - } - ], - "parameters": [ - { - "id": 1765, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1766, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 1762, - "name": "AuthUnknownError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1768, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1767, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L94" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1770, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1772, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1773, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1774, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1778, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1776, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1775, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1777, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1778, 1776, 1775, 1777] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1763] - }, - { - "title": "Properties", - "children": [1768, 1767, 1770] - }, - { - "title": "Methods", - "children": [1772] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 93, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L93" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1958, - "name": "AuthWeakPasswordError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a supplied password is considered weak." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthWeakPasswordError } from '@supabase/auth-js'\n\nthrow new AuthWeakPasswordError('Password too short', 400, ['min_length'])\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1959, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 353, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L353" - } - ], - "signatures": [ - { - "id": 1960, - "name": "AuthWeakPasswordError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 353, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L353" - } - ], - "parameters": [ - { - "id": 1961, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1962, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1963, - "name": "reasons", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1976, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1977, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1974, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1964, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reasons why the password is deemed weak." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L351" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 1975, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1965, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ], - "signatures": [ - { - "id": 1966, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1967, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1971, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 363, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L363" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1972, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1969, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 361, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L361" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1968, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 360, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L360" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1973, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 364, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L364" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 1970, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 362, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L362" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1971, 1969, 1968, 1973, 1970] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1959] - }, - { - "title": "Properties", - "children": [1976, 1974, 1964, 1975] - }, - { - "title": "Methods", - "children": [1965] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 347, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L347" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1780, - "name": "CustomAuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Flexible error class used to create named auth errors at runtime." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { CustomAuthError } from '@supabase/auth-js'\n\nthrow new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1781, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L117" - } - ], - "signatures": [ - { - "id": 1782, - "name": "CustomAuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L117" - } - ], - "parameters": [ - { - "id": 1783, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1784, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1785, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1786, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1789, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1787, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "AuthError.name" - } - }, - { - "id": 1788, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1792, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1793, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1798, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1799, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1796, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1795, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1797, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1798, 1796, 1795, 1797] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1781] - }, - { - "title": "Properties", - "children": [1789, 1787, 1788] - }, - { - "title": "Methods", - "children": [1792] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 113, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L113" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "target": 1816, - "name": "AuthInvalidTokenResponseError" - }, - { - "type": "reference", - "target": 1832, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "target": 1878, - "name": "AuthPKCEGrantCodeExchangeError" - }, - { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError" - }, - { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError" - }, - { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError" - }, - { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError" - }, - { - "type": "reference", - "target": 1979, - "name": "AuthInvalidJwtError" - } - ] - }, - { - "id": 1, - "name": "GoTrueAdminApi", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 92, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L92" - } - ], - "signatures": [ - { - "id": 3, - "name": "GoTrueAdminApi", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an admin API client that can be used to manage users and OAuth clients." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\nconst { data, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueAdminApi } from '@supabase/auth-js'\n\nconst admin = new GoTrueAdminApi({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { Authorization: `Bearer ${process.env.SUPABASE_SECRET_KEY}` },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 92, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L92" - } - ], - "parameters": [ - { - "id": 4, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 19, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 103, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L103" - } - ], - "type": { - "type": "reference", - "target": 781, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 11, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 102, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L102" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 13, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 14, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 15, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 16, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 17, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 18, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 7, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 99, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L99" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 8, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 99, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L99" - } - ], - "indexSignatures": [ - { - "id": 9, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L100" - } - ], - "parameters": [ - { - "id": 10, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 6, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 98, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L98" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - } - ], - "groups": [ - { - "title": "Properties", - "children": [19, 11, 7, 6] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 97, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L97" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 22, - "name": "customProviders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L55" - } - ], - "type": { - "type": "reference", - "target": 1526, - "name": "GoTrueAdminCustomProvidersApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 20, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all MFA administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 46, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L46" - } - ], - "type": { - "type": "reference", - "target": 1279, - "name": "GoTrueAdminMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 21, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 52, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L52" - } - ], - "type": { - "type": "reference", - "target": 1411, - "name": "GoTrueAdminOAuthApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 23, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all passkey administration methods.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L62" - } - ], - "type": { - "type": "reference", - "target": 1695, - "name": "GoTrueAdminPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 55, - "name": "createUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 485, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L485" - } - ], - "signatures": [ - { - "id": 56, - "name": "createUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To confirm the user's email address or phone number, set " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " to true. Both arguments default to false.\n- " - }, - { - "kind": "code", - "text": "`createUser()`" - }, - { - "kind": "text", - "text": " will not send a confirmation email to the user. You can use [" - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " param to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "With custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n password: 'password',\n user_metadata: { name: 'Yoda' }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With custom user metadata\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n email_confirm: true\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n phone: '1234567890',\n phone_confirm: true\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 485, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L485" - } - ], - "parameters": [ - { - "id": 57, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 933, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 79, - "name": "deleteUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 839, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L839" - } - ], - "signatures": [ - { - "id": 80, - "name": "deleteUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a user. Requires a " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`deleteUser()`" - }, - { - "kind": "text", - "text": " method requires the user's ID, which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Removes a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.deleteUser(\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Removes a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {}\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 839, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L839" - } - ], - "parameters": [ - { - "id": 81, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user id you want to remove." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 82, - "name": "shouldSoftDelete", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 52, - "name": "generateLink", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 375, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L375" - } - ], - "signatures": [ - { - "id": 53, - "name": "generateLink", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates email links and OTPs to be sent via a custom email provider." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The following types can be passed into " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": ": " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_current`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_new`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " only generates the email link for " - }, - { - "kind": "code", - "text": "`email_change_email`" - }, - { - "kind": "text", - "text": " if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " handles the creation of the user for " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Generate a signup link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'signup',\n email: 'email@example.com',\n password: 'secret'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Generate a signup link\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"properties\": {\n \"action_link\": \"\",\n \"email_otp\": \"999999\",\n \"hashed_token\": \"\",\n \"verification_type\": \"signup\"\n },\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"email@example.com\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"email@example.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate an invite link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'invite',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a magic link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'magiclink',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a recovery link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'recovery',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate links to change current email address", - "content": [ - { - "kind": "code", - "text": "```js\n// generate an email change link to be sent to the current email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_current',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n\n// generate an email change link to be sent to the new email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_new',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 375, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L375" - } - ], - "parameters": [ - { - "id": 54, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1147, - "name": "GenerateLinkParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1148, - "name": "GenerateLinkResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 72, - "name": "getUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 628, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L628" - } - ], - "signatures": [ - { - "id": 73, - "name": "getUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get user by id." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Fetches the user object from the database based on the user's id.\n- The " - }, - { - "kind": "code", - "text": "`getUserById()`" - }, - { - "kind": "text", - "text": " method requires the user's id which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Fetch the user object using the access_token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.getUserById(1)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Fetch the user object using the access_token jwt\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 628, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L628" - } - ], - "parameters": [ - { - "id": 74, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 45, - "name": "inviteUserByEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 232, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L232" - } - ], - "signatures": [ - { - "id": 46, - "name": "inviteUserByEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends an invite link to an email address." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Sends an invite link to the user's email address.\n- The " - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": " method is typically used by administrators to invite users to join the application.\n- Note that PKCE is not supported when using " - }, - { - "kind": "code", - "text": "`inviteUserByEmail`" - }, - { - "kind": "text", - "text": ". This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow." - } - ] - }, - { - "tag": "@example", - "name": "Invite a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Invite a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"invited_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 232, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L232" - } - ], - "parameters": [ - { - "id": 47, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options to be included when inviting." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 49, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 50, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store additional metadata about the user. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.user_metadata`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 236, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L236" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 51, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 239, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [50, 51] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 234, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L234" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 58, - "name": "listUsers", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 526, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L526" - } - ], - "signatures": [ - { - "id": 59, - "name": "listUsers", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Defaults to return 50 users per page." - } - ] - }, - { - "tag": "@example", - "name": "Get a page of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Paginated list of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\n page: 1,\n perPage: 1000\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 526, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L526" - } - ], - "parameters": [ - { - "id": 60, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object which supports " - }, - { - "kind": "code", - "text": "`page`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`perPage`" - }, - { - "kind": "text", - "text": " as numbers, to alter the paginated results." - } - ] - }, - "type": { - "type": "reference", - "target": 1300, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 61, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 62, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 63, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 65, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 64, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [65, 64] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ] - } - }, - { - "type": "reference", - "target": 1293, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 66, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [62, 66] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 68, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 70, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [70] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ] - } - } - }, - { - "id": 71, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [68, 71] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 38, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 142, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L142" - } - ], - "signatures": [ - { - "id": 39, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a logged-in session." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 142, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L142" - } - ], - "parameters": [ - { - "id": 40, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A valid, logged-in JWT." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 41, - "name": "scope", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logout sope." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 42, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 43, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 44, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [43, 44] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 75, - "name": "updateUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 789, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L789" - } - ], - "signatures": [ - { - "id": 76, - "name": "updateUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the user data. Changes are applied directly without confirmation flows." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "**Important:** This is a server-side operation and does **not** trigger client-side\n" - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " listeners. The admin API has no connection to client state.\n\nTo sync changes to the client after calling this method:\n1. On the client, call " - }, - { - "kind": "code", - "text": "`supabase.auth.refreshSession()`" - }, - { - "kind": "text", - "text": " to fetch the updated user data\n2. This will trigger the " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event and notify all listeners" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\n// Server-side (Edge Function)\nconst { data, error } = await supabase.auth.admin.updateUserById(\n userId,\n { user_metadata: { preferences: { theme: 'dark' } } }\n)\n\n// Client-side (to sync the changes)\nconst { data, error } = await supabase.auth.refreshSession()\n// onAuthStateChange listeners will now be notified with updated user\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.refreshSession", - "target": 410 - }, - { - "kind": "text", - "text": " for syncing admin changes to the client" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.updateUser", - "target": 386 - }, - { - "kind": "text", - "text": " for client-side user updates (triggers listeners automatically)" - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '11111111-1111-1111-1111-111111111111',\n { email: 'new@email.com' }\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updates a user's email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"new@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { password: 'new_password' }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { user_metadata: { hello: 'world' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's app_metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { app_metadata: { plan: 'trial' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's email address", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { email_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { phone_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Ban a user for 100 years", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { ban_duration: '876000h' }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 789, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L789" - } - ], - "parameters": [ - { - "id": 77, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "reference", - "target": 933, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [22, 20, 21, 23] - }, - { - "title": "Methods", - "children": [55, 79, 52, 72, 45, 58, 38, 75] - } - ], - "categories": [ - { - "title": "Auth", - "children": [55, 79, 52, 72, 45, 58, 38, 75] - }, - { - "title": "Other", - "children": [2, 22, 20, 21, 23] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 44, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L44" - } - ] - }, - { - "id": 136, - "name": "GoTrueClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 138, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L366" - } - ], - "signatures": [ - { - "id": 139, - "name": "GoTrueClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueClient } from '@supabase/auth-js'\n\nconst auth = new GoTrueClient({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { apikey: 'your-publishable-key' },\n storageKey: 'supabase-auth',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L366" - } - ], - "parameters": [ - { - "id": 140, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 748, - "name": "GoTrueClientOptions", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": 136, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 142, - "name": "admin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L234" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - }, - { - "id": 143, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the MFA methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L238" - } - ], - "type": { - "type": "reference", - "target": 1208, - "name": "GoTrueMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 144, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the OAuth 2.1 authorization server methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\nUsed to implement the authorization code flow on the consent page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 244, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L244" - } - ], - "type": { - "type": "reference", - "target": 1575, - "name": "AuthOAuthServerApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 145, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for passkey methods.\nIncludes lower-level two-step registration/authentication and passkey management.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 251, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L251" - } - ], - "type": { - "type": "reference", - "target": 1675, - "name": "AuthPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 579, - "name": "dispose", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5189, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5189" - } - ], - "signatures": [ - { - "id": 580, - "name": "dispose", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tears down the client's background work: stops the auto-refresh interval,\nremoves the " - }, - { - "kind": "code", - "text": "`visibilitychange`" - }, - { - "kind": "text", - "text": " listener, closes the cross-tab\n" - }, - { - "kind": "code", - "text": "`BroadcastChannel`" - }, - { - "kind": "text", - "text": ", and clears registered " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " subscribers.\n\nCall this from cleanup hooks when the client is being replaced before\nits JS realm is destroyed. React Strict Mode and HMR are the common\ncases. Any in-flight " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " calls continue to completion and may still\nwrite to storage; dispose doesn't abort them or erase storage.\n\nLifecycle caveat: because in-flight refreshes are not aborted, a\ndisposed instance can still persist a rotated session to storage after\n" - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " returns. A subsequent " - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " against the same\n" - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " will pick up that session on its next read. If you need\nstrict isolation between client lifecycles, await any pending auth\noperation before calling " - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " (or change the " - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " for\nthe replacement client).\n\nSafe to call repeatedly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup on React unmount", - "content": [ - { - "kind": "code", - "text": "```ts\nuseEffect(() => {\n const client = createClient(...)\n return () => { client.auth.dispose() }\n}, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5189, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5189" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 242, - "name": "exchangeCodeForSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1453, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1453" - } - ], - "signatures": [ - { - "id": 243, - "name": "exchangeCodeForSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Used when " - }, - { - "kind": "code", - "text": "`flowType`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`pkce`" - }, - { - "kind": "text", - "text": " in client options." - } - ] - }, - { - "tag": "@example", - "name": "Exchange Auth Code", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Exchange Auth Code\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n session: {\n access_token: '',\n token_type: 'bearer',\n expires_in: 3600,\n expires_at: 1700000000,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com'\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n \"provider\": \"email\",\n \"providers\": [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n provider_token: '',\n provider_refresh_token: ''\n },\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n redirectType: null\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1453, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1453" - } - ], - "parameters": [ - { - "id": 244, - "name": "authCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 662, - "name": "getClaims", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6145" - } - ], - "signatures": [ - { - "id": 663, - "name": "getClaims", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" - }, - { - "kind": "code", - "text": "`/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": ") to verify the JWT." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\n- A network request is sent to your project's JWT signing key discovery endpoint " - }, - { - "kind": "code", - "text": "`https://project-id.supabase.co/auth/v1/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": ", which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook)." - } - ] - }, - { - "tag": "@example", - "name": "Get JWT claims, header and signature", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getClaims()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get JWT claims, header and signature\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"claims\": {\n \"aal\": \"aal1\",\n \"amr\": [{\n \"method\": \"email\",\n \"timestamp\": 1715766000\n }],\n \"app_metadata\": {},\n \"aud\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"exp\": 1715769600,\n \"iat\": 1715766000,\n \"is_anonymous\": false,\n \"iss\": \"https://project-id.supabase.co/auth/v1\",\n \"phone\": \"+13334445555\",\n \"role\": \"authenticated\",\n \"session_id\": \"11111111-1111-1111-1111-111111111111\",\n \"sub\": \"11111111-1111-1111-1111-111111111111\",\n \"user_metadata\": {}\n },\n \"header\": {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"signature\": [/** Uint8Array */],\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6145" - } - ], - "parameters": [ - { - "id": 664, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getSession" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Various additional options that allow you to customize the\n behavior of this method." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 666, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 668, - "name": "allowExpired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " the " - }, - { - "kind": "code", - "text": "`exp`" - }, - { - "kind": "text", - "text": " claim will not be validated against the current time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6154, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6154" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 669, - "name": "jwks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 670, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 671, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1349, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [671] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ] - } - } - }, - { - "id": 667, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Please use options.jwks instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6151, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6151" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1349, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [668, 669, 667] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6147, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6147" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 673, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 674, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 675, - "name": "claims", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": 1329, - "name": "JwtPayload", - "package": "@supabase/auth-js" - } - }, - { - "id": 676, - "name": "header", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": 1313, - "name": "JwtHeader", - "package": "@supabase/auth-js" - } - }, - { - "id": 677, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [675, 676, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ] - } - } - }, - { - "id": 678, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6162, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6162" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [673, 678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6160" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 679, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 680, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 681, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [680, 681] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 682, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 683, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 684, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [683, 684] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 317, - "name": "getSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2719, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2719" - } - ], - "signatures": [ - { - "id": 318, - "name": "getSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser()" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " instead.\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\n- The session contains an access token (signed JWT), a refresh token and the user object.\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\n- When using in a browser, or you've called " - }, - { - "kind": "code", - "text": "`startAutoRefresh()`" - }, - { - "kind": "text", - "text": " in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or your own JWT verification library to securely establish the user's identity and access. You can also use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch the user object directly from the Auth server for this purpose.\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed." - } - ] - }, - { - "tag": "@example", - "name": "Get the session data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getSession()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the session data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2719, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2719" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 320, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2820, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2820" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 322, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2821, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2821" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [322] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2820, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2820" - } - ] - } - } - }, - { - "id": 323, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2823, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2823" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [320, 323] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2819, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2819" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 324, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 325, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2826, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2826" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 326, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 327, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2827, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2827" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [327] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2826, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2826" - } - ] - } - } - }, - { - "id": 328, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2829, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2829" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [325, 328] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2825, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2825" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 330, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2832, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2832" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 332, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2833, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2833" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [332] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2832, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2832" - } - ] - } - } - }, - { - "id": 333, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2835, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2835" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [330, 333] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2831, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2831" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 380, - "name": "getUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3042, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3042" - } - ], - "signatures": [ - { - "id": 381, - "name": "getUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method fetches the user object from the database instead of local session.\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\n- Should always be used when checking for user authorization on the server. On the client, you can instead use " - }, - { - "kind": "code", - "text": "`getSession().session.user`" - }, - { - "kind": "text", - "text": " for faster results. " - }, - { - "kind": "code", - "text": "`getSession`" - }, - { - "kind": "text", - "text": " is insecure on the server." - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with the current existing session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the logged in user with the current existing session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with a custom access token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3042, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3042" - } - ], - "parameters": [ - { - "id": 382, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 499, - "name": "getUserIdentities", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4337" - } - ], - "signatures": [ - { - "id": 500, - "name": "getUserIdentities", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets all the identities linked to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`getUserIdentities()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Returns a list of identities linked to the user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getUserIdentities()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Returns a list of identities linked to the user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"2024-01-01T00:00:00Z\",\n \"user_id\": \"2024-01-01T00:00:00Z\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ]\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4337" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 501, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 502, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4339, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4339" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 503, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 504, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4340, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4340" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [504] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4339, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4339" - } - ] - } - } - }, - { - "id": 505, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4342, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4342" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [502, 505] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4338, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4338" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 506, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 507, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 508, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [507, 508] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 226, - "name": "initialize", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L544" - } - ], - "signatures": [ - { - "id": 227, - "name": "initialize", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L544" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1289, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 213, - "name": "isThrowOnErrorEnabled", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 506, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L506" - } - ], - "signatures": [ - { - "id": 214, - "name": "isThrowOnErrorEnabled", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns whether error throwing mode is enabled for this client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 506, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L506" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 509, - "name": "linkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`linkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- If the candidate identity is already linked to the existing user or another user, " - }, - { - "kind": "code", - "text": "`linkIdentity()`" - }, - { - "kind": "text", - "text": " will fail.\n- If " - }, - { - "kind": "code", - "text": "`linkIdentity`" - }, - { - "kind": "text", - "text": " is run in the browser, the user is automatically redirected to the returned URL. On the server, you should handle the redirect." - } - ] - }, - { - "tag": "@example", - "name": "Link an identity to a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.linkIdentity({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Link an identity to a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4362, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4362" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4367, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4367" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4396, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4396" - } - ], - "signatures": [ - { - "id": 510, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4362, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4362" - } - ], - "parameters": [ - { - "id": 511, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 995, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 834, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 512, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an OIDC identity to an existing user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4367, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4367" - } - ], - "parameters": [ - { - "id": 513, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1007, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 461, - "name": "onAuthStateChange", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Subscribes to important events occurring on the user's session.\n- Use on the frontend/client. It is less useful on the server.\n- Events are emitted across tabs to keep your application's UI up-to-date. Some events can fire very frequently, based on the number of tabs open. Use a quick and efficient callback function, and defer or debounce as many operations as you can to be performed outside of the callback.\n- Callbacks can be " - }, - { - "kind": "code", - "text": "`async`" - }, - { - "kind": "text", - "text": " and can safely call other Supabase auth methods (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", etc.) from inside the callback.\n- Keep callbacks quick. Events are awaited in order, so a slow callback delays subsequent events to subscribers in this tab.\n- Emitted events:\n - " - }, - { - "kind": "code", - "text": "`INITIAL_SESSION`" - }, - { - "kind": "text", - "text": "\n - Emitted right after the Supabase client is constructed and the initial session from storage is loaded.\n - " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": "\n - Emitted each time a user session is confirmed or re-established, including on user sign in and when refocusing a tab.\n - Avoid making assumptions as to when this event is fired, this may occur even when the user is already signed in. Instead, check the user object attached to the event to see if a new user has signed in and update your application's UI.\n - This event can fire very frequently depending on the number of tabs open in your application.\n - " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": "\n - Emitted when the user signs out. This can be after:\n - A call to " - }, - { - "kind": "code", - "text": "`supabase.auth.signOut()`" - }, - { - "kind": "text", - "text": ".\n - After the user's session has expired for any reason:\n - User has signed out on another device.\n - The session has reached its timebox limit or inactivity timeout.\n - User has signed in on another device with single session per user enabled.\n - Check the [User Sessions](/docs/guides/auth/sessions) docs for more information.\n - Use this to clean up any local storage your application has associated with the user.\n - " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": "\n - Emitted each time a new access and refresh token are fetched for the signed in user.\n - It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application.\n - Avoid frequent calls to " - }, - { - "kind": "code", - "text": "`supabase.auth.getSession()`" - }, - { - "kind": "text", - "text": " for the same purpose.\n - There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event.\n - The frequency of this event is related to the JWT expiry limit configured on your project.\n - " - }, - { - "kind": "code", - "text": "`USER_UPDATED`" - }, - { - "kind": "text", - "text": "\n - Emitted each time the " - }, - { - "kind": "code", - "text": "`supabase.auth.updateUser()`" - }, - { - "kind": "text", - "text": " method finishes successfully. Listen to it to update your application's UI based on new profile information.\n - " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": "\n - Emitted instead of the " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event when the user lands on a page that includes a password recovery link in the URL.\n - Use it to show a UI to the user where they can [reset their password](/docs/guides/auth/passwords#resetting-a-users-password-forgot-password)." - } - ] - }, - { - "tag": "@example", - "name": "Listen to auth changes", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase.auth.onAuthStateChange((event, session) => {\n console.log(event, session)\n\n if (event === 'INITIAL_SESSION') {\n // handle initial session\n } else if (event === 'SIGNED_IN') {\n // handle sign in event\n } else if (event === 'SIGNED_OUT') {\n // handle sign out event\n } else if (event === 'PASSWORD_RECOVERY') {\n // handle password recovery event\n } else if (event === 'TOKEN_REFRESHED') {\n // handle token refreshed event\n } else if (event === 'USER_UPDATED') {\n // handle user updated event\n }\n})\n\n// call unsubscribe to remove the callback\ndata.subscription.unsubscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to sign out\nMake sure you clear out any local data, such as local and session storage, after the client library has detected the user's sign out." - } - ] - }, - { - "tag": "@example", - "name": "Listen to sign out", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'SIGNED_OUT') {\n console.log('SIGNED_OUT', session)\n\n // clear local and session storage\n [\n window.localStorage,\n window.sessionStorage,\n ].forEach((storage) => {\n Object.entries(storage)\n .forEach(([key]) => {\n storage.removeItem(key)\n })\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Store OAuth provider tokens on sign in\nWhen using [OAuth (Social Login)](/docs/guides/auth/social-login) you sometimes wish to get access to the provider's access token and refresh token, in order to call provider APIs in the name of the user.\n\nFor example, if you are using [Sign in with Google](/docs/guides/auth/social-login/auth-google) you may want to use the provider token to call Google APIs on behalf of the user. Supabase Auth does not keep track of the provider access and refresh token, but does return them for you once, immediately after sign in. You can use the " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " method to listen for the presence of the provider tokens and store them in local storage. You can further send them to your server's APIs for use on the backend.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Store OAuth provider tokens on sign in", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Use React Context for the User's session\nInstead of relying on " - }, - { - "kind": "code", - "text": "`supabase.auth.getSession()`" - }, - { - "kind": "text", - "text": " within your React components, you can use a [React Context](https://react.dev/reference/react/createContext) to store the latest session information from the " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback and access it that way." - } - ] - }, - { - "tag": "@example", - "name": "Use React Context for the User's session", - "content": [ - { - "kind": "code", - "text": "```js\nconst SessionContext = React.createContext(null)\n\nfunction main() {\n const [session, setSession] = React.useState(null)\n\n React.useEffect(() => {\n const {data: { subscription }} = supabase.auth.onAuthStateChange(\n (event, session) => {\n if (event === 'SIGNED_OUT') {\n setSession(null)\n } else if (session) {\n setSession(session)\n }\n })\n\n return () => {\n subscription.unsubscribe()\n }\n }, [])\n\n return (\n \n \n \n )\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to password recovery events", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'PASSWORD_RECOVERY') {\n console.log('PASSWORD_RECOVERY', session)\n // show screen to update user's password\n showPasswordResetScreen(true)\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to sign in", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'SIGNED_IN') console.log('SIGNED_IN', session)\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to token refresh", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'TOKEN_REFRESHED') console.log('TOKEN_REFRESHED', session)\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to user updates", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'USER_UPDATED') console.log('USER_UPDATED', session)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4128" - } - ], - "signatures": [ - { - "id": 462, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens.\nSafe to use without an async function as callback." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "parameters": [ - { - "id": 463, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 464, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "signatures": [ - { - "id": 465, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "parameters": [ - { - "id": 466, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 467, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 469, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 471, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ], - "type": { - "type": "reference", - "target": 947, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [471] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [469] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 90, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ] - } - } - }, - { - "id": 472, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens. Common reentry\npatterns (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", reading the session from inside a\nhandler) complete normally. One hazard remains: calling " - }, - { - "kind": "code", - "text": "`refreshSession`" - }, - { - "kind": "text", - "text": "\n(or anything that routes through " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": ") from inside a\n" - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " handler. " - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " resolves only after\n" - }, - { - "kind": "code", - "text": "`_notifyAllSubscribers`" - }, - { - "kind": "text", - "text": " returns, so the inner refresh dedupes onto the\nouter's unresolved promise and the two wait on each other." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Async callbacks can deadlock when they trigger a nested\nrefresh from a " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event. Prefer the sync overload, or move\nrefresh-triggering work outside the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "parameters": [ - { - "id": 473, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 474, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "signatures": [ - { - "id": 475, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "parameters": [ - { - "id": 476, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 477, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 478, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 479, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 481, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ], - "type": { - "type": "reference", - "target": 947, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [481] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [479] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 99, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ] - } - } - } - ] - }, - { - "id": 310, - "name": "reauthenticate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2497" - } - ], - "signatures": [ - { - "id": 311, - "name": "reauthenticate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used together with " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " when a user's password needs to be updated.\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\n- After receiving the OTP, include it as the " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " in your " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " call to finalize the password change." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Send reauthentication nonce\nSends a reauthentication nonce to the user's email or phone number." - } - ] - }, - { - "tag": "@example", - "name": "Send reauthentication nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.reauthenticate()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2497" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 410, - "name": "refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "signatures": [ - { - "id": 411, - "name": "refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method will refresh and return a new session whether the current one is expired or not." - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using the current session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession()\nconst { session, user } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Refresh session using the current session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using a refresh token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\nconst { session, user } = data\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "parameters": [ - { - "id": 412, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session. If passed in, it must contain a refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 414, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 688, - "name": "registerPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6325, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6325" - } - ], - "signatures": [ - { - "id": 689, - "name": "registerPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Register a passkey for the current authenticated user. Handles the full WebAuthn ceremony:\n1. Fetches registration challenge from server\n2. Prompts user via navigator.credentials.create()\n3. Verifies credential with server\n\nRequires an active session. Requires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6325, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6325" - } - ], - "parameters": [ - { - "id": 690, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1633, - "name": "RegisterPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 314, - "name": "resend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2593, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2593" - } - ], - "signatures": [ - { - "id": 315, - "name": "resend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Resends a signup confirmation, email change or phone change email to the user.\n- Passwordless sign-ins can be resent by calling the " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " method again.\n- Password recovery emails can be resent by calling the " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " method again.\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " again to resend the OTP).\n- You can specify a redirect url when you resend an email link using the " - }, - { - "kind": "code", - "text": "`emailRedirectTo`" - }, - { - "kind": "text", - "text": " option." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend an email signup confirmation\nResends the email signup confirmation to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend an email signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'signup',\n email: 'email@example.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend a phone signup confirmation\nResends the phone signup confirmation email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend a phone signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'sms',\n phone: '1234567890'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend email change email\nResends the email change email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend email change email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'email_change',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend phone change OTP\nResends the phone change OTP to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend phone change OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'phone_change',\n phone: '1234567890'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2593, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2593" - } - ], - "parameters": [ - { - "id": 316, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1093, - "name": "ResendParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 820, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 485, - "name": "resetPasswordForEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4253, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4253" - } - ], - "signatures": [ - { - "id": 486, - "name": "resetPasswordForEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a password reset request to an email address. This method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\n- The " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " only sends a password reset link to the user's email.\nTo update the user's password, see [" - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-updateuser).\n- A " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": " event will be emitted when the password recovery link is clicked.\nYou can use [" - }, - { - "kind": "code", - "text": "`onAuthStateChange()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\n- When the user clicks the reset link in the email they are redirected back to your application.\nYou can configure the URL that the user is redirected to with the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter.\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- After the user has been redirected successfully, prompt them for a new password and call " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": ":\n" - }, - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: new_password\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\n redirectTo: 'https://example.com/update-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Reset password\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {}\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password (React)", - "content": [ - { - "kind": "code", - "text": "```js\n/**\n * Step 1: Send the user an email to get a password reset token.\n * This email contains a link which sends the user back to your application.\n */\nconst { data, error } = await supabase.auth\n .resetPasswordForEmail('user@email.com')\n\n/**\n * Step 2: Once the user is redirected back to your application,\n * ask the user to reset their password.\n */\n useEffect(() => {\n supabase.auth.onAuthStateChange(async (event, session) => {\n if (event == \"PASSWORD_RECOVERY\") {\n const newPassword = prompt(\"What would you like your new password to be?\");\n const { data, error } = await supabase.auth\n .updateUser({ password: newPassword })\n\n if (data) alert(\"Password updated successfully!\")\n if (error) alert(\"There was an error updating your password.\")\n }\n })\n }, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4253, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4253" - } - ], - "parameters": [ - { - "id": 487, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 488, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 489, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 491, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4257, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4257" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 490, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to send the user to after they click the password reset link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4256, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4256" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [491, 490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4255, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4255" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 492, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 493, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4261, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4261" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 494, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 495, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4262, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4262" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [493, 495] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4260, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4260" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 496, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 497, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 498, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [497, 498] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 398, - "name": "setSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ], - "signatures": [ - { - "id": 399, - "name": "setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method sets the session using an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`refresh_token`" - }, - { - "kind": "text", - "text": ".\n- If successful, a " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event is emitted." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Set the session\nSets the session data from an access_token and refresh_token, then returns an auth response or error." - } - ] - }, - { - "tag": "@example", - "name": "Set the session", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.setSession({\n access_token,\n refresh_token\n })\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set the session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"11111111-1111-1111-1111-111111111111\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"2024-01-01T00:00:00Z\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"token_type\": \"bearer\",\n \"expires_in\": 3500,\n \"expires_at\": 1700000000\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ], - "parameters": [ - { - "id": 400, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session that minimally contains an access token and refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 401, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 402, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3421, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3421" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 403, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3422, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3422" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [402, 403] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 230, - "name": "signInAnonymously", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 722, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L722" - } - ], - "signatures": [ - { - "id": 231, - "name": "signInAnonymously", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new anonymous user." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A session where the is_anonymous claim in the access token JWT set to true" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Returns an anonymous user\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the " - }, - { - "kind": "code", - "text": "`options`" - }, - { - "kind": "text", - "text": " param." - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n captchaToken\n }\n});\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create an anonymous user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user with custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n data\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 722, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L722" - } - ], - "parameters": [ - { - "id": 232, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 957, - "name": "SignInAnonymouslyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 298, - "name": "signInWithIdToken", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2030, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2030" - } - ], - "signatures": [ - { - "id": 299, - "name": "signInWithIdToken", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use an ID token to sign in.\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API." - } - ] - }, - { - "tag": "@example", - "name": "Sign In using ID Token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithIdToken({\n provider: 'google',\n token: 'your-id-token'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign In using ID Token\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2030, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2030" - } - ], - "parameters": [ - { - "id": 300, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1007, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 239, - "name": "signInWithOAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1274" - } - ], - "signatures": [ - { - "id": 240, - "name": "signInWithOAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider with redirect\n- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter. This parameter defaults to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider with redirect", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n redirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with scopes and access provider tokens\nIf you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the " - }, - { - "kind": "code", - "text": "`scopes`" - }, - { - "kind": "text", - "text": " option takes in **a space-separated list** of scopes.\n\nBecause OAuth sign-in often includes redirects, you should register an " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback immediately after you create the Supabase client. This callback will listen for the presence of " - }, - { - "kind": "code", - "text": "`provider_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`provider_refresh_token`" - }, - { - "kind": "text", - "text": " properties on the " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with scopes and access provider tokens", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n\n// Call this on your Sign in with GitHub button to initiate OAuth\n// with GitHub with the requested elevated scopes.\nawait supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n scopes: 'repo gist notifications'\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1274" - } - ], - "parameters": [ - { - "id": 241, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 995, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 834, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 301, - "name": "signInWithOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2143" - } - ], - "signatures": [ - { - "id": 302, - "name": "signInWithOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " 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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email or phone number.\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\n- If the user doesn't exist, " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " will signup the user instead. To restrict this behavior, you can set " - }, - { - "kind": "code", - "text": "`shouldCreateUser`" - }, - { - "kind": "text", - "text": " in " - }, - { - "kind": "code", - "text": "`SignInWithPasswordlessCredentials.options`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ".\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\n- If you're using phone, you can configure whether you want the user to receive a OTP.\n- The magic link's destination URL is determined by the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": ".\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with email\nThe user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n email: 'example@email.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": null,\n \"session\": null\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with SMS OTP\nThe user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with SMS OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with WhatsApp OTP\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with WhatsApp OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n options: {\n channel:'whatsapp',\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2143" - } - ], - "parameters": [ - { - "id": 303, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 976, - "name": "SignInWithPasswordlessCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 820, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 685, - "name": "signInWithPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6267" - } - ], - "signatures": [ - { - "id": 686, - "name": "signInWithPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with a passkey. Handles the full WebAuthn ceremony:\n1. Fetches authentication challenge from server\n2. Prompts user via navigator.credentials.get()\n3. Verifies credential with server and creates session\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6267" - } - ], - "parameters": [ - { - "id": 687, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1627, - "name": "SignInWithPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 236, - "name": "signInWithPassword", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1135" - } - ], - "signatures": [ - { - "id": 237, - "name": "signInWithPassword", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user with an email and password or phone and password.\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\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email and password or a phone number and password." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email and password\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with phone and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n phone: '+13334445555',\n password: 'some-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nLog the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so fields like " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " aren't hidden. The " - }, - { - "kind": "code", - "text": "`error.code`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`'invalid_credentials'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'email_not_confirmed'`" - }, - { - "kind": "text", - "text": ") is often more useful for branching than " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": ", and the full object surfaces both." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\nif (error) {\n console.error(error)\n return\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1135" - } - ], - "parameters": [ - { - "id": 238, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 971, - "name": "SignInWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 829, - "name": "AuthTokenResponsePassword", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 307, - "name": "signInWithSSO", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2434, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2434" - } - ], - "signatures": [ - { - "id": 308, - "name": "signInWithSSO", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\n- If you've associated an email domain to the identity provider, you can use the " - }, - { - "kind": "code", - "text": "`domain`" - }, - { - "kind": "text", - "text": " property to start a sign-in flow.\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the " - }, - { - "kind": "code", - "text": "`providerId`" - }, - { - "kind": "text", - "text": " property. For example:\n - Mapping specific user email addresses with an identity provider.\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email domain", - "content": [ - { - "kind": "code", - "text": "```js\n // You can extract the user's email domain and use it to trigger the\n // authentication flow with the correct identity provider.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n domain: 'company.com'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with provider UUID", - "content": [ - { - "kind": "code", - "text": "```js\n // Useful when you need to map a user's sign in request according\n // to different rules that can't use email domains.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2434, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2434" - } - ], - "parameters": [ - { - "id": 309, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1107, - "name": "SignInWithSSO", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 847, - "name": "SSOResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 245, - "name": "signInWithWeb3", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1554, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1554" - } - ], - "signatures": [ - { - "id": 246, - "name": "signInWithWeb3", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." - } - ], - "blockTags": [ - { - "tag": "@reference", - "content": [ - { - "kind": "text", - "text": "https://eips.ethereum.org/EIPS/eip-4361" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana or Ethereum (Window API)", - "content": [ - { - "kind": "code", - "text": "```js\n // uses window.ethereum for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n\n // uses window.solana for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Ethereum (Message and Signature)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n message: '',\n signature: '',\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Brave)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet: window.braveSolana\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Wallet Adapter)", - "content": [ - { - "kind": "code", - "text": "```jsx\n function SignInButton() {\n const wallet = useWallet()\n\n return (\n <>\n {wallet.connected ? (\n {\n supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet,\n })\n }}\n >\n Sign in with Solana\n \n ) : (\n \n )}\n \n )\n}\n\nfunction App() {\n const endpoint = clusterApiUrl('devnet')\n const wallets = useMemo(() => [], [])\n\n return (\n \n \n \n \n \n \n \n )\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1554, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1554" - } - ], - "parameters": [ - { - "id": 247, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1068, - "name": "Web3Credentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 248, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 249, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 250, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 251, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 252, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [251, 252] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ] - } - } - }, - { - "id": 253, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1557, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1557" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [249, 253] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1555, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1555" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 254, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 255, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 256, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 257, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 258, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [257, 258] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ] - } - } - }, - { - "id": 259, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [255, 259] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 451, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "signatures": [ - { - "id": 452, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inside a browser context, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " - }, - { - "kind": "code", - "text": "`\"SIGNED_OUT\"`" - }, - { - "kind": "text", - "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " - }, - { - "kind": "code", - "text": "`auth.api.signOut(JWT: string)`" - }, - { - "kind": "text", - "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " - }, - { - "kind": "code", - "text": "`others`" - }, - { - "kind": "text", - "text": " scope, no " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event is fired!\n\n**Warning:** the default " - }, - { - "kind": "code", - "text": "`scope`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`'global'`" - }, - { - "kind": "text", - "text": ". This signs the user out of\n**every device they are currently signed in on**, not just the current\ntab/session. If you only want to sign the user out of the current session\n(the behavior most other auth libraries default to), pass\n" - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " explicitly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " uses the **global** scope, which signs out the user\n on every device they are signed in on (not just the current one). Pass\n " - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " to only sign out the current session. This is\n usually what apps want on a \"Sign out\" button, especially when users\n sign in from multiple devices and do not expect signing out of one to\n terminate the others.\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires." - } - ] - }, - { - "tag": "@example", - "name": "Sign out of every device (global – default)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out only the current session (recommended for most apps)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out of all other sessions, keep the current one", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "parameters": [ - { - "id": 453, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1304, - "name": "SignOut", - "package": "@supabase/auth-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 455, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [455] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 65, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 233, - "name": "signUp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 932, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L932" - } - ], - "signatures": [ - { - "id": 234, - "name": "signUp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A logged-in session if the server has \"autoconfirm\" ON" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A user if the server has \"autoconfirm\" OFF" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\n- **Confirm email** determines if users need to confirm their email address after signing up.\n - If **Confirm email** is enabled, a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " is returned but " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " is null.\n - If **Confirm email** is disabled, both a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " and a " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " are returned.\n- When the user confirms their email address, they are redirected to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your " - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": " or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\n- If signUp() is called for an existing confirmed user:\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, " - }, - { - "kind": "code", - "text": "`User already registered`" - }, - { - "kind": "text", - "text": " is returned.\n- To fetch the currently logged-in user, refer to [" - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-getuser)." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with an email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign up with an email and password\n" - }, - { - "kind": "code", - "text": "```json\n// Some fields may be null if \"confirm email\" is enabled.\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (SMS)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'sms'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a phone number and password (whatsapp)\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (whatsapp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'whatsapp'\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with additional user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n data: {\n first_name: 'John',\n age: 27,\n }\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a redirect URL\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a redirect URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 932, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L932" - } - ], - "parameters": [ - { - "id": 235, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 963, - "name": "SignUpWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 575, - "name": "startAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5119, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5119" - } - ], - "signatures": [ - { - "id": 576, - "name": "startAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClientOptions#autoRefreshToken", - "target": 764 - }, - { - "kind": "text", - "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "#stopAutoRefresh" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- To give this hint to the application, you should be calling this method when the app is in focus and calling " - }, - { - "kind": "code", - "text": "`supabase.auth.stopAutoRefresh()`" - }, - { - "kind": "text", - "text": " when it's out of focus." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5119, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5119" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 577, - "name": "stopAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5154, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5154" - } - ], - "signatures": [ - { - "id": 578, - "name": "stopAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#startAutoRefresh" - }, - { - "kind": "text", - "text": " for more details." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5154, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5154" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 520, - "name": "unlinkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4516, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4516" - } - ], - "signatures": [ - { - "id": 521, - "name": "unlinkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`unlinkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- The user must have at least 2 identities in order to unlink an identity.\n- The identity to be unlinked must belong to the user." - } - ] - }, - { - "tag": "@example", - "name": "Unlink an identity", - "content": [ - { - "kind": "code", - "text": "```js\n// retrieve all identities linked to a user\nconst identities = await supabase.auth.getUserIdentities()\n\n// find the google identity\nconst googleIdentity = identities.find(\n identity => identity.provider === 'google'\n)\n\n// unlink the google identity\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4516, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4516" - } - ], - "parameters": [ - { - "id": 522, - "name": "identity", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 524, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4518, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4518" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 525, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 526, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4519, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4519" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [524, 526] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4517, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4517" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 528, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 529, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [528, 529] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 386, - "name": "updateUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3224, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3224" - } - ], - "signatures": [ - { - "id": 387, - "name": "updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates user data for a logged in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, email updates sends a confirmation link to both the user's current and new email.\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers)." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\nSends a \"Confirm Email Change\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email)." - } - ] - }, - { - "tag": "@example", - "name": "Update the email for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n email: 'new@email.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"new_email\": \"new@email.com\",\n \"email_change_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the phone number for an authenticated user\nSends a one-time password (OTP) to the new phone number." - } - ] - }, - { - "tag": "@example", - "name": "Update the phone number for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n phone: '123456789'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update the password for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's metadata\nUpdates the user's custom metadata.\n\n**Note**: The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column in your Supabase database. When calling " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": ", the data will be available as " - }, - { - "kind": "code", - "text": "`user.user_metadata`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n data: { hello: 'world' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's password with a nonce\nIf **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's password with a nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password',\n nonce: '123456'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3224, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3224" - } - ], - "parameters": [ - { - "id": 388, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 926, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 389, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 391, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3227, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [391] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3226, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3226" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 304, - "name": "verifyOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2334" - } - ], - "signatures": [ - { - "id": 305, - "name": "verifyOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " method takes in different verification types.\n- If a phone number is used, the type can either be:\n 1. " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new phone number during a phone number update process.\n- If an email address is used, the type can be one of the following (note: " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": " types are deprecated):\n 1. " - }, - { - "kind": "code", - "text": "`email`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent for account recovery, typically after a password reset request.\n 3. " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent as part of an invitation to join a project or organization.\n 4. " - }, - { - "kind": "code", - "text": "`email_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new email address during an email update process.\n- The verification type used should be determined based on the corresponding auth method called before " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " to sign up / sign-in a user.\n- The " - }, - { - "kind": "code", - "text": "`TokenHash`" - }, - { - "kind": "text", - "text": " is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details." - } - ] - }, - { - "tag": "@example", - "name": "Verify Signup One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify Signup One-Time Password (OTP)\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify SMS One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify Email Auth (Token Hash)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2334" - } - ], - "parameters": [ - { - "id": 306, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1069, - "name": "VerifyOtpParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [138] - }, - { - "title": "Properties", - "children": [142, 143, 144, 145] - }, - { - "title": "Methods", - "children": [ - 579, 242, 662, 317, 380, 499, 226, 213, 509, 461, 310, 410, 688, 314, 485, 398, 230, - 298, 239, 301, 685, 236, 307, 245, 451, 233, 575, 577, 520, 386, 304 - ] - } - ], - "categories": [ - { - "title": "Auth", - "children": [ - 579, 242, 662, 317, 380, 499, 226, 509, 461, 310, 410, 688, 314, 485, 398, 230, 298, - 239, 301, 685, 236, 307, 245, 451, 233, 575, 577, 520, 386, 304 - ] - }, - { - "title": "Other", - "children": [138, 142, 143, 144, 145, 213] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 225, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L225" - } - ] - }, - { - "id": 720, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client doesn't call " - }, - { - "kind": "code", - "text": "`navigator.locks`" - }, - { - "kind": "text", - "text": ", so this error\nnever originates from " - }, - { - "kind": "code", - "text": "`supabase.auth.*`" - }, - { - "kind": "text", - "text": " calls. Direct callers of\n" - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " still receive it on acquire timeout." - } - ] - } - ] - }, - "children": [ - { - "id": 721, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L39" - } - ], - "signatures": [ - { - "id": 722, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L39" - } - ], - "parameters": [ - { - "id": 723, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 720, - "name": "NavigatorLockAcquireTimeoutError", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - }, - { - "id": 724, - "name": "isAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true, - "isReadonly": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L37" - } - ], - "type": { - "type": "literal", - "value": true - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.isAcquireTimeout" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [721] - }, - { - "title": "Properties", - "children": [724] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 49, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L49" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError" - }, - "name": "LockAcquireTimeoutError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 933, - "name": "AdminUserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 935, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's application specific metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.app_metadata`" - }, - { - "kind": "text", - "text": " column.\n\nOnly a service role can modify.\n\nThe " - }, - { - "kind": "code", - "text": "`app_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 544, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L544" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 938, - "name": "ban_duration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L570" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 946, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.current_password" - } - }, - { - "id": 944, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 495, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L495" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.email" - } - }, - { - "id": 936, - "name": "email_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's email as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L551" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 941, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " for the user.\n\nAllows you to overwrite the default " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " set for the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 595, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L595" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 942, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.nonce" - } - }, - { - "id": 945, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 505, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L505" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.password" - } - }, - { - "id": 940, - "name": "password_hash", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`password_hash`" - }, - { - "kind": "text", - "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 588, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L588" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 943, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L500" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.phone" - } - }, - { - "id": 937, - "name": "phone_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's phone as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 558, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L558" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 939, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " - }, - { - "kind": "code", - "text": "`authenticated`" - }, - { - "kind": "text", - "text": " by default. You should only modify the " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " is not recommended as it grants the user admin privileges." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 579, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L579" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 934, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\n\nThe " - }, - { - "kind": "code", - "text": "`user_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 534, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L534" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [935, 938, 946, 944, 936, 941, 942, 945, 940, 943, 937, 939, 934] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 523, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L523" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 926, - "name": "UserAttributes", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "data" - } - ], - "name": "Omit", - "package": "typescript" - } - ] - }, - { - "id": 864, - "name": "AMREntry", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An authentication method reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time.\n\nNote: Custom access token hooks can return AMR claims as either:\n- An array of AMREntry objects (detailed format with timestamps)\n- An array of strings (RFC-8176 compliant format)" - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 1262 - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "children": [ - { - "id": 865, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication method name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 369, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L369" - } - ], - "type": { - "type": "reference", - "target": 862, - "name": "AMRMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 866, - "name": "timestamp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 375, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L375" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [865, 866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 367, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L367" - } - ] - }, - { - "id": 1575, - "name": "AuthOAuthServerApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth 2.1 authorization server user-facing methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThese methods are used to implement the consent page." - } - ] - }, - "children": [ - { - "id": 1579, - "name": "approveAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2633, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2633" - } - ], - "signatures": [ - { - "id": 1580, - "name": "approveAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Approves an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter approval, the user's consent is stored and an authorization code is generated.\nThe response contains a complete redirect URL with the authorization code and state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with authorization code" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2633, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2633" - } - ], - "parameters": [ - { - "id": 1581, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to approve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1582, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1583, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1584, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2635, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2635" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1584] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2635, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2635" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1566, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1585, - "name": "denyAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2653" - } - ], - "signatures": [ - { - "id": 1586, - "name": "denyAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Denies an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter denial, the response contains a redirect URL with an OAuth error\n(access_denied) to inform the OAuth client that the user rejected the request." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with error information" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2653" - } - ], - "parameters": [ - { - "id": 1587, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to deny" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1588, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1589, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1590, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2655, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2655" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1590] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2655, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2655" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1566, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1576, - "name": "getAuthorizationDetails", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2616" - } - ], - "signatures": [ - { - "id": 1577, - "name": "getAuthorizationDetails", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves details about an OAuth authorization request.\nUsed to display consent information to the user.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis method returns one of two response types:\n- " - }, - { - "kind": "code", - "text": "`OAuthAuthorizationDetails`" - }, - { - "kind": "text", - "text": ": User needs to consent - show consent page with client info\n- " - }, - { - "kind": "code", - "text": "`OAuthRedirect`" - }, - { - "kind": "text", - "text": ": User already consented - redirect immediately to the OAuth client\n\nUse type narrowing to distinguish between the responses:\n" - }, - { - "kind": "code", - "text": "```typescript\nif ('authorization_id' in data) {\n // Show consent page\n} else {\n // Redirect to data.redirect_url\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Authorization details or redirect URL depending on consent status" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2616" - } - ], - "parameters": [ - { - "id": 1578, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID from the authorization request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "AuthOAuthAuthorizationDetailsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1591, - "name": "listGrants", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2667" - } - ], - "signatures": [ - { - "id": 1592, - "name": "listGrants", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth grants that the authenticated user has authorized.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Response with array of OAuth grants with client information and granted scopes" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2667" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1572, - "name": "AuthOAuthGrantsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1593, - "name": "revokeGrant", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "signatures": [ - { - "id": 1594, - "name": "revokeGrant", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revokes a user's OAuth grant for a specific client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\nand invalidates associated refresh tokens." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Empty response on successful revocation" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "parameters": [ - { - "id": 1595, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revocation options" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1597, - "name": "clientId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client identifier (UUID) to revoke access for" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1597] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1573, - "name": "AuthOAuthRevokeGrantResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1579, 1585, 1576, 1591, 1593] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1579, 1585, 1576, 1591, 1593] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2591, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2591" - } - ] - }, - { - "id": 1675, - "name": "AuthPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lower-level two-step API and management methods for passkeys.\nAccess via " - }, - { - "kind": "code", - "text": "`supabase.auth.passkey`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "children": [ - { - "id": 1692, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2883, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2883" - } - ], - "signatures": [ - { - "id": 1693, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a passkey for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2883, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2883" - } - ], - "parameters": [ - { - "id": 1694, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1655, - "name": "PasskeyDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1667, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1687, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2867, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2867" - } - ], - "signatures": [ - { - "id": 1688, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2867, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2867" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1665, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1681, - "name": "startAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2845, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2845" - } - ], - "signatures": [ - { - "id": 1682, - "name": "startAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey authentication ceremony. Fetches an authentication\nchallenge and credential request options from the server. Used as the\nfirst step of a two-step sign-in flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.get()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2845, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2845" - } - ], - "parameters": [ - { - "id": 1683, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1642, - "name": "StartPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1660, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1676, - "name": "startRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2822, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2822" - } - ], - "signatures": [ - { - "id": 1677, - "name": "startRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey registration ceremony. Fetches a registration challenge\nand credential creation options from the server. Used as the first step of\na two-step registration flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.create()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2822, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2822" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1658, - "name": "AuthPasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1689, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2875, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2875" - } - ], - "signatures": [ - { - "id": 1690, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a passkey's friendly name." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2875, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2875" - } - ], - "parameters": [ - { - "id": 1691, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1651, - "name": "PasskeyUpdateParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1666, - "name": "AuthPasskeyUpdateResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1684, - "name": "verifyAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2856, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2856" - } - ], - "signatures": [ - { - "id": 1685, - "name": "verifyAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey authentication credential against a previously issued\nchallenge. Used as the second step of a two-step sign-in flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2856, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2856" - } - ], - "parameters": [ - { - "id": 1686, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1647, - "name": "VerifyPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1678, - "name": "verifyRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2831, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2831" - } - ], - "signatures": [ - { - "id": 1679, - "name": "verifyRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey registration credential against a previously issued\nchallenge. Used as the second step of a two-step registration flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2831, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2831" - } - ], - "parameters": [ - { - "id": 1680, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1638, - "name": "VerifyPasskeyRegistrationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1692, 1687, 1681, 1676, 1689, 1684, 1678] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1692, 1687, 1681, 1676, 1689, 1684, 1678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2811, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2811" - } - ] - }, - { - "id": 1144, - "name": "GenerateLinkOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1145, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 954, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L954" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1146, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 956, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L956" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1145, 1146] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 948, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L948" - } - ] - }, - { - "id": 1526, - "name": "GoTrueAdminCustomProvidersApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "children": [ - { - "id": 1530, - "name": "createProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2425" - } - ], - "signatures": [ - { - "id": 1531, - "name": "createProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new custom OIDC/OAuth provider.\n\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\nfrom the issuer's well-known endpoint (or the provided " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": ") at creation time.\nThis may return a validation error (" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\nin the document does not match the expected issuer.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2425" - } - ], - "parameters": [ - { - "id": 1532, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1471, - "name": "CreateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1540, - "name": "deleteProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "signatures": [ - { - "id": 1541, - "name": "deleteProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a custom provider.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "parameters": [ - { - "id": 1542, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1543, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1544, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1545, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 60, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1544, 1545] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1533, - "name": "getProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2435" - } - ], - "signatures": [ - { - "id": 1534, - "name": "getProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific custom provider by identifier.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2435" - } - ], - "parameters": [ - { - "id": 1535, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1527, - "name": "listProviders", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2409" - } - ], - "signatures": [ - { - "id": 1528, - "name": "listProviders", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all custom providers with optional type filter.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2409" - } - ], - "parameters": [ - { - "id": 1529, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1511, - "name": "ListCustomProvidersParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1515, - "name": "CustomProviderListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1536, - "name": "updateProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2450" - } - ], - "signatures": [ - { - "id": 1537, - "name": "updateProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing custom provider.\n\nWhen " - }, - { - "kind": "code", - "text": "`issuer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": " is changed on an OIDC provider, the server re-fetches and\nvalidates the discovery document before persisting. This may return a validation error\n(" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery document is unreachable, invalid, or\nthe issuer does not match.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2450" - } - ], - "parameters": [ - { - "id": 1538, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1539, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1492, - "name": "UpdateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1530, 1540, 1533, 1527, 1536] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1530, 1540, 1533, 1527, 1536] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2400, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2400" - } - ] - }, - { - "id": 1279, - "name": "GoTrueAdminMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication administration API." - } - ], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "children": [ - { - "id": 1283, - "name": "deleteFactor", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1795, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1795" - } - ], - "signatures": [ - { - "id": 1284, - "name": "deleteFactor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#unenroll", - "target": 1254 - } - ] - }, - { - "tag": "@expermental", - "content": [] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Delete a factor for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a factor for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1795, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1795" - } - ], - "parameters": [ - { - "id": 1285, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1269, - "name": "AuthMFAAdminDeleteFactorParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1266, - "name": "AuthMFAAdminDeleteFactorResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1280, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1764, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1764" - } - ], - "signatures": [ - { - "id": 1281, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all factors associated to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "List all factors for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "List all factors for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n factors: Factor[\n {\n id: '',\n friendly_name: 'Auth App Factor',\n factor_type: 'totp',\n status: 'verified',\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z'\n }\n ]\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1764, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1764" - } - ], - "parameters": [ - { - "id": 1282, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1276, - "name": "AuthMFAAdminListFactorsParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1273, - "name": "AuthMFAAdminListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1283, 1280] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1283, 1280] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1732, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1732" - } - ] - }, - { - "id": 1411, - "name": "GoTrueAdminOAuthApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "children": [ - { - "id": 1415, - "name": "createClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2155" - } - ], - "signatures": [ - { - "id": 1416, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2155" - } - ], - "parameters": [ - { - "id": 1417, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1381, - "name": "CreateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1425, - "name": "deleteClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "signatures": [ - { - "id": 1426, - "name": "deleteClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "parameters": [ - { - "id": 1427, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1428, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1429, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1430, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1429, 1430] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1418, - "name": "getClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2166" - } - ], - "signatures": [ - { - "id": 1419, - "name": "getClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2166" - } - ], - "parameters": [ - { - "id": 1420, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1412, - "name": "listClients", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2144" - } - ], - "signatures": [ - { - "id": 1413, - "name": "listClients", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth clients with optional pagination.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2144" - } - ], - "parameters": [ - { - "id": 1414, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1300, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1399, - "name": "OAuthClientListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1431, - "name": "regenerateClientSecret", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2199" - } - ], - "signatures": [ - { - "id": 1432, - "name": "regenerateClientSecret", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Regenerates the secret for an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2199" - } - ], - "parameters": [ - { - "id": 1433, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1421, - "name": "updateClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2177" - } - ], - "signatures": [ - { - "id": 1422, - "name": "updateClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2177" - } - ], - "parameters": [ - { - "id": 1423, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1424, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1390, - "name": "UpdateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1415, 1425, 1418, 1412, 1431, 1421] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1415, 1425, 1418, 1412, 1431, 1421] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2134, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2134" - } - ] - }, - { - "id": 1695, - "name": "GoTrueAdminPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1699, - "name": "deletePasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2905" - } - ], - "signatures": [ - { - "id": 1700, - "name": "deletePasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a specific passkey for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2905" - } - ], - "parameters": [ - { - "id": 1701, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1671, - "name": "AuthPasskeyAdminDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1667, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1696, - "name": "listPasskeys", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2895" - } - ], - "signatures": [ - { - "id": 1697, - "name": "listPasskeys", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2895" - } - ], - "parameters": [ - { - "id": 1698, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1668, - "name": "AuthPasskeyAdminListParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1665, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1699, 1696] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1699, 1696] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2886, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2886" - } - ] - }, - { - "id": 1208, - "name": "GoTrueMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication API." - } - ] - }, - "children": [ - { - "id": 1265, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1690" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "WebAuthnApi" - }, - "name": "WebAuthnApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1218, - "name": "challenge", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1423" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1424" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1425" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1426" - } - ], - "signatures": [ - { - "id": 1219, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- A phone factor sends a code to the user upon challenge. The channel defaults to " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " unless otherwise specified." - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor (WhatsApp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n channel: 'whatsapp',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor (WhatsApp)\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1423" - } - ], - "parameters": [ - { - "id": 1220, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1221, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1222, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1223, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1222, 1223] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1224, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1225, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1226, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1225, 1226] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1227, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1424" - } - ], - "parameters": [ - { - "id": 1228, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1175, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1229, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1230, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1231, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1230, 1231] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1232, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1233, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1234, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1233, 1234] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1235, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1425" - } - ], - "parameters": [ - { - "id": 1236, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1176, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1237, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1238, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1239, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1238, 1239] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1240, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1241, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1242, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1241, 1242] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1243, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1426" - } - ], - "parameters": [ - { - "id": 1244, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1177, - "name": "MFAChallengeParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1196, - "name": "AuthMFAChallengeResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1257, - "name": "challengeAndVerify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1618" - } - ], - "signatures": [ - { - "id": 1258, - "name": "challengeAndVerify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Intended for use with only TOTP factors.\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking " - }, - { - "kind": "code", - "text": "`challengeAndVerify()`" - }, - { - "kind": "text", - "text": ".\n- Executes [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge) and [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify) in a single step." - } - ] - }, - { - "tag": "@example", - "name": "Create and verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create and verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1618" - } - ], - "parameters": [ - { - "id": 1259, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1209, - "name": "enroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1349, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1349" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1350" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1351" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1352" - } - ], - "signatures": [ - { - "id": 1210, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " as the " - }, - { - "kind": "code", - "text": "`factorType`" - }, - { - "kind": "text", - "text": " and use the returned " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " to create a challenge.\n- To create a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge).\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- To create and verify a TOTP challenge in a single step, see [" - }, - { - "kind": "code", - "text": "`mfa.challengeAndVerify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challengeandverify).\n- To generate a QR code for the " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " secret in Next.js, you can do the following:\n" - }, - { - "kind": "code", - "text": "```html\n{data.totp.uri}\n```" - }, - { - "kind": "text", - "text": "\n- The " - }, - { - "kind": "code", - "text": "`challenge`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`verify`" - }, - { - "kind": "text", - "text": " steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge." - } - ] - }, - { - "tag": "@example", - "name": "Enroll a time-based, one-time password (TOTP) factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'totp',\n friendlyName: 'your_friendly_name'\n})\n\n// Use the id to create a challenge.\n// The challenge can be verified by entering the code generated from the authenticator app.\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a time-based, one-time password (TOTP) factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp'\n totp: {\n qr_code: '',\n secret: '',\n uri: '',\n }\n friendly_name?: 'Important app'\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Enroll a Phone Factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'phone',\n friendlyName: 'your_friendly_name',\n phone: '+12345678',\n})\n\n// Use the id to create a challenge and send an SMS with a code to the user.\nconst { id, type, friendly_name, phone } = data\n\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a Phone Factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n friendly_name?: 'Important app',\n phone: '+5787123456'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1349, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1349" - } - ], - "parameters": [ - { - "id": 1211, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1307, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1212, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1350" - } - ], - "parameters": [ - { - "id": 1213, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1308, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1214, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1351" - } - ], - "parameters": [ - { - "id": 1215, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1216, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1352" - } - ], - "parameters": [ - { - "id": 1217, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1160, - "name": "MFAEnrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1187, - "name": "AuthMFAEnrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1262, - "name": "getAuthenticatorAssuranceLevel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1685, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1685" - } - ], - "signatures": [ - { - "id": 1263, - "name": "getAuthenticatorAssuranceLevel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " (or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\nand rarely uses the network. When a JWT is provided (useful in server-side\nenvironments like Edge Functions where no session is stored), this method\nwill make a network request to validate the user and fetch their MFA factors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\n- In Supabase, having an AAL of " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\n- If the user has a verified factor, the " - }, - { - "kind": "code", - "text": "`nextLevel`" - }, - { - "kind": "text", - "text": " field will return " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": ", else, it will return " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": ".\n- An optional " - }, - { - "kind": "code", - "text": "`jwt`" - }, - { - "kind": "text", - "text": " parameter can be passed to check the AAL level of a specific JWT instead of the current session." - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details of a session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the AAL details of a session\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n currentLevel: 'aal1',\n nextLevel: 'aal2',\n currentAuthenticationMethods: [\n {\n method: 'password',\n timestamp: 1700000000\n }\n ]\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details for a specific JWT", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1685, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1685" - } - ], - "parameters": [ - { - "id": 1264, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1203, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1260, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1631, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1631" - } - ], - "signatures": [ - { - "id": 1261, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the list of MFA factors enabled for this user." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 1209 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 1262 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient#getUser", - "target": 380 - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1631, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1631" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1197, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - } - } - ], - "name": "AuthMFAListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1254, - "name": "unenroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1536" - } - ], - "signatures": [ - { - "id": 1255, - "name": "unenroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unenroll removes a MFA factor.\nA user has to have an " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " authenticator level in order to unenroll a " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " factor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@example", - "name": "Unenroll a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.unenroll({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Unenroll a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: ''\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1536" - } - ], - "parameters": [ - { - "id": 1256, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1161, - "name": "MFAUnenrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1188, - "name": "AuthMFAUnenrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1245, - "name": "verify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1507" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1508, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1508" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1509, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1509" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1510, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1510" - } - ], - "signatures": [ - { - "id": 1246, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first." - } - ] - }, - { - "tag": "@example", - "name": "Verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.verify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1507" - } - ], - "parameters": [ - { - "id": 1247, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1164, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1248, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1508, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1508" - } - ], - "parameters": [ - { - "id": 1249, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1165, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1250, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1509, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1509" - } - ], - "parameters": [ - { - "id": 1251, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1170, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1252, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1510, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1510" - } - ], - "parameters": [ - { - "id": 1253, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1172, - "name": "MFAVerifyParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [1265] - }, - { - "title": "Methods", - "children": [1218, 1257, 1209, 1262, 1260, 1254, 1245] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1218, 1257, 1209, 1262, 1260, 1254, 1245] - }, - { - "title": "Other", - "children": [1265] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1267, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1267" - } - ] - }, - { - "id": 1349, - "name": "JWK", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1353, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1993, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1993" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1352, - "name": "key_ops", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1992, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1992" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1354, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1994, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1994" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1350, - "name": "kty", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1991, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1991" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1351, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1353, 1352, 1354, 1350] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1990, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1990" - } - ], - "indexSignatures": [ - { - "id": 1355, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1995, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1995" - } - ], - "parameters": [ - { - "id": 1356, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1329, - "name": "JwtPayload", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWT Payload containing claims for Supabase authentication tokens.\n\nRequired claims (iss, aud, exp, iat, sub, role, aal, session_id) are inherited from RequiredClaims.\nAll other claims are optional as they can be customized via Custom Access Token Hooks." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://supabase.com/docs/guides/auth/jwt-fields" - } - ] - } - ] - }, - "children": [ - { - "id": 1345, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1952, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1952" - } - ], - "type": { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aal" - } - }, - { - "id": 1337, - "name": "amr", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication Method References.\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1981, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1981" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 864, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - } - ] - } - }, - { - "id": 1335, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1973, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1973" - } - ], - "type": { - "type": "reference", - "target": 891, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 1341, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1948, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1948" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aud" - } - }, - { - "id": 1330, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1966, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1966" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1342, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1949, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1949" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.exp" - } - }, - { - "id": 1343, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1950, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1950" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iat" - } - }, - { - "id": 1332, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1968, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1968" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1339, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1946, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1946" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iss" - } - }, - { - "id": 1333, - "name": "jti", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1971" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1334, - "name": "nbf", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1972, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1972" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1331, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1967" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1338, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1984, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1984" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1344, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1951, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1951" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.role" - } - }, - { - "id": 1346, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1953, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1953" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.session_id" - } - }, - { - "id": 1340, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1947" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.sub" - } - }, - { - "id": 1336, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1974, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1974" - } - ], - "type": { - "type": "reference", - "target": 896, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1345, 1337, 1335, 1341, 1330, 1342, 1343, 1332, 1339, 1333, 1334, 1331, 1338, 1344, - 1346, 1340, 1336 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1964, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1964" - } - ], - "indexSignatures": [ - { - "id": 1347, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1987, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1987" - } - ], - "parameters": [ - { - "id": 1348, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1319, - "name": "RequiredClaims", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 853, - "name": "Session", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 856, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 317, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L317" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 859, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 329, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L329" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 858, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 325, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L325" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 855, - "name": "provider_refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 313, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L313" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 854, - "name": "provider_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 857, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A one-time used refresh token that never expires." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L321" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 860, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 330, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L330" - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 861, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When using a separate user storage, accessing properties of this object will throw an error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 335, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L335" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [856, 859, 858, 855, 854, 857, 860, 861] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 304, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L304" - } - ] - }, - { - "id": 947, - "name": "Subscription", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 949, - "name": "callback", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to call every time there is an event. eg: (eventName) => {}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 950, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "signatures": [ - { - "id": 951, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "parameters": [ - { - "id": 952, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 953, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 948, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for this subscription, set by the client.\nThis is an internal identifier used for managing callbacks and should not be\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 604, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L604" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 954, - "name": "unsubscribe", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Call this to remove the listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 955, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "signatures": [ - { - "id": 956, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [949, 948, 954] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 598, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L598" - } - ] - }, - { - "id": 899, - "name": "User", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 910, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 464, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L464" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 901, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 455, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L455" - } - ], - "type": { - "type": "reference", - "target": 891, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 903, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 457, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L457" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 925, - "name": "banned_until", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 479, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L479" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 904, - "name": "confirmation_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L458" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 914, - "name": "confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L468" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 913, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 467, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L467" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 924, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 911, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L465" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 906, - "name": "email_change_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 460, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L460" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 915, - "name": "email_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L469" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 923, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 477, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - { - "type": "literal", - "value": "unverified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - ] - } - } - }, - { - "id": 900, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 454, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L454" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 920, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 474, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L474" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 909, - "name": "invited_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L463" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 921, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 475, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L475" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 922, - "name": "is_sso_user", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 476, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L476" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 917, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 471, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L471" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 907, - "name": "new_email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L461" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 908, - "name": "new_phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L462" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 912, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 466, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L466" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "phone_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L470" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 905, - "name": "recovery_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 459, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L459" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 918, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L472" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 919, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L473" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 902, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L456" - } - ], - "type": { - "type": "reference", - "target": 896, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 910, 901, 903, 925, 904, 914, 913, 924, 911, 906, 915, 923, 900, 920, 909, 921, 922, - 917, 907, 908, 912, 916, 905, 918, 919, 902 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 453, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L453" - } - ] - }, - { - "id": 891, - "name": "UserAppMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 892, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The first provider that the user used to sign up with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 441, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L441" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 893, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all providers that the user has linked to their account." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 445, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L445" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [892, 893] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 437, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L437" - } - ], - "indexSignatures": [ - { - "id": 894, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 446, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L446" - } - ], - "parameters": [ - { - "id": 895, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 926, - "name": "UserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 927, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 932, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 520, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L520" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 928, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 495, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L495" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 931, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 930, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 505, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L505" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 929, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L500" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [927, 932, 928, 931, 930, 929] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 482, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L482" - } - ] - }, - { - "id": 867, - "name": "UserIdentity", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 876, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 386, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L386" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 868, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 379, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L379" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 870, - "name": "identity_data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 381, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L381" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 381, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L381" - } - ], - "indexSignatures": [ - { - "id": 872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 382, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L382" - } - ], - "parameters": [ - { - "id": 873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 874, - "name": "identity_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 384, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L384" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 877, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 387, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L387" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 875, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 385, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 878, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L388" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 869, - "name": "user_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 380, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [876, 868, 870, 874, 877, 875, 878, 869] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 378, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L378" - } - ] - }, - { - "id": 896, - "name": "UserMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 449, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L449" - } - ], - "indexSignatures": [ - { - "id": 897, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L450" - } - ], - "parameters": [ - { - "id": 898, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1078, - "name": "VerifyEmailOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1079, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 825, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L825" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1082, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 830, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L830" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1083, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1085, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 838, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L838" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1084, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 832, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L832" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1085, 1084] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 830, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L830" - } - ] - } - } - }, - { - "id": 1080, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 827, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L827" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1081, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 829, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L829" - } - ], - "type": { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1079, 1082, 1080, 1081] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 823, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L823" - } - ] - }, - { - "id": 1070, - "name": "VerifyMobileOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1074, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 811, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L811" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1075, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1077, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 820, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L820" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1076, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 813, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L813" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1077, 1076] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 811, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L811" - } - ] - } - } - }, - { - "id": 1071, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 806, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L806" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1072, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 808, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L808" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1073, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 810, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L810" - } - ], - "type": { - "type": "reference", - "target": 1089, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1074, 1071, 1072, 1073] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 804, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L804" - } - ] - }, - { - "id": 1086, - "name": "VerifyTokenHashParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1087, - "name": "token_hash", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token hash used in an email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 844, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L844" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1088, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 847, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L847" - } - ], - "type": { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1087, 1088] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 842, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L842" - } - ] - }, - { - "id": 862, - "name": "AMRMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 353, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L353" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMRMethods" - }, - "name": "AMRMethods", - "package": "@supabase/auth-js", - "preferValues": true - } - } - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 353, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L353" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 738, - "name": "AuthChangeEvent", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 54, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L54" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "reference", - "target": 737, - "name": "AuthChangeEventMFA", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 737, - "name": "AuthChangeEventMFA", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 52, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L52" - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 1201, - "name": "AuthenticatorAssuranceLevels", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1237, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1237" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1202, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1237, - "character": 71, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1237" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 993, - "name": "AuthFlowType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 685, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L685" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 994, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 685, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L685" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1269, - "name": "AuthMFAAdminDeleteFactorParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1703, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1703" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1270, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1271, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the MFA factor to delete." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1272, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user whose factor is being deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1708" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1271, 1272] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1703, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1703" - } - ] - } - } - }, - { - "id": 1266, - "name": "AuthMFAAdminDeleteFactorResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1696, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1696" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1267, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1268, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1698, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1698" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1268] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1696, - "character": 61, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1696" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1276, - "name": "AuthMFAAdminListFactorsParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1722, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1277, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1278, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1724, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1724" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1278] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1722, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1722" - } - ] - } - } - }, - { - "id": 1273, - "name": "AuthMFAAdminListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1714, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1714" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1274, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1275, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All factors attached to the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1716, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1716" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1275] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1714, - "character": 60, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1714" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1192, - "name": "AuthMFAChallengePhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1168, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1168" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponseFields" - }, - "name": "AuthMFAChallengePhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1196, - "name": "AuthMFAChallengeResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1219, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1219" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1191, - "name": "AuthMFAChallengeTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1192, - "name": "AuthMFAChallengePhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1193, - "name": "AuthMFAChallengeWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1191, - "name": "AuthMFAChallengeTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1160, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1160" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponseFields" - }, - "name": "AuthMFAChallengeTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1193, - "name": "AuthMFAChallengeWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn MFA challenge.\nContains credential creation or request options from the server." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Credential Creation", - "target": "https://w3c.github.io/webauthn/#sctn-credential-creation" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1189, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1189" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1194, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable version of WebAuthn challenge response.\nUsed for server communication with base64url-encoded binary fields." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1209, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1209" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFieldsJSON" - }, - "name": "AuthMFAChallengeWebauthnResponseFieldsJSON", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1195, - "name": "AuthMFAChallengeWebauthnServerResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server response type for WebAuthn MFA challenge.\nContains JSON-formatted WebAuthn options ready for browser API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1216, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1216" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1194, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1922, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1922" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponseFields" - }, - "name": "AuthMFAEnrollPhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1187, - "name": "AuthMFAEnrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1135, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1135" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1913, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1913" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponseFields" - }, - "name": "AuthMFAEnrollTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn factor enrollment.\nReturns the enrolled factor ID and metadata." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1935, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1935" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnFields" - }, - "name": "AuthMFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1203, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1239, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1239" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1204, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1207, - "name": "currentAuthenticationMethods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario.\n\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1260, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1260" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 864, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1205, - "name": "currentLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Current AAL level of the session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1241, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1241" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1206, - "name": "nextLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#challenge", - "target": 1218 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1249" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1207, 1205, 1206] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1239, - "character": 74, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1239" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1197, - "name": "AuthMFAListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "response of ListFactors, which should contain all the types of factors that are available, this ensures we always include all" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1225, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1225" - } - ], - "typeParameters": [ - { - "id": 1200, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - }, - "default": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1198, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1199, - "name": "all", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All available factors (verified and unverified)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1229, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1229" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1199] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1227, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1227" - } - ] - } - }, - { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "reference", - "target": 1200, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1188, - "name": "AuthMFAUnenrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1140, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1140" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1189, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1190, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1142" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1190] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1140, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1140" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1186, - "name": "AuthMFAVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for MFA verification operations.\nReturns session tokens on successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1133, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1133" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1179, - "name": "AuthMFAVerifyResponseData", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1179, - "name": "AuthMFAVerifyResponseData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data returned after successful MFA verification.\nContains new session tokens and updated user information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1112, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1112" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1181, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New access token (JWT) after successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1183, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of seconds in which the access token will expire." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1120, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1120" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1184, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Refresh token you can use to obtain new access tokens when expired." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1123" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of token, always " - }, - { - "kind": "code", - "text": "`bearer`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1117" - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 1185, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updated user profile." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1126, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1126" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1181, 1183, 1184, 1182, 1185] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1112, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1112" - } - ] - } - } - }, - { - "id": 1565, - "name": "AuthOAuthAuthorizationDetailsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for getting OAuth authorization details.\nReturns either full authorization details (if consent needed) or redirect URL (if already consented).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase.auth.oauth.getAuthorizationDetails(authorizationId)\n\nif (error) {\n console.error('Error:', error)\n} else if ('authorization_id' in data) {\n // User needs to provide consent - show consent page\n console.log('Client:', data.client.name)\n console.log('Scopes:', data.scope)\n console.log('Redirect URI:', data.redirect_uri)\n} else {\n // User already consented - redirect immediately\n window.location.href = data.redirect_url\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2550, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2550" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1552, - "name": "OAuthAuthorizationDetails", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1562, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1566, - "name": "AuthOAuthConsentResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth consent decision (approve/deny).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2558, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2558" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1562, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1572, - "name": "AuthOAuthGrantsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing user's OAuth grants.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2577, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2577" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1567, - "name": "OAuthGrant", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1573, - "name": "AuthOAuthRevokeGrantResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for revoking an OAuth grant.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2583, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2583" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1574, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2583, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2583" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 820, - "name": "AuthOtpResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AuthOtpResponse is returned when OTP is used.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "AuthResponse" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 256, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L256" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 821, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 824, - "name": "messageId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 259, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L259" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 823, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 258, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L258" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 822, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 257, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L257" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [824, 823, 822] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 256, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L256" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1671, - "name": "AuthPasskeyAdminDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2800, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2800" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1674, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2802, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2802" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1673, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2801" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1674, 1673] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2800, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2800" - } - ] - } - } - }, - { - "id": 1668, - "name": "AuthPasskeyAdminListParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2796, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2796" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1669, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1670, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2797, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2797" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1670] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2796, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2796" - } - ] - } - } - }, - { - "id": 1660, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2784, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2784" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1612, - "name": "PasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2786, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2786" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1662, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1663, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1664, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1663, 1664] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ] - } - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1667, - "name": "AuthPasskeyDeleteResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2792, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2792" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "literal", - "value": null - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1665, - "name": "AuthPasskeyListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2790, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2790" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1621, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1658, - "name": "AuthPasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2778, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2778" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "PasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2780, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2780" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1607, - "name": "PasskeyMetadata", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1666, - "name": "AuthPasskeyUpdateResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2791, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2791" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1621, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 811, - "name": "AuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 240, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L240" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 812, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 814, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 242, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L242" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 813, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 241, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L241" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [814, 813] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 240, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L240" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 815, - "name": "AuthResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 245, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L245" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 818, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 247, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L247" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 817, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L246" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 819, - "name": "weak_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 248, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L248" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 785, - "name": "WeakPassword", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [818, 817, 819] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 245, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L245" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 825, - "name": "AuthTokenResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 262, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L262" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 826, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 828, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 264, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L264" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 827, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 263, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L263" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [828, 827] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 262, - "character": 61, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L262" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 829, - "name": "AuthTokenResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 267, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L267" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 830, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 832, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 269, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L269" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 831, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 268, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L268" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - }, - { - "id": 833, - "name": "weakPassword", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 270, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L270" - } - ], - "type": { - "type": "reference", - "target": 785, - "name": "WeakPassword", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [832, 831, 833] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 267, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L267" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1292, - "name": "CallRefreshTokenResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1822, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1822" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1471, - "name": "CreateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new custom provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2288, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2288" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1472, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1478, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2300" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1481, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2306, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2306" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1482, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2308" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1488, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2320, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2320" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1476, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2296, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2296" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1477, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2298, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2298" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1486, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2316, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2316" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1484, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2312, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2312" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1483, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2310, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2310" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1474, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2292" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1485, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2314, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2314" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1491, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2326, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2326" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1475, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2294, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2294" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1480, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2304, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2304" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1473, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2290, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2290" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1479, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2302, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2302" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1487, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2318, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2318" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1489, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2322" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1490, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2324, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2324" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1478, 1481, 1482, 1488, 1476, 1477, 1486, 1484, 1483, 1474, 1485, 1491, 1475, - 1480, 1473, 1479, 1487, 1489, 1490 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2288, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2288" - } - ] - } - } - }, - { - "id": 1381, - "name": "CreateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2073, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2073" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1382, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1383, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2075, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2075" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1384, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2077, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2077" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1386, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2081, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2081" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1385, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2079" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1387, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types (optional, defaults to code)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2083, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2083" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1361, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1388, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2085, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2085" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1389, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method (defaults to server default if not specified)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2087, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2087" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1383, 1384, 1386, 1385, 1387, 1388, 1389] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2073, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2073" - } - ] - } - } - }, - { - "id": 1447, - "name": "CustomOAuthProvider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom OAuth/OIDC provider object returned from the admin API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2238, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2238" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1448, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1454, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2250, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2250" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1457, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2256, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2256" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1458, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2258, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2258" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1464, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2270, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2270" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1453, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2248, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2248" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1469, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2280" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1468, - "name": "discovery_document", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document (OIDC providers only)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2278, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2278" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1435, - "name": "OIDCDiscoveryDocument", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1462, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2266, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2266" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1460, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2262, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2262" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1459, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2260, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2260" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1449, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2240, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2240" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1451, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2244, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2244" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1461, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2264, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2264" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1467, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2276, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1452, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2246" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1456, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2254" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1450, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2242, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2242" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1455, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2252, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2252" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1463, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2268, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2268" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1465, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2272, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2272" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1470, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2282, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2282" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1466, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2274, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2274" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1454, 1457, 1458, 1464, 1453, 1469, 1468, 1462, 1460, 1459, 1449, 1451, 1461, - 1467, 1452, 1456, 1450, 1455, 1463, 1465, 1470, 1466 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2238, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2238" - } - ] - } - } - }, - { - "id": 1515, - "name": "CustomProviderListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2387, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2387" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1516, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1517, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1518, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1519, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1447, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1519] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ] - } - } - }, - { - "id": 1520, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2390, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2390" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1517, 1520] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2388, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2388" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1521, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1522, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1523, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1524, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1524] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ] - } - } - }, - { - "id": 1525, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2394, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2394" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1522, 1525] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2392, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2392" - } - ] - } - } - ] - } - }, - { - "id": 1514, - "name": "CustomProviderResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for custom provider operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2382, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2382" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1447, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1434, - "name": "CustomProviderType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of custom identity provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2205, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2205" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - } - }, - { - "id": 1091, - "name": "EmailOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 851, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L851" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1092, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 858, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L858" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1050, - "name": "EthereumWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 762, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L762" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "EIP1193Provider" - }, - "name": "EIP1193Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1051, - "name": "EthereumWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 764, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L764" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1052, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1053, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 766, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L766" - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1056, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 774, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L774" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1059, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 779, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L779" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1060, - "name": "signInWithEthereum", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 781, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L781" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "EthereumSignInInput" - }, - "name": "EthereumSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1058, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 776, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L776" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1059, 1060, 1058] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 774, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L774" - } - ] - } - } - }, - { - "id": 1055, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 772, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L772" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1054, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.ethereum`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 769, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L769" - } - ], - "type": { - "type": "reference", - "target": 1050, - "name": "EthereumWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1053, 1056, 1055, 1054] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 765, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L765" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1061, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1062, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 787, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L787" - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1063, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Ethereum compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 790, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L790" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1065, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 795, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L795" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1067, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 797, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L797" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1067] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 795, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L795" - } - ] - } - } - }, - { - "id": 1064, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ethereum curve (secp256k1) signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 793, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L793" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "Hex" - }, - "name": "Hex", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1062, 1063, 1065, 1064] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 786, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L786" - } - ] - } - } - ] - } - }, - { - "id": 781, - "name": "ExperimentalFeatureFlags", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 182, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L182" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 782, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 783, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enables passkey support:\n - " - }, - { - "kind": "code", - "text": "`auth.signInWithPasskey()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`auth.registerPasskey()`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.passkey.*`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.admin.passkey.*`" - }, - { - "kind": "text", - "text": "\n\nDefaults to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ". Calling any passkey method while this flag is\ndisabled throws a descriptive error at call time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L192" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [783] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 182, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L182" - } - ] - } - } - }, - { - "id": 880, - "name": "Factor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A MFA factor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 1209 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#listFactors", - "target": 1260 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAAdminApi#listFactors" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 412, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L412" - } - ], - "typeParameters": [ - { - "id": 889, - "name": "Type", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 879, - "name": "FactorType", - "package": "@supabase/auth-js" - }, - "default": { - "type": "reference", - "target": 879, - "name": "FactorType", - "package": "@supabase/auth-js" - } - }, - { - "id": 890, - "name": "Status", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorVerificationStatus" - }, - "name": "FactorVerificationStatus", - "package": "@supabase/auth-js" - }, - "default": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorVerificationStatuses" - }, - "name": "FactorVerificationStatuses", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 881, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 886, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 432, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L432" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 884, - "name": "factor_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L425" - } - ], - "type": { - "type": "reference", - "target": 889, - "name": "Type", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 883, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L420" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 882, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 417, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L417" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 888, - "name": "last_challenged_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 434, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L434" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 885, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification status of the factor, default is " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " after " - }, - { - "kind": "code", - "text": "`.enroll()`" - }, - { - "kind": "text", - "text": ", then " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " after the user verifies it with " - }, - { - "kind": "code", - "text": "`.verify()`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 430, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L430" - } - ], - "type": { - "type": "reference", - "target": 890, - "name": "Status", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 887, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 433, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L433" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [886, 884, 883, 882, 888, 885, 887] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 415, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L415" - } - ] - } - } - }, - { - "id": 879, - "name": "FactorType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 396, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L396" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1138, - "name": "GenerateEmailChangeLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 937, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L937" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1141, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 940, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L940" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1142, - "name": "newEmail", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 944, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L944" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1143, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 945, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L945" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1140, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 938, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L938" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1141, 1142, 1143, 1140] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 937, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L937" - } - ] - } - } - }, - { - "id": 1128, - "name": "GenerateInviteOrMagiclinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 923, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L923" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1129, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1131, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 926, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L926" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1132, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 927, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L927" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1130, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 924, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L924" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1131, 1132, 1130] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 923, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L923" - } - ] - } - } - }, - { - "id": 1147, - "name": "GenerateLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 959, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L959" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1122, - "name": "GenerateSignupLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1128, - "name": "GenerateInviteOrMagiclinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1133, - "name": "GenerateRecoveryLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1138, - "name": "GenerateEmailChangeLinkParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1152, - "name": "GenerateLinkProperties", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The properties related to the email link generated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 971, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L971" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1154, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 976, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L976" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1155, - "name": "email_otp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 981, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L981" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1156, - "name": "hashed_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The hashed token appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 985, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L985" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1157, - "name": "redirect_to", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 987, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L987" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1158, - "name": "verification_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification type that the email link is associated to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 989, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L989" - } - ], - "type": { - "type": "reference", - "target": 1159, - "name": "GenerateLinkType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1154, 1155, 1156, 1157, 1158] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 971, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L971" - } - ] - } - } - }, - { - "id": 1148, - "name": "GenerateLinkResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 965, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L965" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1149, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1150, - "name": "properties", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 966, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L966" - } - ], - "type": { - "type": "reference", - "target": 1152, - "name": "GenerateLinkProperties", - "package": "@supabase/auth-js" - } - }, - { - "id": 1151, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L967" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1150, 1151] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 965, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L965" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1159, - "name": "GenerateLinkType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 992, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L992" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - }, - { - "id": 1133, - "name": "GenerateRecoveryLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 930, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L930" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1136, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 933, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L933" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1137, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 934, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L934" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1135, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 931, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L931" - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1136, 1137, 1135] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 930, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L930" - } - ] - } - } - }, - { - "id": 1122, - "name": "GenerateSignupLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 916, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L916" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1125, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 918, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L918" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1127, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 920, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L920" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1126, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 919, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L919" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1124, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 917, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L917" - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1125, 1127, 1126, 1124] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 916, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L916" - } - ] - } - } - }, - { - "id": 748, - "name": "GoTrueClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L80" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 749, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 764, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L109" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 770, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 127, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L127" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 771, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 127, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L127" - } - ], - "signatures": [ - { - "id": 772, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 773, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 774, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - }, - { - "id": 756, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if you want to automatically detect OAuth grants in the URL and sign in the user.\nSet to \"false\" to disable automatic detection.\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\nThe function receives the current URL and parsed parameters, and should return true if the URL\nshould be processed as a Supabase auth callback, or false to ignore it.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 757, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "signatures": [ - { - "id": 758, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 759, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 760, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 761, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "indexSignatures": [ - { - "id": 762, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "parameters": [ - { - "id": 763, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 780, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 179, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L179" - } - ], - "type": { - "type": "reference", - "target": 781, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 768, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L123" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/fetch.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/auth-js" - } - }, - { - "id": 769, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L125" - } - ], - "type": { - "type": "reference", - "target": 993, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 776, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if there is a custom authorization header set globally." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L146" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 751, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "indexSignatures": [ - { - "id": 753, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "parameters": [ - { - "id": 754, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 775, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe client coordinates refreshes itself (single-flight via\n" - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " + commit guard) and relies on the GoTrue server to\nresolve cross-tab refresh races. Passing a custom lock opts into a\nlegacy path that wraps every auth operation in your supplied lock — this\npath is preserved for backwards compatibility (typically React Native\n" - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": " or Node multi-process setups)." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\nconstructor options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L141" - } - ], - "type": { - "type": "reference", - "target": 739, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - }, - { - "id": 778, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option. Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is\npassed — the default lockless path doesn't use this timeout." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 162, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 765, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L111" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 779, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in constructor. Useful for SSR\ncontexts where initialization timing must be controlled to prevent race\nconditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L171" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 766, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "reference", - "target": 1286, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 755, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L86" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 777, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L151" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 750, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L82" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 767, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " - }, - { - "kind": "code", - "text": "`storage`" - }, - { - "kind": "text", - "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " - }, - { - "kind": "code", - "text": "`userStorage`" - }, - { - "kind": "text", - "text": " will only contain the user object under the key " - }, - { - "kind": "code", - "text": "`storageKey + '-user'`" - }, - { - "kind": "text", - "text": ".\n\nWhen this option is set and cookie storage is used, " - }, - { - "kind": "code", - "text": "`getSession()`" - }, - { - "kind": "text", - "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch a user object in those scenarios." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L121" - } - ], - "type": { - "type": "reference", - "target": 1286, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 764, 770, 756, 780, 768, 769, 776, 751, 775, 778, 765, 779, 766, 755, 777, 750, - 767 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 80, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L80" - } - ] - } - } - }, - { - "id": 1289, - "name": "InitializeResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1290, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1291, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1291] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ] - } - } - }, - { - "id": 1313, - "name": "JwtHeader", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1939, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1939" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1314, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1315, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1940, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1940" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "RS256" - }, - { - "type": "literal", - "value": "ES256" - }, - { - "type": "literal", - "value": "HS256" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1316, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1940, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1940" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1317, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1941" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1318, - "name": "typ", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1942, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1942" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1315, 1317, 1318] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1939, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1939" - } - ] - } - } - }, - { - "id": 1511, - "name": "ListCustomProvidersParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2374, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2374" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1512, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1513, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2376" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1513] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2374, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2374" - } - ] - } - } - }, - { - "id": 739, - "name": "LockFunc", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": " async function, such that no other client instances will be able to\nhold it at the same time." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 740, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "signatures": [ - { - "id": 741, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameters": [ - { - "id": 747, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 742, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 743, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 744, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to execute when the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 747, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 747, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1178, - "name": "MFAChallengeAndVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1106, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1106" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - }, - { - "id": 1177, - "name": "MFAChallengeParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1094, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1094" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1174, - "name": "MFAChallengeTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1175, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1176, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1175, - "name": "MFAChallengePhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1075, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1075" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParamFields" - }, - "name": "MFAChallengePhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1174, - "name": "MFAChallengeTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1068, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1068" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1176, - "name": "MFAChallengeWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for initiating a WebAuthn MFA challenge.\nIncludes Relying Party information needed for WebAuthn ceremonies." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Relying Party Operations", - "target": "https://w3c.github.io/webauthn/#sctn-rp-operations" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1092, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1092" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParamFields" - }, - "name": "MFAChallengeWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1160, - "name": "MFAEnrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1000, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1000" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1307, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1308, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1309, - "name": "MFAEnrollWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1308, - "name": "MFAEnrollPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1870, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1870" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParamFields" - }, - "name": "MFAEnrollPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1307, - "name": "MFAEnrollTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1864, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1864" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParamFields" - }, - "name": "MFAEnrollTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1309, - "name": "MFAEnrollWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for enrolling a WebAuthn factor.\nCreates an unverified WebAuthn factor that must be verified with a credential." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1881, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1881" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnFields" - }, - "name": "MFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1173, - "name": "MFATOTPChannel", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1066, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1066" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFATOTPChannels" - }, - "name": "MFATOTPChannels", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1161, - "name": "MFAUnenrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1002, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1002" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1162, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1163, - "name": "factorId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor being unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1004, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1004" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1163] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1002, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1002" - } - ] - } - } - }, - { - "id": 1172, - "name": "MFAVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1058, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1058" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1164, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1165, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1170, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1165, - "name": "MFAVerifyPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1023, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1023" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParamFields" - }, - "name": "MFAVerifyPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1164, - "name": "MFAVerifyTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1019, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1019" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParamFields" - }, - "name": "MFAVerifyTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1166, - "name": "MFAVerifyWebauthnParamFields", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "WebAuthn-specific fields for MFA verification.\nSupports both credential creation (registration) and request (authentication) flows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1045, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1045" - } - ], - "typeParameters": [ - { - "id": 1169, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1167, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1168, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1046, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1046" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFieldsBase" - }, - "name": "MFAVerifyWebauthnParamFieldsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnCredentialParamFields" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1169, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnCredentialParamFields", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1168] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1045, - "character": 98, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1045" - } - ] - } - } - }, - { - "id": 1170, - "name": "MFAVerifyWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for WebAuthn MFA verification.\nUsed to verify WebAuthn credentials after challenge." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Verifying an Authentication Assertion", - "target": "https://w3c.github.io/webauthn/#sctn-verifying-assertion" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1055, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1055" - } - ], - "typeParameters": [ - { - "id": 1171, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1166, - "typeArguments": [ - { - "type": "reference", - "target": 1171, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1089, - "name": "MobileOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 850, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L850" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1090, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 850, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L850" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1546, - "name": "OAuthAuthorizationClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client details in an authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2470, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2470" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1547, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1548, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2472" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1551, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1549, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2474, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2474" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1550, - "name": "uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's website" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2476, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2476" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1548, 1551, 1549, 1550] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2470, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2470" - } - ] - } - } - }, - { - "id": 1552, - "name": "OAuthAuthorizationDetails", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth authorization details when user needs to provide consent.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response includes all information needed to display a consent page:\nclient details, user info, requested scopes, and where the user will be redirected.\n\nNote: " - }, - { - "kind": "code", - "text": "`redirect_uri`" - }, - { - "kind": "text", - "text": " is the base URI (e.g., \"https://app.com/callback\") without\nquery parameters. After consent, you'll receive a complete " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " with\nthe authorization code and state parameters appended." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2492, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2492" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1553, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1554, - "name": "authorization_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID used to approve or deny the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2494, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2494" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1556, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client requesting authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2498, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2498" - } - ], - "type": { - "type": "reference", - "target": 1546, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 1555, - "name": "redirect_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client's registered redirect URI (base URI without query parameters)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2496, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2496" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1561, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Space-separated list of requested scopes (e.g., \"openid profile email\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2507" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1557, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User object associated with the authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2500" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1558, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1560, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2504, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2504" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1559, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User ID (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2502, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2502" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1560, 1559] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2500, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2500" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1554, 1556, 1555, 1561, 1557] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2492, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2492" - } - ] - } - } - }, - { - "id": 1365, - "name": "OAuthClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client object returned from the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2038, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2038" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1367, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2040, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2040" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1368, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2042, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2042" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1369, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client secret (only returned on registration and regeneration)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2044, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2044" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1370, - "name": "client_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2046, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2046" - } - ], - "type": { - "type": "reference", - "target": 1362, - "name": "OAuthClientType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1373, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2052, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2052" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1379, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2064, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2064" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1376, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2058, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2058" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1374, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2054, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2054" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1375, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2056, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2056" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1372, - "name": "registration_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registration type of the client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2050, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2050" - } - ], - "type": { - "type": "reference", - "target": 1363, - "name": "OAuthClientRegistrationType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1377, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2060, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2060" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1361, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1378, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2062, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2062" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1371, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2048, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2048" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 1380, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2066, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2066" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1367, 1368, 1369, 1370, 1373, 1379, 1376, 1374, 1375, 1372, 1377, 1378, 1371, - 1380 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2038, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2038" - } - ] - } - } - }, - { - "id": 1359, - "name": "OAuthClientGrantType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client grant types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2005, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2005" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1360, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2005, - "character": 86, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2005" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1399, - "name": "OAuthClientListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing OAuth clients.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2120, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2120" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1400, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1401, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1404, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1403, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1365, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1404, 1403] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ] - } - }, - { - "type": "reference", - "target": 1293, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1405, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2123, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2123" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1401, 1405] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2121" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1406, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1407, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1408, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1409, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1409] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ] - } - } - }, - { - "id": 1410, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2127, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2127" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1407, 1410] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2125, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2125" - } - ] - } - } - ] - } - }, - { - "id": 1363, - "name": "OAuthClientRegistrationType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client registration type.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2023, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2023" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - } - }, - { - "id": 1398, - "name": "OAuthClientResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth client operations.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2114, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2114" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1365, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1361, - "name": "OAuthClientResponseType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client response types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2011, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2011" - } - ], - "type": { - "type": "literal", - "value": "code" - } - }, - { - "id": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client token endpoint authentication method.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2029, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2029" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - } - }, - { - "id": 1362, - "name": "OAuthClientType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client type indicating whether the client can keep credentials confidential.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2017, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2017" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - } - }, - { - "id": 1567, - "name": "OAuthGrant", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An OAuth grant representing a user's authorization of an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2564, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2564" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1568, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1569, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client information" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2566" - } - ], - "type": { - "type": "reference", - "target": 1546, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 1571, - "name": "granted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the grant was created (ISO 8601 date-time)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2570" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1570, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of scopes granted to this client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2568, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2568" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1569, 1571, 1570] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2564, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2564" - } - ] - } - } - }, - { - "id": 1562, - "name": "OAuthRedirect", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth redirect response when user has already consented or after consent decision.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response is returned in three scenarios:\n1. User already consented to these scopes (auto-approved)\n2. User just approved the authorization request\n3. User just denied the authorization request\n\nThe " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " is a complete URL ready for redirecting the user back to the\nOAuth client, including authorization code (on success) or error (on denial) in\nquery parameters, along with the state parameter if one was provided." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2523, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2523" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1563, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1564, - "name": "redirect_url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Complete redirect URL with authorization code and state parameters (e.g., \"https://app.com/callback?code=xxx&state=yyy\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2525, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2525" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1564] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2523, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2523" - } - ] - } - } - }, - { - "id": 834, - "name": "OAuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 273, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L273" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 835, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 836, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L275" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 837, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 838, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L276" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 839, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L277" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [838, 839] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 275, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L275" - } - ] - } - } - }, - { - "id": 840, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L279" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [836, 840] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 274, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L274" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 841, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 842, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 282, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L282" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 844, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 283, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L283" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 845, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 284, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L284" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [844, 845] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 282, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L282" - } - ] - } - } - }, - { - "id": 846, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 286, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L286" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [842, 846] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 281, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L281" - } - ] - } - } - ] - } - }, - { - "id": 1435, - "name": "OIDCDiscoveryDocument", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document fields.\nPopulated when the server successfully fetches and validates the\nprovider's OpenID Connect discovery document." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2212, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2212" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1436, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1438, - "name": "authorization_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the authorization endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2216" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1437, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The issuer identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2214, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2214" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1440, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the JSON Web Key Set" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2220, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2220" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1442, - "name": "revocation_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the revocation endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2224, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2224" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1446, - "name": "supported_id_token_signing_algs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported ID token signing algorithms" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2232, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2232" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1444, - "name": "supported_response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2228, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2228" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1443, - "name": "supported_scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported scopes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2226, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2226" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1445, - "name": "supported_subject_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported subject types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2230, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2230" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1439, - "name": "token_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the token endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2218, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2218" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1441, - "name": "userinfo_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the userinfo endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2222, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2222" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1438, 1437, 1440, 1442, 1446, 1444, 1443, 1445, 1439, 1441] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2212, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2212" - } - ] - } - } - }, - { - "id": 1300, - "name": "PageParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1831, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1831" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1301, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1302, - "name": "page", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The page number" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1833, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1833" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1303, - "name": "perPage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items returned per page" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1835, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1835" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1302, 1303] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1831, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1831" - } - ] - } - } - }, - { - "id": 1293, - "name": "Pagination", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1824, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1824" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1294, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1296, - "name": "lastPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1827, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1827" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1295, - "name": "nextPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1826, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1826" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1297, - "name": "total", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1828, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1828" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1296, 1295, 1297] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1824, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1824" - } - ], - "indexSignatures": [ - { - "id": 1298, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1825, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1825" - } - ], - "parameters": [ - { - "id": 1299, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 1612, - "name": "PasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/authentication/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2709, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2709" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1613, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1614, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2710, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2710" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1616, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2712, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2712" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1615, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2711, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2711" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialRequestOptions" - }, - "name": "ServerCredentialRequestOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1614, 1616, 1615] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2709, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2709" - } - ] - } - } - }, - { - "id": 1617, - "name": "PasskeyAuthenticationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/authentication/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2716, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2716" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1618, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1619, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2717, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2717" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1620, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2718, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2718" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.dom.ts", - "qualifiedName": "AuthenticationResponseJSON" - }, - "name": "AuthenticationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1619, 1620] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2716, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2716" - } - ] - } - } - }, - { - "id": 1655, - "name": "PasskeyDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2771, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2771" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1657, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to delete" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2773, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2773" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1657] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2771, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2771" - } - ] - } - } - }, - { - "id": 1621, - "name": "PasskeyListItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Item in the passkeys list (GET /passkeys/ and admin list)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2722, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1625, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2725, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2725" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1624, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2724, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2724" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1623, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2723, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2723" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1626, - "name": "last_used_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2726, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2726" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1625, 1624, 1623, 1626] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2722, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2722" - } - ] - } - } - }, - { - "id": 1607, - "name": "PasskeyMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2702, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2702" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1608, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1611, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1610, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2704, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2704" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1609, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2703, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2703" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1611, 1610, 1609] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2702, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2702" - } - ] - } - } - }, - { - "id": 1598, - "name": "PasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2689, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2689" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1599, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1600, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2690" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1602, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2692" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1601, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2691, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2691" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialCreationOptions" - }, - "name": "ServerCredentialCreationOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1600, 1602, 1601] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2689, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2689" - } - ] - } - } - }, - { - "id": 1603, - "name": "PasskeyRegistrationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2696, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2696" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1604, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1605, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2697, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2697" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1606, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2698, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2698" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.dom.ts", - "qualifiedName": "RegistrationResponseJSON" - }, - "name": "RegistrationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1605, 1606] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2696, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2696" - } - ] - } - } - }, - { - "id": 1651, - "name": "PasskeyUpdateParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2764, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2764" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1652, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1654, - "name": "friendlyName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New friendly name (max 120 chars)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2768, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2768" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1653, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2766, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2766" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1654, 1653] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2764, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2764" - } - ] - } - } - }, - { - "id": 789, - "name": "Prettify", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resolve mapped types and show the derived keys and their types when hovering in\nVS Code, instead of just showing the names those mapped types are defined with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ], - "typeParameters": [ - { - "id": 790, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - } - }, - { - "id": 736, - "name": "Provider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue. Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 24, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ], - "elementSummaries": [ - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [ - { - "kind": "text", - "text": "Uses OAuth 1.0a" - } - ], - [ - { - "kind": "text", - "text": "Uses OAuth 2.0" - } - ], - [], - [], - [], - [] - ] - } - }, - { - "id": 1633, - "name": "RegisterPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2738, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2738" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1634, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1635, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2739, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2739" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1636, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1637, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2740, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2740" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1637] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2739, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2739" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1635] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2738, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2738" - } - ] - } - } - }, - { - "id": 794, - "name": "RequestResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "a shared result type that encapsulates errors instead of throwing them, allows you to optionally specify the ErrorType" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 219, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L219" - } - ], - "typeParameters": [ - { - "id": 801, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 802, - "name": "ErrorType", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "default": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 795, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 796, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": 801, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 797, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [796, 797] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 220, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L220" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 798, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 799, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 800, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "extendsType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "trueType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "falseType": { - "type": "reference", - "target": 802, - "name": "ErrorType", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [799, 800] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 224, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L224" - } - ] - } - } - ] - } - }, - { - "id": 803, - "name": "RequestResultSafeDestructure", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "similar to RequestResult except it allows you to destructure the possible shape of the success response\n " - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "RequestResult" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 233, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L233" - } - ], - "typeParameters": [ - { - "id": 810, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 804, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 805, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ], - "type": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 806, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [805, 806] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 807, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 808, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 236, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L236" - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "object" - }, - "trueType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "literal", - "value": null - } - }, - "falseType": { - "type": "literal", - "value": null - } - } - }, - { - "id": 809, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 237, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L237" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [808, 809] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L235" - } - ] - } - } - ] - } - }, - { - "id": 1319, - "name": "RequiredClaims", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1945, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1945" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1320, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1327, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1952, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1952" - } - ], - "type": { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - } - }, - { - "id": 1323, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1948, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1948" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1324, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1949, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1949" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1325, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1950, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1950" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1321, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1946, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1946" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1326, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1951, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1951" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1328, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1953, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1953" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1322, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1947" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1327, 1323, 1324, 1325, 1321, 1326, 1328, 1322] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1945, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1945" - } - ] - } - }, - "extendedBy": [ - { - "type": "reference", - "target": 1329, - "name": "JwtPayload" - } - ] - }, - { - "id": 1093, - "name": "ResendParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 860, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L860" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1096, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 863, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1097, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 864, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L864" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1098, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1100, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 868, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L868" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1099, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 866, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L866" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1100, 1099] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 864, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L864" - } - ] - } - } - }, - { - "id": 1095, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 862, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L862" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1096, 1097, 1095] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L861" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1101, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1104, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 874, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L874" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1105, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1106, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L876" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1106] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 874, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L874" - } - ] - } - } - }, - { - "id": 1103, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 873, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L873" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1102, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 872, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L872" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1089, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1104, 1103, 1102] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 871, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L871" - } - ] - } - } - ] - } - }, - { - "id": 957, - "name": "SignInAnonymouslyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 615, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L615" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 958, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 959, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L616" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 960, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 962, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 624, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L624" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 961, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 622, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L622" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [962, 961] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 616, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L616" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [959] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 615, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L615" - } - ] - } - } - }, - { - "id": 1007, - "name": "SignInWithIdTokenCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 701, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L701" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1008, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1012, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 707, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L707" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1013, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L709" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1014, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 710, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L710" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1015, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1016, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 712, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L712" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1016] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 710, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L710" - } - ] - } - } - }, - { - "id": 1009, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider name or OIDC " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " value identifying which provider should be used to verify the provided token. Supported names: " - }, - { - "kind": "code", - "text": "`google`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`apple`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`azure`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`facebook`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`kakao`" - }, - { - "kind": "text", - "text": ". Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 703, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L703" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1010, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 703, - "character": 97, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L703" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1011, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC ID token issued by the specified provider. The " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " which require that you provide an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " value to be accepted properly. If the token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim you must supply the nonce used to obtain the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1012, 1013, 1014, 1009, 1011] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 701, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L701" - } - ] - } - } - }, - { - "id": 995, - "name": "SignInWithOAuthCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 686, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L686" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 996, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 998, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 689, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L689" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 999, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1002, - "name": "queryParams", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object of query params" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1003, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "indexSignatures": [ - { - "id": 1004, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "parameters": [ - { - "id": 1005, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1000, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 691, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L691" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1001, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A space-separated list of scopes granted to the OAuth application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 693, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L693" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1006, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 697, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L697" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1002, 1000, 1001, 1006] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 689, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L689" - } - ] - } - } - }, - { - "id": 997, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 688, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L688" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [998, 997] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 686, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L686" - } - ] - } - } - }, - { - "id": 1627, - "name": "SignInWithPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2731, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2731" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1628, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1629, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2732, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2732" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1631, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2733, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2733" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1632, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2734, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2734" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1631, 1632] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2732, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2732" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1629] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2731, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2731" - } - ] - } - } - }, - { - "id": 971, - "name": "SignInWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 641, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L641" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 972, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 973, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 642, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L642" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 975, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 643, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L643" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [975] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 642, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L642" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [973] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 641, - "character": 70, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L641" - } - ] - } - } - ] - } - }, - { - "id": 976, - "name": "SignInWithPasswordlessCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 647, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L647" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 977, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 978, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 650, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L650" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 979, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 651, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L651" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 980, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 984, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 663, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L663" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 983, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 661, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L661" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 981, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The redirect url embedded in the email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 653, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L653" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 982, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 655, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L655" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [984, 983, 981, 982] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 651, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L651" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [978, 979] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 648, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L648" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 985, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 987, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 669, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L669" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 988, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 991, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 679, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L679" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 992, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Messaging channel to use (e.g. whatsapp or sms)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 681, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L681" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 990, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 677, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L677" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 989, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 671, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L671" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [991, 992, 990, 989] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 669, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L669" - } - ] - } - } - }, - { - "id": 986, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 668, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L668" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [987, 986] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 666, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L666" - } - ] - } - } - ] - } - }, - { - "id": 1107, - "name": "SignInWithSSO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 880, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L880" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1110, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 885, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L885" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1113, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 889, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L889" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1112, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 887, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L887" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1114, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 895, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113, 1112, 1114] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 885, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L885" - } - ] - } - } - }, - { - "id": 1109, - "name": "providerId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the SSO provider to invoke single-sign on to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 883, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L883" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1110, 1109] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 881, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L881" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1116, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Domain name of the organization for which to invoke single-sign on." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 900, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L900" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1117, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 902, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L902" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1120, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 906, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L906" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1119, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 904, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L904" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1121, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 912, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L912" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1120, 1119, 1121] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 902, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L902" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1116, 1117] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 898, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L898" - } - ] - } - } - ] - } - }, - { - "id": 1304, - "name": "SignOut", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1838, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1838" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1305, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1306, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1849, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1849" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1306] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1838, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1838" - } - ] - } - } - }, - { - "id": 1358, - "name": "SignOutScope", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1999, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1999" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1357, - "name": "SIGN_OUT_SCOPES", - "package": "@supabase/auth-js" - } - } - } - }, - { - "id": 963, - "name": "SignUpWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 628, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L628" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 964, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 965, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 629, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L629" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 966, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 969, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 632, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L632" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 970, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 633, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L633" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 968, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 631, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L631" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 967, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 630, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L630" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [969, 970, 968, 967] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 629, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L629" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [965] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 628, - "character": 70, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L628" - } - ] - } - } - ] - } - }, - { - "id": 1017, - "name": "SolanaWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 716, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L716" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1018, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1023, - "name": "publicKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 718, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L718" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1024, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1025, - "name": "toBase58", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 719, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L719" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1026, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 719, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L719" - } - ], - "signatures": [ - { - "id": 1027, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1025] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 718, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L718" - } - ] - } - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1019, - "name": "signIn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 717, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L717" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1020, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 717, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L717" - } - ], - "signatures": [ - { - "id": 1021, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1022, - "name": "inputs", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1028, - "name": "signMessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 722, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 722, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L722" - } - ], - "signatures": [ - { - "id": 1030, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1031, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - }, - { - "id": 1032, - "name": "encoding", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "utf8" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1023, 1019, 1028] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 716, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L716" - } - ] - } - } - }, - { - "id": 1033, - "name": "SolanaWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 725, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L725" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1034, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1035, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 727, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L727" - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1038, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 735, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L735" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1039, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1041, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 740, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L740" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1042, - "name": "signInWithSolana", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 742, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L742" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "chain" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1040, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 737, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L737" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1041, 1042, 1040] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 735, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L735" - } - ] - } - } - }, - { - "id": 1037, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 733, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L733" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1036, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.solana`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 730, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L730" - } - ], - "type": { - "type": "reference", - "target": 1017, - "name": "SolanaWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1035, 1038, 1037, 1036] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 726, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L726" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1043, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1044, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 748, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L748" - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1045, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Solana compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 751, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L751" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1047, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 756, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L756" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1048, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1049, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 758, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L758" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1049] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 756, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L756" - } - ] - } - } - }, - { - "id": 1046, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ed25519 signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 754, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L754" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1044, 1045, 1047, 1046] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 747, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L747" - } - ] - } - } - ] - } - }, - { - "id": 847, - "name": "SSOResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 289, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L289" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 848, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 849, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " - }, - { - "kind": "code", - "text": "`window.location.href`" - }, - { - "kind": "text", - "text": " to take\nthe user to the authentication flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L297" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [849] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 289, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L289" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1642, - "name": "StartPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2751, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2751" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1643, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1644, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2752, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2752" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1645, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1646, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2753, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2753" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1646] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2752, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2752" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1644] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2751, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2751" - } - ] - } - } - }, - { - "id": 791, - "name": "StrictOmit", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A stricter version of TypeScript's Omit that only allows omitting keys that actually exist.\nThis prevents typos and ensures type safety at compile time.\nUnlike regular Omit, this will error if you try to omit a non-existent key." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 214, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L214" - } - ], - "typeParameters": [ - { - "id": 792, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 793, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 792, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 792, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 793, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1286, - "name": "SupportedStorage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1807, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1807" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PromisifyMethods" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "PromisifyMethods", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1287, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1288, - "name": "isServer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1817, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1817" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1288] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1809, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1809" - } - ] - } - } - ] - } - }, - { - "id": 1492, - "name": "UpdateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing custom provider.\nAll fields are optional. Only provided fields will be updated.\n" - }, - { - "kind": "code", - "text": "`provider_type`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " are immutable and cannot be changed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2334, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2334" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1493, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1497, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2342" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1500, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2348, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2348" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1501, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2350" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1507, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2362, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2362" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1495, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2338, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2338" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1496, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2340, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2340" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1505, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2358, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2358" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1503, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2354, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2354" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1502, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2352" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1504, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2356" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1510, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2368, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2368" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1494, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2336, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2336" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1499, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2346, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2346" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1498, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2344" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1506, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2360" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1508, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2364, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2364" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1509, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2366" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1497, 1500, 1501, 1507, 1495, 1496, 1505, 1503, 1502, 1504, 1510, 1494, 1499, - 1498, 1506, 1508, 1509 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2334, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2334" - } - ] - } - } - }, - { - "id": 1390, - "name": "UpdateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing OAuth client.\nAll fields are optional. Only provided fields will be updated.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2095, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2095" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1392, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2097, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2097" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1393, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2099" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1396, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2105, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2105" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1394, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2101, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2101" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1395, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2103, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2103" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1397, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2107" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1392, 1393, 1396, 1394, 1395, 1397] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2095, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2095" - } - ] - } - } - }, - { - "id": 850, - "name": "UserResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 300, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L300" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 852, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [852] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 300, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L300" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1069, - "name": "VerifyOtpParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 803, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L803" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1070, - "name": "VerifyMobileOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1078, - "name": "VerifyEmailOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1086, - "name": "VerifyTokenHashParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1647, - "name": "VerifyPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2757, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2757" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1648, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1649, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startAuthentication" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2759, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2759" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1650, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.get()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2761, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2761" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1649, 1650] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2757, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2757" - } - ] - } - } - }, - { - "id": 1638, - "name": "VerifyPasskeyRegistrationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2744, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2744" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1639, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1640, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startRegistration" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2746, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2746" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1641, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.create()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2748, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2748" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1640, 1641] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2744, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2744" - } - ] - } - } - }, - { - "id": 785, - "name": "WeakPassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 198, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L198" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 786, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 788, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 200, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L200" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 787, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 784, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [788, 787] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 198, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L198" - } - ] - } - } - }, - { - "id": 784, - "name": "WeakPasswordReasons", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 197, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L197" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1068, - "name": "Web3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 801, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L801" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1033, - "name": "SolanaWeb3Credentials", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1051, - "name": "EthereumWeb3Credentials", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 710, - "name": "AuthAdminApi", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/AuthAdminApi.ts", - "line": 3, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/AuthAdminApi.ts#L3" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1, - "name": "default", - "package": "@supabase/auth-js" - } - }, - "defaultValue": "GoTrueAdminApi" - }, - { - "id": 711, - "name": "AuthClient", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/AuthClient.ts", - "line": 3, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/AuthClient.ts#L3" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 136, - "name": "default", - "package": "@supabase/auth-js" - } - }, - "defaultValue": "GoTrueClient" - }, - { - "id": 725, - "name": "lockInternals", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Debug flag for " - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": ". The auth\nclient ignores both, so this has no client-side effect." - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 17, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L17" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 726, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 727, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [727] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 17, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L17" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1357, - "name": "SIGN_OUT_SCOPES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1998, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1998" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1705, - "name": "isAuthApiError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 75, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L75" - } - ], - "signatures": [ - { - "id": 1706, - "name": "isAuthApiError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 75, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L75" - } - ], - "parameters": [ - { - "id": 1707, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1744, - "name": "AuthApiError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1702, - "name": "isAuthError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L50" - } - ], - "signatures": [ - { - "id": 1703, - "name": "isAuthError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L50" - } - ], - "parameters": [ - { - "id": 1704, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1711, - "name": "isAuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 210, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L210" - } - ], - "signatures": [ - { - "id": 1712, - "name": "isAuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 210, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L210" - } - ], - "parameters": [ - { - "id": 1713, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1714, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 274, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L274" - } - ], - "signatures": [ - { - "id": 1715, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 274, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L274" - } - ], - "parameters": [ - { - "id": 1716, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1720, - "name": "isAuthRefreshDiscardedError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 328, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L328" - } - ], - "signatures": [ - { - "id": 1721, - "name": "isAuthRefreshDiscardedError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 328, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L328" - } - ], - "parameters": [ - { - "id": 1722, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1717, - "name": "isAuthRetryableFetchError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 296, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L296" - } - ], - "signatures": [ - { - "id": 1718, - "name": "isAuthRetryableFetchError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 296, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L296" - } - ], - "parameters": [ - { - "id": 1719, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1708, - "name": "isAuthSessionMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 140, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L140" - } - ], - "signatures": [ - { - "id": 1709, - "name": "isAuthSessionMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 140, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L140" - } - ], - "parameters": [ - { - "id": 1710, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1723, - "name": "isAuthWeakPasswordError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 373, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L373" - } - ], - "signatures": [ - { - "id": 1724, - "name": "isAuthWeakPasswordError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 373, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L373" - } - ], - "parameters": [ - { - "id": 1725, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 712, - "name": "navigatorLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 86, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L86" - } - ], - "signatures": [ - { - "id": 713, - "name": "navigatorLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient", - "target": 136 - }, - { - "kind": "text", - "text": ".\n\nYou can turn on debugging by setting the " - }, - { - "kind": "code", - "text": "`supabase.gotrue-js.locks.debug`" - }, - { - "kind": "text", - "text": "\nlocal storage item to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " - }, - { - "kind": "code", - "text": "`request`" - }, - { - "kind": "text", - "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: navigatorLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 86, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L86" - } - ], - "typeParameters": [ - { - "id": 714, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 715, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 716, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 717, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 718, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 89, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L89" - } - ], - "signatures": [ - { - "id": 719, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 89, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L89" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 714, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 714, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 728, - "name": "processLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 325, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L325" - } - ], - "signatures": [ - { - "id": 729, - "name": "processLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#navigatorLock" - }, - { - "kind": "text", - "text": " in browser environments." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: processLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nawait processLock('migrate', 5000, async () => {\n await runMigration()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 325, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L325" - } - ], - "typeParameters": [ - { - "id": 730, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 731, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 732, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 733, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 734, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 328, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L328" - } - ], - "signatures": [ - { - "id": 735, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 328, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L328" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 730, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 730, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [ - 1744, 1726, 1849, 1832, 1979, 1816, 1907, 1878, 1941, 1923, 1800, 1762, 1958, 1780, 1, - 136, 720 - ] - }, - { - "title": "Interfaces", - "children": [ - 933, 864, 1575, 1675, 1144, 1526, 1279, 1411, 1695, 1208, 1349, 1329, 853, 947, 899, - 891, 926, 867, 896, 1078, 1070, 1086 - ] - }, - { - "title": "Type Aliases", - "children": [ - 862, 738, 737, 1201, 993, 1269, 1266, 1276, 1273, 1192, 1196, 1191, 1193, 1194, 1195, - 1311, 1187, 1310, 1312, 1203, 1197, 1188, 1186, 1179, 1565, 1566, 1572, 1573, 820, 1671, - 1668, 1660, 1661, 1667, 1665, 1658, 1659, 1666, 811, 815, 825, 829, 1292, 1471, 1381, - 1447, 1515, 1514, 1434, 1091, 1050, 1051, 781, 880, 879, 1138, 1128, 1147, 1152, 1148, - 1159, 1133, 1122, 748, 1289, 1313, 1511, 739, 1178, 1177, 1175, 1174, 1176, 1160, 1308, - 1307, 1309, 1173, 1161, 1172, 1165, 1164, 1166, 1170, 1089, 1546, 1552, 1365, 1359, - 1399, 1363, 1398, 1361, 1364, 1362, 1567, 1562, 834, 1435, 1300, 1293, 1612, 1617, 1655, - 1621, 1607, 1598, 1603, 1651, 789, 736, 1633, 794, 803, 1319, 1093, 957, 1007, 995, - 1627, 971, 976, 1107, 1304, 1358, 963, 1017, 1033, 847, 1642, 791, 1286, 1492, 1390, - 850, 1069, 1647, 1638, 785, 784, 1068 - ] - }, - { - "title": "Variables", - "children": [710, 711, 725, 1357] - }, - { - "title": "Functions", - "children": [1705, 1702, 1711, 1714, 1720, 1717, 1708, 1723, 712, 728] - } - ], - "packageName": "@supabase/auth-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Auth JS SDK

    \n\n

    An isomorphic JavaScript SDK for the Supabase Auth API.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/auth-js)](https://www.npmjs.com/package/@supabase/auth-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/auth-js)](https://pkg.pr.new/~/supabase/auth-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Quick start\n\nInstall\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install --save @supabase/auth-js\n```" - }, - { - "kind": "text", - "text": "\n\nUsage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst GOTRUE_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: GOTRUE_URL })\n```" - }, - { - "kind": "text", - "text": "\n\n- " - }, - { - "kind": "code", - "text": "`signUp()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signup\n- " - }, - { - "kind": "code", - "text": "`signIn()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signin\n- " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signout\n\n### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`auth-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst AUTH_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: AUTH_URL, fetch: fetch })\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build auth-js\n\n# Build with watch mode for development\npnpm nx build auth-js --watch\n\n# Individual build targets\npnpm nx build:main auth-js # CommonJS build (dist/main/)\npnpm nx build:module auth-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx lint auth-js # Run ESLint\npnpm nx typecheck auth-js # TypeScript type checking\npnpm nx docs auth-js # Generate documentation\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\n### Testing\n\nThe auth-js package has two test suites:\n\n1. **CLI Tests** - Main test suite using Supabase CLI (331 tests)\n2. **Docker Tests** - Edge case tests requiring specific GoTrue configurations (11 tests)\n\n#### Prerequisites\n\n- **Supabase CLI** - Required for main test suite ([installation guide](https://supabase.com/docs/guides/cli))\n- **Docker** - Required for edge case tests\n\n#### Running Tests\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run main test suite with Supabase CLI (recommended)\npnpm nx test:auth auth-js\n\n# Run Docker-only edge case tests\npnpm nx test:docker auth-js\n\n# Run both test suites\npnpm nx test:auth auth-js && pnpm nx test:docker auth-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Main Test Suite (Supabase CLI)\n\nThe " - }, - { - "kind": "code", - "text": "`test:auth`" - }, - { - "kind": "text", - "text": " command automatically:\n\n1. Stops any existing Supabase instance\n2. Starts a local Supabase instance via CLI\n3. Runs the test suite (excludes " - }, - { - "kind": "code", - "text": "`docker-tests/`" - }, - { - "kind": "text", - "text": " folder)\n4. Cleans up after tests complete\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Individual commands for manual control\npnpm nx test:infra auth-js # Start Supabase CLI\npnpm nx test:suite auth-js # Run tests only\npnpm nx test:clean-post auth-js # Stop Supabase CLI\n```" - }, - { - "kind": "text", - "text": "\n\n#### Docker Tests (Edge Cases)\n\nThe " - }, - { - "kind": "code", - "text": "`test:docker`" - }, - { - "kind": "text", - "text": " target runs tests that require specific GoTrue configurations not possible with a single Supabase CLI instance:\n\n- **Signup disabled** - Tests for disabled signup functionality\n- **Asymmetric JWT (RS256)** - Tests for RS256 JWT verification\n- **Phone OTP / SMS** - Tests requiring Twilio SMS provider\n- **Anonymous sign-in disabled** - Tests for disabled anonymous auth\n\nThese tests are located in " - }, - { - "kind": "code", - "text": "`test/docker-tests/`" - }, - { - "kind": "text", - "text": " and use the Docker Compose setup in " - }, - { - "kind": "code", - "text": "`infra/docker-compose.yml`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Individual commands for manual control\npnpm nx test:docker:infra auth-js # Start Docker containers\npnpm nx test:docker:suite auth-js # Run Docker tests only\npnpm nx test:docker:clean-post auth-js # Stop Docker containers\n```" - }, - { - "kind": "text", - "text": "\n\n#### Development Testing\n\nFor actively developing and debugging tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Start Supabase CLI once\npnpm nx test:infra auth-js\n\n# Run tests multiple times (faster since instance stays up)\npnpm nx test:suite auth-js\n\n# Clean up when done\npnpm nx test:clean-post auth-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure\n\n| Suite | Infrastructure | Configuration |\n| ------------ | -------------- | --------------------------- |\n| CLI Tests | Supabase CLI | " - }, - { - "kind": "code", - "text": "`test/supabase/config.toml`" - }, - { - "kind": "text", - "text": " |\n| Docker Tests | Docker Compose | " - }, - { - "kind": "code", - "text": "`infra/docker-compose.yml`" - }, - { - "kind": "text", - "text": " |\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "2": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.__constructor" - }, - "3": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__0" - }, - "5": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "6": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.url" - }, - "7": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.headers" - }, - "8": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "9": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "11": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.fetch" - }, - "12": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "13": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "14": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "15": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "16": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "17": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "18": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "19": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.experimental" - }, - "20": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.mfa" - }, - "21": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.oauth" - }, - "22": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.customProviders" - }, - "23": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.passkey" - }, - "38": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "39": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "40": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "jwt" - }, - "41": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "scope" - }, - "42": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "43": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "44": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "45": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "46": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "47": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "email" - }, - "48": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "options" - }, - "49": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "50": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "51": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.redirectTo" - }, - "52": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "53": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "54": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "55": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "56": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "57": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "58": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "59": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "60": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "61": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "62": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "63": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "64": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "65": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.aud" - }, - "66": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "67": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "69": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "71": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "72": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "73": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "74": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "75": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "76": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "77": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "78": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "79": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "80": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "81": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "id" - }, - "82": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "shouldSoftDelete" - }, - "136": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "138": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.__constructor" - }, - "139": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "140": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "142": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.admin" - }, - "143": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.mfa" - }, - "144": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.oauth" - }, - "145": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.passkey" - }, - "213": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "214": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "226": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "227": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "230": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "231": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "232": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "233": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "234": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "235": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "236": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "237": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "238": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "239": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "240": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "241": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "242": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "243": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "244": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "authCode" - }, - "245": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "246": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "247": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "248": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "249": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "250": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "251": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "252": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "253": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "254": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "255": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "256": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "257": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "258": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "259": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "298": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "299": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "300": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "301": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "302": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "303": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "304": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "305": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "306": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "307": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "308": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "309": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "310": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "311": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "314": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "315": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "316": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "317": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "318": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "319": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "320": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "321": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "322": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "323": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "324": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "325": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "326": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "327": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "328": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "329": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "330": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "331": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "332": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "333": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "380": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "381": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "382": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "386": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "387": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "388": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "389": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "390": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "391": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "398": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "399": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "400": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "401": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "402": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "403": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "410": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "411": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "412": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "413": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "414": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "451": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "452": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "453": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "454": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "455": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "461": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "462": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "463": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "464": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "465": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "466": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "467": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "468": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "469": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "470": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "471": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "472": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "473": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "474": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "475": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "476": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "477": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "478": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "479": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "480": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "481": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "485": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "486": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "487": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "email" - }, - "488": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "489": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "490": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.redirectTo" - }, - "491": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.captchaToken" - }, - "492": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "493": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "494": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "495": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "496": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "497": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "498": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "499": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "500": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "501": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "502": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "503": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "504": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.identities" - }, - "505": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "506": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "507": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "508": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "509": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "510": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "511": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "512": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "513": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "520": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "521": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "522": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "identity" - }, - "523": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "524": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "525": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "526": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "527": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "528": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "529": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "575": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "576": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "577": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "578": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "579": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "580": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "662": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "663": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "664": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "665": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "666": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "667": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "668": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.allowExpired" - }, - "669": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.jwks" - }, - "670": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "671": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "672": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "673": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "674": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "675": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.claims" - }, - "676": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.header" - }, - "677": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.signature" - }, - "678": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "679": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "680": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "681": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "682": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "683": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "684": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "685": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "686": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "687": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "688": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "689": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "690": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "710": { - "sourceFileName": "src/AuthAdminApi.ts", - "qualifiedName": "AuthAdminApi" - }, - "711": { - "sourceFileName": "src/AuthClient.ts", - "qualifiedName": "AuthClient" - }, - "712": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "713": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "714": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "R" - }, - "715": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "name" - }, - "716": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "717": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "fn" - }, - "718": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "719": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "720": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "721": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.__constructor" - }, - "722": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "723": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "message" - }, - "724": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.isAcquireTimeout" - }, - "725": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "internals" - }, - "726": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__object" - }, - "727": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__object.debug" - }, - "728": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "729": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "730": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "R" - }, - "731": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "name" - }, - "732": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "733": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "fn" - }, - "734": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "735": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "736": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Provider" - }, - "737": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthChangeEventMFA" - }, - "738": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthChangeEvent" - }, - "739": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "LockFunc" - }, - "740": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "741": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "742": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "name" - }, - "743": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "acquireTimeout" - }, - "744": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "fn" - }, - "745": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "746": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "747": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "R" - }, - "748": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueClientOptions" - }, - "749": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "750": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "751": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "752": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "753": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "755": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "756": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "757": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "758": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "url" - }, - "760": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "761": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "762": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "764": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "765": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "766": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "767": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "768": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "769": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "770": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "771": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "772": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "773": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "message" - }, - "774": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "args" - }, - "775": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "776": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.hasCustomAuthorizationHeader" - }, - "777": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "778": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "779": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "780": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "781": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ExperimentalFeatureFlags" - }, - "782": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "783": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkey" - }, - "784": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "785": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPassword" - }, - "786": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "787": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.reasons" - }, - "788": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "789": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Prettify" - }, - "790": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "791": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "StrictOmit" - }, - "792": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "793": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "794": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequestResult" - }, - "795": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "796": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "797": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "798": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "799": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "800": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "801": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "802": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorType" - }, - "803": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequestResultSafeDestructure" - }, - "804": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "805": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "806": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "807": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "808": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "809": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "810": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "811": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthResponse" - }, - "812": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "813": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "814": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "815": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthResponsePassword" - }, - "816": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "817": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "818": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "819": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.weak_password" - }, - "820": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOtpResponse" - }, - "821": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "822": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "823": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "824": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.messageId" - }, - "825": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthTokenResponse" - }, - "826": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "827": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "828": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "829": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthTokenResponsePassword" - }, - "830": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "831": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "832": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "833": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.weakPassword" - }, - "834": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthResponse" - }, - "835": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "836": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "837": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "838": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "839": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "840": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "841": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "842": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "843": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "844": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "845": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "846": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "847": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SSOResponse" - }, - "848": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "849": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "850": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserResponse" - }, - "851": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "852": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "853": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session" - }, - "854": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.provider_token" - }, - "855": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.provider_refresh_token" - }, - "856": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.access_token" - }, - "857": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.refresh_token" - }, - "858": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.expires_in" - }, - "859": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.expires_at" - }, - "860": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.token_type" - }, - "861": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.user" - }, - "862": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMRMethod" - }, - "863": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "864": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry" - }, - "865": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry.method" - }, - "866": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry.timestamp" - }, - "867": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity" - }, - "868": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.id" - }, - "869": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.user_id" - }, - "870": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_data" - }, - "871": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "874": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_id" - }, - "875": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.provider" - }, - "876": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.created_at" - }, - "877": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.last_sign_in_at" - }, - "878": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.updated_at" - }, - "879": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorType" - }, - "880": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Factor" - }, - "881": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "882": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "883": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "884": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factor_type" - }, - "885": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.status" - }, - "886": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "887": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "888": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.last_challenged_at" - }, - "889": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Type" - }, - "890": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Status" - }, - "891": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata" - }, - "892": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.provider" - }, - "893": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.providers" - }, - "894": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.__index" - }, - "896": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserMetadata" - }, - "897": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserMetadata.__index" - }, - "899": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User" - }, - "900": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.id" - }, - "901": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.app_metadata" - }, - "902": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.user_metadata" - }, - "903": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.aud" - }, - "904": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.confirmation_sent_at" - }, - "905": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.recovery_sent_at" - }, - "906": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email_change_sent_at" - }, - "907": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.new_email" - }, - "908": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.new_phone" - }, - "909": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.invited_at" - }, - "910": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.action_link" - }, - "911": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email" - }, - "912": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.phone" - }, - "913": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.created_at" - }, - "914": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.confirmed_at" - }, - "915": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email_confirmed_at" - }, - "916": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.phone_confirmed_at" - }, - "917": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.last_sign_in_at" - }, - "918": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.role" - }, - "919": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.updated_at" - }, - "920": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.identities" - }, - "921": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.is_anonymous" - }, - "922": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.is_sso_user" - }, - "923": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.factors" - }, - "924": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.deleted_at" - }, - "925": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.banned_until" - }, - "926": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes" - }, - "927": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.current_password" - }, - "928": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.email" - }, - "929": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.phone" - }, - "930": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.password" - }, - "931": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.nonce" - }, - "932": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.data" - }, - "933": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes" - }, - "934": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.user_metadata" - }, - "935": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.app_metadata" - }, - "936": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.email_confirm" - }, - "937": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.phone_confirm" - }, - "938": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.ban_duration" - }, - "939": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.role" - }, - "940": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.password_hash" - }, - "941": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.id" - }, - "942": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "nonce" - }, - "943": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "phone" - }, - "944": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "email" - }, - "945": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "password" - }, - "946": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "current_password" - }, - "947": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription" - }, - "948": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.id" - }, - "949": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.callback" - }, - "950": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "951": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "952": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "event" - }, - "953": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "session" - }, - "954": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.unsubscribe" - }, - "955": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "956": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "957": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInAnonymouslyCredentials" - }, - "958": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "959": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "960": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "961": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "962": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "963": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignUpWithPasswordCredentials" - }, - "964": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "965": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "966": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "967": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "968": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "969": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "970": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "971": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasswordCredentials" - }, - "972": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "973": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "974": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "975": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "976": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasswordlessCredentials" - }, - "977": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "978": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "979": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "980": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "981": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "982": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "983": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "984": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "985": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "986": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "987": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "988": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "989": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "990": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "991": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "992": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "993": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthFlowType" - }, - "994": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "995": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithOAuthCredentials" - }, - "996": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "997": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "998": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "999": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1000": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1001": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1002": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.queryParams" - }, - "1003": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1004": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1006": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1007": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithIdTokenCredentials" - }, - "1008": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1009": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1010": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1011": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token" - }, - "1012": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1013": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nonce" - }, - "1014": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1015": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1016": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1017": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SolanaWallet" - }, - "1018": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1019": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signIn" - }, - "1020": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1021": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1022": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "inputs" - }, - "1023": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.publicKey" - }, - "1024": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1025": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.toBase58" - }, - "1026": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1027": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1028": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signMessage" - }, - "1029": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1030": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1031": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "message" - }, - "1032": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "encoding" - }, - "1033": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SolanaWeb3Credentials" - }, - "1034": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1035": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1036": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1037": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1038": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1039": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1040": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1041": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1042": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signInWithSolana" - }, - "1043": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1044": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1045": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1046": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1047": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1048": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1049": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1050": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EthereumWallet" - }, - "1051": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EthereumWeb3Credentials" - }, - "1052": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1053": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1054": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1055": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1056": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1057": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1058": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1059": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1060": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signInWithEthereum" - }, - "1061": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1062": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1063": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1064": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1065": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1066": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1067": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1068": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Web3Credentials" - }, - "1069": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyOtpParams" - }, - "1070": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams" - }, - "1071": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.phone" - }, - "1072": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.token" - }, - "1073": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.type" - }, - "1074": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.options" - }, - "1075": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1076": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1077": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1078": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams" - }, - "1079": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.email" - }, - "1080": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.token" - }, - "1081": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.type" - }, - "1082": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.options" - }, - "1083": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1084": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1085": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1086": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams" - }, - "1087": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.token_hash" - }, - "1088": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.type" - }, - "1089": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MobileOtpType" - }, - "1090": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1091": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EmailOtpType" - }, - "1092": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1093": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ResendParams" - }, - "1094": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1095": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1096": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1097": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1098": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1099": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1100": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1101": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1102": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1103": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1104": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1105": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1106": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1107": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithSSO" - }, - "1108": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1109": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providerId" - }, - "1110": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1111": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1112": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1113": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1114": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1115": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1116": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.domain" - }, - "1117": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1118": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1119": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1120": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1121": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1122": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateSignupLinkParams" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1124": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1125": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1126": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.password" - }, - "1127": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1128": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateInviteOrMagiclinkParams" - }, - "1129": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1130": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1131": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1132": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1133": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateRecoveryLinkParams" - }, - "1134": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1135": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1136": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1137": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1138": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateEmailChangeLinkParams" - }, - "1139": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1140": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1141": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1142": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.newEmail" - }, - "1143": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1144": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions" - }, - "1145": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.data" - }, - "1146": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.redirectTo" - }, - "1147": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkParams" - }, - "1148": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkResponse" - }, - "1149": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1150": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.properties" - }, - "1151": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1152": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkProperties" - }, - "1153": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1154": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.action_link" - }, - "1155": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_otp" - }, - "1156": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.hashed_token" - }, - "1157": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_to" - }, - "1158": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.verification_type" - }, - "1159": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkType" - }, - "1160": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParams" - }, - "1161": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAUnenrollParams" - }, - "1162": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1163": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factorId" - }, - "1164": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParams" - }, - "1165": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParams" - }, - "1166": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFields" - }, - "1167": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1168": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.webauthn" - }, - "1169": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1170": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParams" - }, - "1171": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1172": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParams" - }, - "1173": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFATOTPChannel" - }, - "1174": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeTOTPParams" - }, - "1175": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParams" - }, - "1176": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParams" - }, - "1177": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParams" - }, - "1178": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyParams" - }, - "1179": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponseData" - }, - "1180": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1181": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1182": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_type" - }, - "1183": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_in" - }, - "1184": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.refresh_token" - }, - "1185": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1186": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponse" - }, - "1187": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponse" - }, - "1188": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAUnenrollResponse" - }, - "1189": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1190": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1191": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponse" - }, - "1192": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponse" - }, - "1193": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponse" - }, - "1194": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseDataJSON" - }, - "1195": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnServerResponse" - }, - "1196": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponse" - }, - "1197": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAListFactorsResponse" - }, - "1198": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1199": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.all" - }, - "1200": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1201": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthenticatorAssuranceLevels" - }, - "1202": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1203": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - }, - "1204": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1205": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.currentLevel" - }, - "1206": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nextLevel" - }, - "1207": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.currentAuthenticationMethods" - }, - "1208": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi" - }, - "1209": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1210": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1211": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1212": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1213": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1214": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1215": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1216": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1217": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1218": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1219": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1220": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1221": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1222": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1223": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1224": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1225": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1226": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1227": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1228": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1229": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1230": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1231": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1232": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1233": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1234": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1235": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1236": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1237": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1238": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1239": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1240": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1241": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1242": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1243": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1244": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1245": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1246": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1247": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1248": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1249": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1250": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1251": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1252": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1253": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1254": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "1255": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "1256": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1257": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "1258": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "1259": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1260": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "1261": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "1262": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "1263": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "1264": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "jwt" - }, - "1265": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.webauthn" - }, - "1266": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorResponse" - }, - "1267": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1268": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1269": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorParams" - }, - "1270": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1271": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1272": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1273": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsResponse" - }, - "1274": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1275": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factors" - }, - "1276": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsParams" - }, - "1277": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1278": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1279": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi" - }, - "1280": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "1281": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "1282": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1283": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "1284": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "1285": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1286": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupportedStorage" - }, - "1287": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1288": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.isServer" - }, - "1289": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "InitializeResult" - }, - "1290": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1291": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1292": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CallRefreshTokenResult" - }, - "1293": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Pagination" - }, - "1294": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1295": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nextPage" - }, - "1296": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lastPage" - }, - "1297": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.total" - }, - "1298": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1300": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PageParams" - }, - "1301": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1302": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.page" - }, - "1303": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.perPage" - }, - "1304": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignOut" - }, - "1305": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1306": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1307": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParams" - }, - "1308": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParams" - }, - "1309": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnParams" - }, - "1310": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponse" - }, - "1311": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponse" - }, - "1312": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnResponse" - }, - "1313": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtHeader" - }, - "1314": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1315": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.alg" - }, - "1316": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1317": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.kid" - }, - "1318": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.typ" - }, - "1319": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequiredClaims" - }, - "1320": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1321": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "1322": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "1323": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1324": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "1325": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "1326": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "1327": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "1328": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "1329": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload" - }, - "1330": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.email" - }, - "1331": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.phone" - }, - "1332": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.is_anonymous" - }, - "1333": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.jti" - }, - "1334": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.nbf" - }, - "1335": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.app_metadata" - }, - "1336": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.user_metadata" - }, - "1337": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.amr" - }, - "1338": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.ref" - }, - "1339": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "1340": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "1341": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1342": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "1343": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "1344": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "1345": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "1346": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "1347": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.__index" - }, - "1349": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK" - }, - "1350": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.kty" - }, - "1351": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1352": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.key_ops" - }, - "1353": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.alg" - }, - "1354": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.kid" - }, - "1355": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.__index" - }, - "1357": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SIGN_OUT_SCOPES" - }, - "1358": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignOutScope" - }, - "1359": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientGrantType" - }, - "1360": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1361": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientResponseType" - }, - "1362": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientType" - }, - "1363": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientRegistrationType" - }, - "1364": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientTokenEndpointAuthMethod" - }, - "1365": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClient" - }, - "1366": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1368": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1369": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1370": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_type" - }, - "1371": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1372": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.registration_type" - }, - "1373": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1374": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1375": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1376": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1377": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "1378": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1379": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1380": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1381": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CreateOAuthClientParams" - }, - "1382": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1383": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1384": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1385": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1386": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1387": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "1388": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1389": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1390": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UpdateOAuthClientParams" - }, - "1391": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1392": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1393": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1394": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1395": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1396": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1397": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1398": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientResponse" - }, - "1399": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientListResponse" - }, - "1400": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1401": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1402": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "1404": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1405": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1406": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1407": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1408": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1409": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "1410": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1411": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi" - }, - "1412": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "1413": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "1414": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1415": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "1416": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "1417": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1418": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "1419": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "1420": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1421": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "1422": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "1423": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1424": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1425": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "1426": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "1427": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1428": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1429": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1430": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1431": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "1432": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "1433": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1434": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderType" - }, - "1435": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OIDCDiscoveryDocument" - }, - "1436": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1437": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1438": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_endpoint" - }, - "1439": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint" - }, - "1440": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1441": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_endpoint" - }, - "1442": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.revocation_endpoint" - }, - "1443": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_scopes" - }, - "1444": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_response_types" - }, - "1445": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_subject_types" - }, - "1446": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_id_token_signing_algs" - }, - "1447": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomOAuthProvider" - }, - "1448": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1449": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1450": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "1451": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "1452": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1453": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1454": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1455": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1456": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1457": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1458": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1459": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1460": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1461": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1462": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1463": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1464": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1465": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1466": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1467": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1468": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_document" - }, - "1469": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1470": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1471": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CreateCustomProviderParams" - }, - "1472": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1473": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "1474": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "1475": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1476": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1477": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1478": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1479": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1480": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1481": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1482": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1483": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1484": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1485": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1486": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1487": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1488": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1489": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1490": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1491": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1492": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UpdateCustomProviderParams" - }, - "1493": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1494": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1495": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1496": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1497": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1498": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1499": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1500": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1501": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1502": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1503": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1504": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1505": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1506": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1507": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1508": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1509": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1510": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1511": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListCustomProvidersParams" - }, - "1512": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1513": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1514": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderResponse" - }, - "1515": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderListResponse" - }, - "1516": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1517": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1518": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1519": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "1520": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1521": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1522": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1523": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1524": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "1525": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1526": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi" - }, - "1527": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "1528": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "1529": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1530": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "1531": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "1532": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1533": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "1534": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "1535": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1536": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "1537": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "1538": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1539": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1540": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "1541": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "1542": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1543": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1544": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1545": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1546": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationClient" - }, - "1547": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1548": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1549": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1550": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.uri" - }, - "1551": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1552": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationDetails" - }, - "1553": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1554": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_id" - }, - "1555": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uri" - }, - "1556": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "1557": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1558": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1559": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1560": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1561": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1562": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthRedirect" - }, - "1563": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1564": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_url" - }, - "1565": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthAuthorizationDetailsResponse" - }, - "1566": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthConsentResponse" - }, - "1567": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthGrant" - }, - "1568": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1569": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "1570": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1571": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.granted_at" - }, - "1572": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthGrantsResponse" - }, - "1573": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthRevokeGrantResponse" - }, - "1574": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1575": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi" - }, - "1576": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "1577": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "1578": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1579": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "1580": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "1581": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1582": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1583": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1584": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1585": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "1586": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "1587": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1588": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1589": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1590": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1591": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "1592": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "1593": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "1594": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "1595": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1596": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1597": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clientId" - }, - "1598": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationOptionsResponse" - }, - "1599": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1600": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1601": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1602": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "1603": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationVerifyParams" - }, - "1604": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1605": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1606": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1607": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyMetadata" - }, - "1608": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1609": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1610": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1611": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1612": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationOptionsResponse" - }, - "1613": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1614": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1615": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1616": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "1617": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationVerifyParams" - }, - "1618": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1619": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1620": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1621": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyListItem" - }, - "1622": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1623": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1624": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1625": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1626": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.last_used_at" - }, - "1627": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasskeyCredentials" - }, - "1628": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1629": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1630": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1631": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1632": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "1633": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RegisterPasskeyCredentials" - }, - "1634": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1635": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1636": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1637": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "1638": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyPasskeyRegistrationParams" - }, - "1639": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1640": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "1641": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1642": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "StartPasskeyAuthenticationParams" - }, - "1643": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1644": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1645": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1646": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1647": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyPasskeyAuthenticationParams" - }, - "1648": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1649": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "1650": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1651": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyUpdateParams" - }, - "1652": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1653": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1654": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendlyName" - }, - "1655": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyDeleteParams" - }, - "1656": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1657": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1658": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationOptionsResponse" - }, - "1659": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationVerifyResponse" - }, - "1660": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationOptionsResponse" - }, - "1661": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationVerifyResponse" - }, - "1662": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1663": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1664": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1665": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyListResponse" - }, - "1666": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyUpdateResponse" - }, - "1667": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyDeleteResponse" - }, - "1668": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminListParams" - }, - "1669": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1670": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1671": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminDeleteParams" - }, - "1672": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1673": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1674": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1675": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi" - }, - "1676": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "1677": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "1678": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "1679": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "1680": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1681": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "1682": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "1683": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1684": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "1685": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "1686": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1687": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "1688": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "1689": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "1690": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "1691": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1692": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "1693": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "1694": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1695": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi" - }, - "1696": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "1697": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "1698": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1699": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "1700": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "1701": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1702": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "1703": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "1704": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1705": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "1706": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "1707": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1708": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "1709": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "1710": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1711": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "1712": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "1713": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1714": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "1715": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "1716": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1717": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "1718": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "1719": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1720": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "1721": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "1722": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1723": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "1724": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "1725": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1726": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "1727": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.__constructor" - }, - "1728": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "1729": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1730": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1731": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1732": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1733": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1734": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "1736": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1737": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1738": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1739": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1740": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1741": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1742": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1743": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1744": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "1745": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError.__constructor" - }, - "1746": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "1747": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1748": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1749": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1750": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError.status" - }, - "1751": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1752": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1754": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1755": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1756": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1757": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1758": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1759": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1760": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1761": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1762": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "1763": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.__constructor" - }, - "1764": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "1765": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1766": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "originalError" - }, - "1767": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.originalError" - }, - "1768": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1769": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1770": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "1772": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1773": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1774": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1775": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1776": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1777": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1778": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1779": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1780": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "1781": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.__constructor" - }, - "1782": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "1783": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1784": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "name" - }, - "1785": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1786": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1787": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1788": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1789": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1790": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1792": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1793": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1794": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1795": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1796": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1797": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1798": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1799": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1800": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "1801": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError.__constructor" - }, - "1802": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "1803": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1804": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1805": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1806": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1808": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1809": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1810": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1811": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1812": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1813": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1814": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1815": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1816": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "1817": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError.__constructor" - }, - "1818": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "1819": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1820": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1821": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1822": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1824": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1825": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1826": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1827": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1828": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1829": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1830": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1831": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1832": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "1833": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError.__constructor" - }, - "1834": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "1835": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1836": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1837": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1838": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1839": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1841": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1842": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1843": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1844": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1845": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1846": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1847": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1848": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1849": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "1850": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.__constructor" - }, - "1851": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "1852": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1853": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "details" - }, - "1854": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1855": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1856": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1857": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.details" - }, - "1858": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1859": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1860": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1861": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "1862": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "1863": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1864": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1865": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1866": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1867": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1868": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1869": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "1870": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1871": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1872": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1873": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1874": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1875": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1876": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1878": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "1879": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.__constructor" - }, - "1880": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "1881": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1882": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "details" - }, - "1883": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1884": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1885": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1886": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.details" - }, - "1887": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1888": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1889": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1890": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "1891": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "1892": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1893": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1894": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1895": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1896": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1897": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1898": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "1899": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1900": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1901": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1902": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1903": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1904": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1905": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1907": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "1908": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError.__constructor" - }, - "1909": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "1910": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1911": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1912": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1913": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1915": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1916": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1917": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1918": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1919": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1920": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1921": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1922": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1923": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "1924": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError.__constructor" - }, - "1925": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "1926": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1927": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1928": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1929": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1930": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1931": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1933": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1934": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1935": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1936": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1937": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1938": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1939": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1940": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1941": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "1942": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError.__constructor" - }, - "1943": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "1944": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1945": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1946": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1947": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1948": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1950": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1951": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1952": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1953": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1954": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1955": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1956": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1957": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1958": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "1959": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.__constructor" - }, - "1960": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "1961": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1962": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1963": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "reasons" - }, - "1964": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.reasons" - }, - "1965": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "1966": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "1967": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1968": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1969": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1970": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1971": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1972": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1973": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.reasons" - }, - "1974": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1975": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1976": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1977": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1979": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "1980": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError.__constructor" - }, - "1981": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "1982": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1983": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1984": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1985": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1986": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1988": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1989": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1990": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1991": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1992": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1993": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1994": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1995": { - "sourceFileName": "", - "qualifiedName": "__type" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } - }, - { - "id": 0, - "name": "@supabase/postgrest-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 774, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 775, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 776, - "name": "PostgrestBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 777, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 778, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 779, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "parameters": [ - { - "id": 780, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 781, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 786, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 789, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 791, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 792, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 793, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 794, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 795, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 796, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 784, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 797, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 782, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 800, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 785, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 798, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 787, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 788, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 783, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 799, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 786, 789, 784, 797, 782, 800, 785, 798, 787, 788, 783, 799 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 805, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 808, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 809, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 810, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 811, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 812, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 813, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 814, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 815, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 803, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 816, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 801, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 819, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 804, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 817, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 806, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 807, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 802, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 818, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 856, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 857, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 858, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 859, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 861, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [861] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 862, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 863, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [863] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 828, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 829, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 830, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 853, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L565" - } - ], - "signatures": [ - { - "id": 854, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L565" - } - ], - "typeParameters": [ - { - "id": 855, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 855, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 824, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 825, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 826, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 827, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 822, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 823, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 831, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 832, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 833, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 834, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 835, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 836, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 837, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 838, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 839, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 840, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 841, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 842, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - }, - { - "id": 820, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 821, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [775] - }, - { - "title": "Properties", - "children": [805, 808, 803, 816, 801, 819, 804, 817, 806, 807, 802, 818] - }, - { - "title": "Methods", - "children": [856, 828, 853, 824, 822, 831, 820] - } - ], - "categories": [ - { - "title": "Database", - "children": [775, 856, 853, 824, 822, 820] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [828] - }, - { - "title": "Other", - "children": [805, 808, 803, 816, 801, 819, 804, 817, 806, 807, 802, 818, 831] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 68, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L68" - } - ], - "typeParameters": [ - { - "id": 864, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 865, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 866, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 604, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - }, - { - "id": 9, - "name": "PostgrestClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "PostgREST client." - } - ] - }, - "children": [ - { - "id": 10, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L86" - } - ], - "signatures": [ - { - "id": 11, - "name": "PostgrestClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a PostgREST client." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('profiles').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- A " - }, - { - "kind": "code", - "text": "`timeout`" - }, - { - "kind": "text", - "text": " option (in milliseconds) can be set to automatically abort requests that take too long.\n- A " - }, - { - "kind": "code", - "text": "`urlLengthLimit`" - }, - { - "kind": "text", - "text": " option (default: 8000) can be set to control when URL length warnings are included in error messages for aborted requests." - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {\n headers: { apikey: 'your-publishable-key' },\n schema: 'public',\n timeout: 30000, // 30 second timeout\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L86" - } - ], - "typeParameters": [ - { - "id": 12, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 13, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 14, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 15, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 19, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L19" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [15] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 18, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L18" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - }, - { - "id": 17, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 18, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 19, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the PostgREST endpoint" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 20, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 24, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 98, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L98" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 25, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 26, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 27, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 28, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 29, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 30, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 31, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 22, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 96, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L96" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 34, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\n When enabled, idempotent requests (GET, HEAD, OPTIONS) that fail with network\n errors or HTTP 503/520 responses will be automatically retried up to 3 times\n with exponential backoff (1s, 2s, 4s). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 101, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L101" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 23, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to switch to" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 97, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L97" - } - ], - "type": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - }, - { - "id": 32, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout in milliseconds for all requests. When set, requests will automatically abort after this duration to prevent indefinite hangs." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 99, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L99" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 33, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length in characters before warnings/errors are triggered. Defaults to 8000." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L100" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "8000" - } - ], - "groups": [ - { - "title": "Properties", - "children": [24, 22, 34, 23, 32, 33] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 95, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L95" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 9, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 38, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 40, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L40" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 40, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 41, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 42, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 43, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 44, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 45, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 36, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L38" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 47, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 37, - "name": "schemaName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L39" - } - ], - "type": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - }, - { - "id": 35, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 41, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L41" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 48, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a query on a table or a view." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "relation", - "content": [ - { - "kind": "text", - "text": "The table or view name to query" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L152" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L156" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L166" - } - ], - "signatures": [ - { - "id": 49, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L152" - } - ], - "typeParameters": [ - { - "id": 50, - "name": "TableName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 51, - "name": "Table", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 52, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 50, - "name": "TableName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 51, - "name": "Table", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 50, - "name": "TableName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - }, - { - "id": 53, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L156" - } - ], - "typeParameters": [ - { - "id": 54, - "name": "ViewName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 55, - "name": "View", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 56, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 54, - "name": "ViewName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 55, - "name": "View", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 54, - "name": "ViewName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 61, - "name": "rpc", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L374" - } - ], - "signatures": [ - { - "id": 62, - "name": "rpc", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a function call." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// For cross-schema functions where type inference fails, use overrideTypes:\nconst { data } = await supabase\n .schema('schema_b')\n .rpc('function_a', {})\n .overrideTypes<{ id: string; user_id: string }[]>()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function without arguments", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('hello_world')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function without arguments\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function hello_world() returns text as $$\n select 'Hello world';\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function without arguments\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"Hello world\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function with arguments", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('echo', { say: '👋' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with arguments\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function echo(say text) returns text as $$\n select say;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with arguments\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": \"👋\",\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk processing\nYou can process large payloads by passing in an array as an argument." - } - ] - }, - { - "tag": "@example", - "name": "Bulk processing", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('add_one_each', { arr: [1, 2, 3] })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk processing\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function add_one_each(arr int[]) returns int[] as $$\n select array_agg(n + 1) from unnest(arr) as n;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk processing\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n 2,\n 3,\n 4\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\nPostgres functions that return tables can also be combined with [Filters](/docs/reference/javascript/using-filters) and [Modifiers](/docs/reference/javascript/using-modifiers)." - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function with filters", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .rpc('list_stored_countries')\n .eq('id', 1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'),\n (2, 'The Shire');\n\ncreate function list_stored_countries() returns setof countries as $$\n select * from countries;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": 1,\n \"name\": \"Rohan\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Call a read-only Postgres function", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('hello_world', undefined, { get: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a read-only Postgres function\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function hello_world() returns text as $$\n select 'Hello world';\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a read-only Postgres function\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"Hello world\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L374" - } - ], - "typeParameters": [ - { - "id": 63, - "name": "FnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 64, - "name": "Args", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "default": { - "type": "intrinsic", - "name": "never" - } - }, - { - "id": 65, - "name": "FilterBuilder", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/rpc.ts", - "qualifiedName": "RpcFunctionNotFound" - }, - "typeArguments": [ - { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RpcFunctionNotFound", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/rpc.ts", - "qualifiedName": "GetRpcFunctionFilterBuilderByArgs" - }, - "typeArguments": [ - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 64, - "name": "Args", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "GetRpcFunctionFilterBuilderByArgs", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 66, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function name to call" - } - ] - }, - "type": { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 67, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The arguments to pass to the function call" - } - ] - }, - "type": { - "type": "reference", - "target": 64, - "name": "Args", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "defaultValue": "..." - }, - { - "id": 68, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 72, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 392, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L392" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 71, - "name": "get", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the function will be called with\nread-only access mode." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 391, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L391" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 70, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 390, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L390" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [72, 71, 70] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 389, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L389" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Result" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "RelationName" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Relationships" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "RPC" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 57, - "name": "schema", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L192" - } - ], - "signatures": [ - { - "id": 58, - "name": "schema", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L192" - } - ], - "typeParameters": [ - { - "id": 59, - "name": "DynamicSchema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 60, - "name": "schema", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema to query" - } - ] - }, - "type": { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 9, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [10] - }, - { - "title": "Properties", - "children": [38, 36, 47, 37, 35, 46] - }, - { - "title": "Methods", - "children": [48, 61, 57] - } - ], - "categories": [ - { - "title": "Database", - "children": [10, 48, 61, 57] - }, - { - "title": "Other", - "children": [38, 36, 47, 37, 35, 46] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 16, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L16" - } - ], - "typeParameters": [ - { - "id": 74, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)" - } - ] - }, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 75, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 77, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 19, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L19" - } - ], - "type": { - "type": "inferred", - "name": "I", - "constraint": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [77] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 18, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L18" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 22, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L22" - } - ] - } - } - } - }, - { - "id": 79, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n" - }, - { - "kind": "code", - "text": "`\"public\"`" - }, - { - "kind": "text", - "text": ", this must be supplied manually." - } - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 80, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 867, - "name": "PostgrestError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error format\n\nReturned by every PostgREST request that fails. When something fails, the\nsingle most useful field is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — Postgres often returns the\nactionable fix there, not in " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": ". Always log the full object (e.g.\n" - }, - { - "kind": "code", - "text": "`console.error(error)`" - }, - { - "kind": "text", - "text": "); logging only " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": " hides the hint.\n\nRead the fields in roughly this order of usefulness:\n\n- " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — actionable guidance from the database when available. For\n permission-denied errors (" - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "), this is the literal SQL to fix the\n problem, e.g.\n " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.users TO anon;\"`" - }, - { - "kind": "text", - "text": ".\n Missing column? " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " suggests the column you probably meant. Whenever\n Postgres knows the fix, it puts it in " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": " — stable error code from PostgREST (e.g. " - }, - { - "kind": "code", - "text": "`PGRST301`" - }, - { - "kind": "text", - "text": ") or Postgres\n (e.g. " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "). Branch on this rather than on " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " text.\n- " - }, - { - "kind": "code", - "text": "`details`" - }, - { - "kind": "text", - "text": " — extra context, often the offending value, key, or row.\n- " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " — human-readable summary. Useful in UI strings; less useful\n for debugging.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", - "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" - } - ] - }, - "children": [ - { - "id": 868, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "signatures": [ - { - "id": 869, - "name": "PostgrestError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport PostgrestError from '@supabase/postgrest-js'\n\nthrow new PostgrestError({\n message: 'Row level security prevented the request',\n details: 'RLS denied the insert',\n hint: 'Check your policies',\n code: 'PGRST301',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "parameters": [ - { - "id": 870, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 875, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 73, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 873, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 874, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 872, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [875, 873, 874, 872] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 867, - "name": "PostgrestError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 878, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L28" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 876, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 877, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L27" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 879, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "signatures": [ - { - "id": 880, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 881, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 886, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 76, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 884, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 885, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 62, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 883, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 882, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [886, 884, 885, 883, 882] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [868] - }, - { - "title": "Properties", - "children": [878, 876, 877] - }, - { - "title": "Methods", - "children": [879] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 25, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L25" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 186, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 187, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 188, - "name": "PostgrestFilterBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 189, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 190, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 191, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 192, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 193, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 194, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 195, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 196, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 197, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 202, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 205, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 206, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 207, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 208, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 209, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 210, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 211, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 212, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 200, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 213, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 198, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 216, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 201, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 203, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 204, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 199, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 215, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 202, 205, 200, 213, 198, 216, 201, 214, 203, 204, 199, 215 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 606, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 605, - "name": "default.constructor" - } - }, - { - "id": 551, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 721, - "name": "default.body" - } - }, - { - "id": 554, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 555, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 556, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 557, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 558, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 559, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 560, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 561, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 724, - "name": "default.fetch" - } - }, - { - "id": 549, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 719, - "name": "default.headers" - } - }, - { - "id": 562, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 732, - "name": "default.isMaybeSingle" - } - }, - { - "id": 547, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 717, - "name": "default.method" - } - }, - { - "id": 565, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": 735, - "name": "default.retryEnabled" - } - }, - { - "id": 550, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 720, - "name": "default.schema" - } - }, - { - "id": 563, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 733, - "name": "default.shouldStripNulls" - } - }, - { - "id": 552, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "target": 722, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 553, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 723, - "name": "default.signal" - } - }, - { - "id": 548, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 718, - "name": "default.url" - } - }, - { - "id": 564, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 734, - "name": "default.urlLengthLimit" - } - }, - { - "id": 516, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "signatures": [ - { - "id": 517, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "parameters": [ - { - "id": 518, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 687, - "name": "default.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 686, - "name": "default.abortSignal" - } - }, - { - "id": 355, - "name": "containedBy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is contained by " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('classes')\n .select('name')\n .containedBy('days', ['monday', 'tuesday', 'wednesday', 'friday'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n classes (\n id int8 primary key,\n name text,\n days text[]\n );\n\ninsert into\n classes (id, name, days)\nvalues\n (1, 'Chemistry', array['monday', 'friday']),\n (2, 'History', array['monday', 'wednesday', 'thursday']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Chemistry\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .containedBy('during', '[2000-01-01 00:00, 2000-01-01 23:59)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On `jsonb` columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select('name')\n .containedBy('address', {})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210, \"street\": \"Melrose Place\" }'),\n (2, 'Jane', '{}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Jane\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1003, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1003" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1007, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1007" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1138" - } - ], - "signatures": [ - { - "id": 356, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1003, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1003" - } - ], - "typeParameters": [ - { - "id": 357, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 358, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 357, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 359, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 357, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 360, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1007, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1007" - } - ], - "parameters": [ - { - "id": 361, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 362, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 347, - "name": "contains", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " contains every element appearing in " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('issues')\n .select()\n .contains('tags', ['is:open', 'priority:low'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n issues (\n id int8 primary key,\n title text,\n tags text[]\n );\n\ninsert into\n issues (id, title, tags)\nvalues\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"title\": \"Cache invalidation is not working\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .contains('during', '[2000-01-01 13:00, 2000-01-01 13:30)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On `jsonb` columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select('name')\n .contains('address', { postcode: 90210 })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210, \"street\": \"Melrose Place\" }'),\n (2, 'Jane', '{}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Michael\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 854, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L854" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 858, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L858" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 988, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L988" - } - ], - "signatures": [ - { - "id": 348, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 854, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L854" - } - ], - "typeParameters": [ - { - "id": 349, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 350, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 349, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 351, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 349, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 352, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 858, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L858" - } - ], - "parameters": [ - { - "id": 353, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 354, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 525, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "signatures": [ - { - "id": 526, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 696, - "name": "default.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 695, - "name": "default.csv" - } - }, - { - "id": 217, - "name": "eq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L158" - } - ], - "signatures": [ - { - "id": 218, - "name": "eq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nTo check if the value of " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL, you should use " - }, - { - "kind": "code", - "text": "`.is()`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L158" - } - ], - "typeParameters": [ - { - "id": 219, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 220, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 219, - "typeArguments": [ - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 219, - "typeArguments": [ - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 221, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "reflection", - "declaration": { - "id": 222, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 529, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "signatures": [ - { - "id": 530, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "parameters": [ - { - "id": 531, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 532, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 533, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 859, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L859" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 536, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 862, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L862" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 538, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 864, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L864" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "defaultValue": "'text'" - }, - { - "id": 535, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L861" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 534, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 860, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L860" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 537, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 863, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [533, 536, 538, 535, 534, 537] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 858, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L858" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 700, - "name": "default.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 699, - "name": "default.explain" - } - }, - { - "id": 455, - "name": "filter", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`opearator`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "operator", - "content": [ - { - "kind": "text", - "text": "The operator to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "filter() expects you to use the raw PostgREST syntax for the filter values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.filter('id', 'in', '(5,6,7)') // Use `()` for `in` filter\n.filter('arraycol', 'cs', '{\"a\",\"b\"}') // Use `cs` for `contains()`, `{}` for array values\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .filter('name', 'in', '(\"Han\",\"Yoda\")')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .filter('instruments.name', 'eq', 'flute')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2017, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2017" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2022, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2022" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2136, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2136" - } - ], - "signatures": [ - { - "id": 456, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2017, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2017" - } - ], - "typeParameters": [ - { - "id": 457, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 458, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 457, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 459, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - }, - { - "type": "literal", - "value": "not.match" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.isdistinct" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - }, - { - "type": "literal", - "value": "not.imatch" - } - ] - } - }, - { - "id": 460, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 461, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2022, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2022" - } - ], - "parameters": [ - { - "id": 462, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 463, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 464, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 527, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "signatures": [ - { - "id": 528, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 698, - "name": "default.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 697, - "name": "default.geojson" - } - }, - { - "id": 228, - "name": "gt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nWhen using [reserved words](https://www.postgresql.org/docs/current/sql-keywords-appendix.html) for column names you need\nto add double quotes e.g. " - }, - { - "kind": "code", - "text": "`.gt('\"order\"', 2)`" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .gt('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 245, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L245" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L246" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 295, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L295" - } - ], - "signatures": [ - { - "id": 229, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 245, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L245" - } - ], - "typeParameters": [ - { - "id": 230, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 231, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 230, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 232, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 230, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 233, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L246" - } - ], - "parameters": [ - { - "id": 234, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 235, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 236, - "name": "gte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than or equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .gte('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L300" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L301" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L350" - } - ], - "signatures": [ - { - "id": 237, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L300" - } - ], - "typeParameters": [ - { - "id": 238, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 239, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 238, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 240, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 238, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 241, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L301" - } - ], - "parameters": [ - { - "id": 242, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 243, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 284, - "name": "ilike", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The pattern to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .ilike('name', '%lu%')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L550" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L551" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 596, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L596" - } - ], - "signatures": [ - { - "id": 285, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L550" - } - ], - "typeParameters": [ - { - "id": 286, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 287, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 286, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 288, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 289, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L551" - } - ], - "parameters": [ - { - "id": 290, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 291, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 292, - "name": "ilikeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches all of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 601, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L601" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L605" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 615, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L615" - } - ], - "signatures": [ - { - "id": 293, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 601, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L601" - } - ], - "typeParameters": [ - { - "id": 294, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 295, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 296, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 297, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L605" - } - ], - "parameters": [ - { - "id": 298, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 299, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 300, - "name": "ilikeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches any of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 620, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L620" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 624, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L624" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 634, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L634" - } - ], - "signatures": [ - { - "id": 301, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 620, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L620" - } - ], - "typeParameters": [ - { - "id": 302, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 303, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 302, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 304, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 305, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 624, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L624" - } - ], - "parameters": [ - { - "id": 306, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 307, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 337, - "name": "in", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L801" - } - ], - "signatures": [ - { - "id": 338, - "name": "in", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .in('name', ['Leia', 'Han'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L801" - } - ], - "typeParameters": [ - { - "id": 339, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 340, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 341, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 324, - "name": "is", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL by setting " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\n\nFor boolean columns, you can also set " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " and it\nwill behave the same way as " - }, - { - "kind": "code", - "text": "`.eq()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\nUsing the " - }, - { - "kind": "code", - "text": "`eq()`" - }, - { - "kind": "text", - "text": " filter doesn't work when filtering for " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\n\nInstead, you need to use " - }, - { - "kind": "code", - "text": "`is()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Checking for nullness, true or false", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .select()\n .is('name', null)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'null'),\n (2, null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"null\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L667" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 671, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L671" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 726, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L726" - } - ], - "signatures": [ - { - "id": 325, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L667" - } - ], - "typeParameters": [ - { - "id": 326, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 327, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 326, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 328, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 326, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 329, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 671, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L671" - } - ], - "parameters": [ - { - "id": 330, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 331, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 332, - "name": "isDistinct", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 741, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L741" - } - ], - "signatures": [ - { - "id": 333, - "name": "isDistinct", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS DISTINCT FROM " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nUnlike " - }, - { - "kind": "code", - "text": "`.neq()`" - }, - { - "kind": "text", - "text": ", this treats " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " as a comparable value. Two " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " values\nare considered equal (not distinct), and comparing " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " with any non-NULL\nvalue returns true (distinct)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 741, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L741" - } - ], - "typeParameters": [ - { - "id": 334, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 335, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 336, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 260, - "name": "like", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The pattern to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .like('name', '%Lu%')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L461" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L462" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L507" - } - ], - "signatures": [ - { - "id": 261, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L461" - } - ], - "typeParameters": [ - { - "id": 262, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 263, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 262, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 264, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 265, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L462" - } - ], - "parameters": [ - { - "id": 266, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 267, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 268, - "name": "likeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches all of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L512" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L516" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 526, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L526" - } - ], - "signatures": [ - { - "id": 269, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L512" - } - ], - "typeParameters": [ - { - "id": 270, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 271, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 270, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 272, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 273, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L516" - } - ], - "parameters": [ - { - "id": 274, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 275, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 276, - "name": "likeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches any of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 531, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L531" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 535, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L535" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 545, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L545" - } - ], - "signatures": [ - { - "id": 277, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 531, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L531" - } - ], - "typeParameters": [ - { - "id": 278, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 279, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 278, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 280, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 281, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 535, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L535" - } - ], - "parameters": [ - { - "id": 282, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 283, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 501, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "signatures": [ - { - "id": 502, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "parameters": [ - { - "id": 503, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 504, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 505, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 506, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 507, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [506, 507] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 672, - "name": "default.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 671, - "name": "default.limit" - } - }, - { - "id": 244, - "name": "lt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .lt('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 355, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L355" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L356" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 401, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L401" - } - ], - "signatures": [ - { - "id": 245, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 355, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L355" - } - ], - "typeParameters": [ - { - "id": 246, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 247, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 246, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 248, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 246, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 249, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L356" - } - ], - "parameters": [ - { - "id": 250, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 251, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 252, - "name": "lte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than or equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .lte('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L406" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 407, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L407" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L456" - } - ], - "signatures": [ - { - "id": 253, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L406" - } - ], - "typeParameters": [ - { - "id": 254, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 255, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 254, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 256, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 254, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 257, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 407, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L407" - } - ], - "parameters": [ - { - "id": 258, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 259, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 427, - "name": "match", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where each column in " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": " keys is equal to its\nassociated value. Shorthand for multiple " - }, - { - "kind": "code", - "text": "`.eq()`" - }, - { - "kind": "text", - "text": "s." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "query", - "content": [ - { - "kind": "text", - "text": "The object to filter with, with column names as keys mapped\nto their filter values" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .match({ id: 2, name: 'Leia' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1708" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1709" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1754, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1754" - } - ], - "signatures": [ - { - "id": 428, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1708" - } - ], - "typeParameters": [ - { - "id": 429, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 430, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "reference", - "target": 429, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 429, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 431, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1709" - } - ], - "parameters": [ - { - "id": 432, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 544, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "signatures": [ - { - "id": 545, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "parameters": [ - { - "id": 546, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/feature-flags.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 715, - "name": "default.maxAffected" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 714, - "name": "default.maxAffected" - } - }, - { - "id": 522, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "signatures": [ - { - "id": 523, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "typeParameters": [ - { - "id": 524, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 524, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 693, - "name": "default.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 692, - "name": "default.maybeSingle" - } - }, - { - "id": 223, - "name": "neq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L227" - } - ], - "signatures": [ - { - "id": 224, - "name": "neq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is not equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nThis filter does not include rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": ". To match null\nvalues, use " - }, - { - "kind": "code", - "text": "`.is(column, null)`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .neq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L227" - } - ], - "typeParameters": [ - { - "id": 225, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 226, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 225, - "typeArguments": [ - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 225, - "typeArguments": [ - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 227, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 433, - "name": "not", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`opearator`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "operator", - "content": [ - { - "kind": "text", - "text": "The operator to be negated to filter with, following\nPostgREST syntax" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "not() expects you to use the raw PostgREST syntax for the filter values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.not('id', 'in', '(5,6,7)') // Use `()` for `in` filter\n.not('arraycol', 'cs', '{\"a\",\"b\"}') // Use `cs` for `contains()`, `{}` for array values\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .select()\n .not('name', 'is', null)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'null'),\n (2, null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"null\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1765, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1765" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1779, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1779" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1784, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1784" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1844, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1844" - } - ], - "signatures": [ - { - "id": 434, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1765, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1765" - } - ], - "typeParameters": [ - { - "id": 435, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 436, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 437, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "is" - } - }, - { - "id": 438, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": null - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "NonNullableColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullableColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "NarrowResultColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NarrowResultColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - }, - { - "id": 439, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1779, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1779" - } - ], - "typeParameters": [ - { - "id": 440, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 441, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 440, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 442, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 443, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 440, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 444, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1784, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1784" - } - ], - "parameters": [ - { - "id": 445, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 446, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 447, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 342, - "name": "notIn", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 832, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L832" - } - ], - "signatures": [ - { - "id": 343, - "name": "notIn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NOT included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 832, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L832" - } - ], - "typeParameters": [ - { - "id": 344, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 345, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 346, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 448, - "name": "or", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2005, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2005" - } - ], - "signatures": [ - { - "id": 449, - "name": "or", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`filters`" - }, - { - "kind": "text", - "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " - }, - { - "kind": "code", - "text": "`.or()`" - }, - { - "kind": "text", - "text": " filter across multiple tables." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.or('id.in.(5,6,7), arraycol.cs.{\"a\",\"b\"}') // Use `()` for `in` filter, `{}` for array values and `cs` for `contains()`.\n.or('id.in.(5,6,7), arraycol.cd.{\"a\",\"b\"}') // Use `cd` for `containedBy()`\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.eq.2,name.eq.Han')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n },\n {\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` with `and`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` on referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2005, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2005" - } - ], - "parameters": [ - { - "id": 450, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filters to use, following PostgREST syntax" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " instead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 454, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to filter on referenced tables\ninstead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [453, 454] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 470, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order the query result by " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": ".\n\nYou 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 " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " in the query." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to order by" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.ascending", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the result will be in ascending order" - } - ] - }, - { - "tag": "@param", - "name": "options.nullsFirst", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear first. If " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear last." - } - ] - }, - { - "tag": "@param", - "name": "options.referencedTable", - "content": [ - { - "kind": "text", - "text": "Set this to order a referenced table by\nits columns" - } - ] - }, - { - "tag": "@param", - "name": "options.foreignTable", - "content": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('id, name')\n .order('id', { ascending: false })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " doesn't affect the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .order('name', { referencedTable: 'instruments', ascending: false })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n },\n {\n \"name\": \"harp\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": []\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referenced_table(col)`" - }, - { - "kind": "text", - "text": " affects the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "Order parent table by a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('instruments')\n .select(`\n name,\n section:orchestral_sections (\n name\n )\n `)\n .order('section(name)', { ascending: true })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"violin\",\n \"orchestral_sections\": {\"name\": \"strings\"}\n },\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L322" - } - ], - "signatures": [ - { - "id": 471, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - } - ], - "typeParameters": [ - { - "id": 472, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 473, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 472, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 474, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 475, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 476, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 477, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 478, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [476, 477, 478] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 641, - "name": "default.order" - } - }, - { - "id": 479, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - } - ], - "parameters": [ - { - "id": 480, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 481, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 482, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 483, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 484, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 485, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [483, 484, 485] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 649, - "name": "default.order" - } - }, - { - "id": 486, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - } - ], - "typeParameters": [ - { - "id": 487, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 488, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 487, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 489, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 490, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 491, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 493, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 492, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [491, 493, 492] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 656, - "name": "default.order" - } - }, - { - "id": 494, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - } - ], - "parameters": [ - { - "id": 495, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 496, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 497, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 498, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 500, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 499, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [498, 500, 499] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 664, - "name": "default.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 640, - "name": "default.order" - } - }, - { - "id": 403, - "name": "overlaps", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for array and range columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " have an element in common." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The array or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The array or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('issues')\n .select('title')\n .overlaps('tags', ['is:closed', 'severity:high'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n issues (\n id int8 primary key,\n title text,\n tags text[]\n );\n\ninsert into\n issues (id, title, tags)\nvalues\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"title\": \"Cache invalidation is not working\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .overlaps('during', '[2000-01-01 12:45, 2000-01-01 13:15)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1468" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1472" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1565" - } - ], - "signatures": [ - { - "id": 404, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1468" - } - ], - "typeParameters": [ - { - "id": 405, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 406, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 405, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 407, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 405, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 408, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1472" - } - ], - "parameters": [ - { - "id": 409, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 410, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 589, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 590, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 591, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 592, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 593, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 594, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [594] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 595, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 596, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [596] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 760, - "name": "default.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 759, - "name": "default.overrideTypes" - } - }, - { - "id": 508, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "signatures": [ - { - "id": 509, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "parameters": [ - { - "id": 510, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 511, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 512, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 513, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 514, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 515, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [514, 515] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 679, - "name": "default.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 678, - "name": "default.range" - } - }, - { - "id": 395, - "name": "rangeAdjacent", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is\nmutually exclusive to " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " and there can be no element between the two\nranges." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeAdjacent('during', '[2000-01-01 12:00, 2000-01-01 13:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1405, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1405" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1406" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1463" - } - ], - "signatures": [ - { - "id": 396, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1405, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1405" - } - ], - "typeParameters": [ - { - "id": 397, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 398, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 397, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 399, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 400, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1406" - } - ], - "parameters": [ - { - "id": 401, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 402, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 363, - "name": "rangeGt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than any element in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeGt('during', '[2000-01-02 08:00, 2000-01-02 09:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 2,\n \"room_name\": \"Topaz\",\n \"during\": \"[\\\"2000-01-02 09:00:00\\\",\\\"2000-01-02 10:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1152" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1153" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1210" - } - ], - "signatures": [ - { - "id": 364, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1152" - } - ], - "typeParameters": [ - { - "id": 365, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 366, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 365, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 367, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 368, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1153" - } - ], - "parameters": [ - { - "id": 369, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 370, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 371, - "name": "rangeGte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is either contained in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " or greater than any element in\n" - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeGte('during', '[2000-01-02 08:30, 2000-01-02 09:30)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 2,\n \"room_name\": \"Topaz\",\n \"during\": \"[\\\"2000-01-02 09:00:00\\\",\\\"2000-01-02 10:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1215, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1215" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1216" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1274, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1274" - } - ], - "signatures": [ - { - "id": 372, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1215, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1215" - } - ], - "typeParameters": [ - { - "id": 373, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 374, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 373, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 375, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 376, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1216" - } - ], - "parameters": [ - { - "id": 377, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 378, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 379, - "name": "rangeLt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than any element in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeLt('during', '[2000-01-01 15:00, 2000-01-01 16:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1279, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1279" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1280" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1336, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1336" - } - ], - "signatures": [ - { - "id": 380, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1279, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1279" - } - ], - "typeParameters": [ - { - "id": 381, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 382, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 381, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 383, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 384, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1280" - } - ], - "parameters": [ - { - "id": 385, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 386, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 387, - "name": "rangeLte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is either contained in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " or less than any element in\n" - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeLte('during', '[2000-01-01 14:00, 2000-01-01 16:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1341, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1341" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1342" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1400, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1400" - } - ], - "signatures": [ - { - "id": 388, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1341, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1341" - } - ], - "typeParameters": [ - { - "id": 389, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 390, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 389, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 391, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 392, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1342" - } - ], - "parameters": [ - { - "id": 393, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 394, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 316, - "name": "regexIMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the PostgreSQL regex " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": "\ncase-insensitively (using the " - }, - { - "kind": "code", - "text": "`~*`" - }, - { - "kind": "text", - "text": " operator)." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The PostgreSQL regular expression pattern to match with" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L653" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 654, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L654" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 662, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L662" - } - ], - "signatures": [ - { - "id": 317, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L653" - } - ], - "typeParameters": [ - { - "id": 318, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 319, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 318, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 320, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 321, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 654, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L654" - } - ], - "parameters": [ - { - "id": 322, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 323, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 308, - "name": "regexMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the PostgreSQL regex " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": "\ncase-sensitively (using the " - }, - { - "kind": "code", - "text": "`~`" - }, - { - "kind": "text", - "text": " operator)." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The PostgreSQL regular expression pattern to match with" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 639, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L639" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 640, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 648, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L648" - } - ], - "signatures": [ - { - "id": 309, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 639, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L639" - } - ], - "typeParameters": [ - { - "id": 310, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 311, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 310, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 312, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 313, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 640, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640" - } - ], - "parameters": [ - { - "id": 314, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 315, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 574, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 575, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 576, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 745, - "name": "default.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 744, - "name": "default.retry" - } - }, - { - "id": 541, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "signatures": [ - { - "id": 542, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "typeParameters": [ - { - "id": 543, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 543, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 712, - "name": "default.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 711, - "name": "default.returns" - } - }, - { - "id": 539, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "signatures": [ - { - "id": 540, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 710, - "name": "default.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 709, - "name": "default.rollback" - } - }, - { - "id": 465, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "signatures": [ - { - "id": 466, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "typeParameters": [ - { - "id": 467, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 468, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 469, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 636, - "name": "default.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 635, - "name": "default.select" - } - }, - { - "id": 570, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 571, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 572, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 573, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 741, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 740, - "name": "default.setHeader" - } - }, - { - "id": 519, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "signatures": [ - { - "id": 520, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "typeParameters": [ - { - "id": 521, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 521, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 690, - "name": "default.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 689, - "name": "default.single" - } - }, - { - "id": 568, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 569, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 739, - "name": "default.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 738, - "name": "default.stripNulls" - } - }, - { - "id": 411, - "name": "textSearch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for text and tsvector columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the query string in " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The text or tsvector column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "query", - "content": [ - { - "kind": "text", - "text": "The query text to match with" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.config", - "content": [ - { - "kind": "text", - "text": "The text search configuration to use" - } - ] - }, - { - "tag": "@param", - "name": "options.type", - "content": [ - { - "kind": "text", - "text": "Change how the " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": " text is interpreted" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- For more information, see [Postgres full text search](/docs/guides/database/full-text-search)." - } - ] - }, - { - "tag": "@example", - "name": "Text search", - "content": [ - { - "kind": "code", - "text": "```ts\nconst result = await supabase\n .from(\"texts\")\n .select(\"content\")\n .textSearch(\"content\", `'eggs' & 'ham'`, {\n config: \"english\",\n });\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Text search\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table texts (\n id bigint\n primary key\n generated always as identity,\n content text\n);\n\ninsert into texts (content) values\n ('Four score and seven years ago'),\n ('The road goes ever on and on'),\n ('Green eggs and ham')\n;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Text search\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"content\": \"Green eggs and ham\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Basic normalization\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`plainto_tsquery`" - }, - { - "kind": "text", - "text": " function." - } - ] - }, - { - "tag": "@example", - "name": "Basic normalization", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat' & 'cat'`, {\n type: 'plain',\n config: 'english'\n })\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Full normalization\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`phraseto_tsquery`" - }, - { - "kind": "text", - "text": " function." - } - ] - }, - { - "tag": "@example", - "name": "Full normalization", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat' & 'cat'`, {\n type: 'phrase',\n config: 'english'\n })\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Websearch\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`websearch_to_tsquery`" - }, - { - "kind": "text", - "text": " function.\nThis function will never raise syntax errors, which makes it possible to use raw user-supplied input for search, and can be used\nwith advanced operators.\n\n- " - }, - { - "kind": "code", - "text": "`unquoted text`" - }, - { - "kind": "text", - "text": ": text not inside quote marks will be converted to terms separated by & operators, as if processed by plainto_tsquery.\n- " - }, - { - "kind": "code", - "text": "`\"quoted text\"`" - }, - { - "kind": "text", - "text": ": text inside quote marks will be converted to terms separated by " - }, - { - "kind": "code", - "text": "`<->`" - }, - { - "kind": "text", - "text": " operators, as if processed by phraseto_tsquery.\n- " - }, - { - "kind": "code", - "text": "`OR`" - }, - { - "kind": "text", - "text": ": the word “or” will be converted to the | operator.\n- " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": ": a dash will be converted to the ! operator." - } - ] - }, - { - "tag": "@example", - "name": "Websearch", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat or cat'`, {\n type: 'websearch',\n config: 'english'\n })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1576, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1576" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1581, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1581" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1690" - } - ], - "signatures": [ - { - "id": 412, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1576, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1576" - } - ], - "typeParameters": [ - { - "id": 413, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 414, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 413, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 415, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 416, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 417, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 418, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 419, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [418, 419] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 420, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1581, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1581" - } - ], - "parameters": [ - { - "id": 421, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 423, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 424, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 425, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 426, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [425, 426] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 577, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 578, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 579, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 580, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 581, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 582, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 583, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 584, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 585, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 586, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 587, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 588, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 748, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 747, - "name": "default.then" - } - }, - { - "id": 566, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 567, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 737, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 736, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [187] - }, - { - "title": "Properties", - "children": [551, 554, 549, 562, 547, 565, 550, 563, 552, 553, 548, 564] - }, - { - "title": "Methods", - "children": [ - 516, 355, 347, 525, 217, 529, 455, 527, 228, 236, 284, 292, 300, 337, 324, 332, 260, - 268, 276, 501, 244, 252, 427, 544, 522, 223, 433, 342, 448, 470, 403, 589, 508, 395, - 363, 371, 379, 387, 316, 308, 574, 541, 539, 465, 570, 519, 568, 411, 577, 566 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 187, 516, 355, 347, 525, 217, 529, 455, 527, 228, 236, 284, 292, 300, 337, 324, 260, - 268, 276, 501, 244, 252, 427, 544, 522, 223, 433, 448, 470, 403, 589, 508, 395, 363, - 371, 379, 387, 541, 539, 465, 570, 519, 568, 411, 566 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [574] - }, - { - "title": "Other", - "children": [ - 551, 554, 549, 562, 547, 565, 550, 563, 552, 553, 548, 564, 332, 342, 316, 308, 577 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 95, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L95" - } - ], - "typeParameters": [ - { - "id": 597, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 598, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 599, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 600, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 601, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 602, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 603, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "default", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 81, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 82, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L65" - } - ], - "signatures": [ - { - "id": 83, - "name": "PostgrestQueryBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a query builder scoped to a Postgres table or view." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst query = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: { apikey: 'your-publishable-key' }, retry: true }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L65" - } - ], - "typeParameters": [ - { - "id": 84, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 85, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 86, - "name": "Relation", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 87, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 88, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 89, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 90, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [90] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "parameters": [ - { - "id": 91, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL for the query" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 92, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 96, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L76" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 97, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 98, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 99, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 100, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 101, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 102, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 103, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 94, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 74, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L74" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 105, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable automatic retries for transient errors (default: true)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 78, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 95, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to use" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 104, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length before warning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 77, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L77" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "8000" - } - ], - "groups": [ - { - "title": "Properties", - "children": [96, 94, 105, 95, 104] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 73, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L73" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 110, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L23" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 112, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 113, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 114, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 115, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 116, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 117, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 107, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L20" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 119, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\nWhen enabled, idempotent requests (GET/HEAD/OPTIONS) that fail with network\nerrors or HTTP 503/520 responses are automatically retried with exponential\nbackoff (1s, 2s, 4s, up to 3 attempts). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " when not specified." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 108, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 109, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L22" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 106, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L19" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 118, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 173, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1736, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1736" - } - ], - "signatures": [ - { - "id": 174, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\n- If you use " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " with filters and you have\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\n rows visible through " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": " policies are deleted. Note that by default\n no rows are visible, so you need at least one " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": "/" - }, - { - "kind": "code", - "text": "`ALL`" - }, - { - "kind": "text", - "text": " policy that\n makes the rows visible.\n- When using " - }, - { - "kind": "code", - "text": "`delete().in()`" - }, - { - "kind": "text", - "text": ", specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal." - } - ] - }, - { - "tag": "@example", - "name": "Delete a single record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete multiple records", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .in('id', [1, 2, 3])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1736, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1736" - } - ], - "parameters": [ - { - "id": 175, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 176, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 177, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count deleted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1739, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1739" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 178, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [177] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1738, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1738" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 135, - "name": "insert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1086, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1086" - } - ], - "signatures": [ - { - "id": 136, - "name": "insert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Create a record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk create\nA bulk create operation is handled in a single transaction.\nIf any of the inserts fail, none of the rows are inserted." - } - ] - }, - { - "tag": "@example", - "name": "Bulk create", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert([\n { id: 1, name: 'Mordor' },\n { id: 1, name: 'The Shire' },\n ])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (id)=(1) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"countries_pkey\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1086, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1086" - } - ], - "typeParameters": [ - { - "id": 137, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 138, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 140, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1089, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1089" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [140] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1089, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1089" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 137, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 142, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1093, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1093" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [142] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1093, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1093" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 137, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 143, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 144, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 145, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count inserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1100" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 147, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1101, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1101" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - } - ], - "groups": [ - { - "title": "Properties", - "children": [145, 147] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1099, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1099" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 125, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L905" - } - ], - "signatures": [ - { - "id": 126, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT query on the table or view." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "When using " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`.range()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`.limit()`" - }, - { - "kind": "text", - "text": ", the returned " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " is the total number of rows\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\n\n- By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use " - }, - { - "kind": "code", - "text": "`range()`" - }, - { - "kind": "text", - "text": " queries to paginate through your data.\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Filters](/docs/reference/javascript/using-filters)\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\n- " - }, - { - "kind": "code", - "text": "`apikey`" - }, - { - "kind": "text", - "text": " is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Getting your data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Harry'),\n (2, 'Frodo'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Harry\"\n },\n {\n \"id\": 2,\n \"name\": \"Frodo\"\n },\n {\n \"id\": 3,\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nThe most useful field on a Postgres error is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (" - }, - { - "kind": "code", - "text": "`code: '42501'`" - }, - { - "kind": "text", - "text": ") arrives with a " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " like " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\"`" - }, - { - "kind": "text", - "text": ". Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so the hint isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('characters').select()\nif (error) {\n // Logs the full error: message, code, details, and hint.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"42501\",\n \"details\": null,\n \"hint\": \"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\",\n \"message\": \"permission denied for table characters\"\n },\n \"status\": 401,\n \"statusText\": \"Unauthorized\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Selecting specific columns", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Frodo'),\n (2, 'Harry'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Frodo\"\n },\n {\n \"name\": \"Harry\"\n },\n {\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\nIf your database has foreign key relationships, you can query related tables too." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\nIf your table name contains spaces, you must use double quotes in the " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " statement to reference the table." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables with spaces in their names", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral sections')\n .select(`\n name,\n \"musical instruments\" (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n \"orchestral sections\" (id int8 primary key, name text);\ncreate table\n \"musical instruments\" (\n id int8 primary key,\n section_id int8 not null references \"orchestral sections\",\n name text\n );\n\ninsert into\n \"orchestral sections\" (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n \"musical instruments\" (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"musical instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"musical instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\nIf you're in a situation where your tables are **NOT** directly\nrelated, but instead are joined by a _join table_, you can still use\nthe " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " method to query the related data. The join table needs\nto have the foreign keys as part of its composite primary key." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables through a join table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n name,\n teams (\n name\n )\n `)\n \n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n -- both foreign keys must be part of a composite primary key\n primary key (user_id, team_id)\n );\n\ninsert into\n users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Kiran\",\n \"teams\": [\n {\n \"name\": \"Green\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Evan\",\n \"teams\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n \n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\nIf you need to query the same referenced table twice, use the name of the\njoined column to identify which join to use. You can also give each\ncolumn an alias." - } - ] - }, - { - "tag": "@example", - "name": "Query the same referenced table multiple times", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:sender_id(name),\n to:receiver_id(name)\n `)\n\n// To infer types, use the name of the table (in this case `users`) and\n// the name of the foreign key constraint.\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:users!messages_sender_id_fkey(name),\n to:users!messages_receiver_id_fkey(name)\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\n" - }, - { - "kind": "code", - "text": "```sql\n create table\n users (id int8 primary key, name text);\n\n create table\n messages (\n sender_id int8 not null references users,\n receiver_id int8 not null references users,\n content text\n );\n\n insert into\n users (id, name)\n values\n (1, 'Kiran'),\n (2, 'Evan');\n\n insert into\n messages (sender_id, receiver_id, content)\n values\n (1, 2, '👋');\n ```" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleResponse Query the same referenced table multiple times\n```" - }, - { - "kind": "text", - "text": "json\n{\n \"data\": [\n {\n \"content\": \"👋\",\n \"from\": {\n \"name\": \"Kiran\"\n },\n \"to\": {\n \"name\": \"Evan\"\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleDescription Query nested foreign tables through a join table\nYou can use the result of a joined table to gather data in\nanother foreign table. With multiple references to the same foreign\ntable you must specify the column on which to conduct the join.\n\n@example Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "ts\n const { data, error } = await supabase\n .from('games')\n .select(" - }, - { - "kind": "code", - "text": "`\n game_id:id,\n away_team:teams!games_away_team_fkey (\n users (\n id,\n name\n )\n )\n `" - }, - { - "kind": "text", - "text": ")\n \n" - }, - { - "kind": "code", - "text": "```\n\n@exampleSql Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "sql\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n\n primary key (user_id, team_id)\n );\ncreate table\n games (\n id int8 primary key,\n home_team int8 not null references teams,\n away_team int8 not null references teams,\n name text\n );\n\ninsert into users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\ninsert into\n games (id, home_team, away_team, name)\nvalues\n (1, 1, 2, 'Green vs Blue'),\n (2, 2, 1, 'Blue vs Green');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query nested foreign tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"game_id\": 1,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n },\n {\n \"id\": 2,\n \"name\": \"Evan\"\n }\n ]\n }\n },\n {\n \"game_id\": 2,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n }\n ]\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n \n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\nIf the filter on a referenced table's column is not satisfied, the referenced\ntable returns " - }, - { - "kind": "code", - "text": "`[]`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " but the parent table is not filtered out.\nIf you want to filter out the parent table rows, use the " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " hint" - } - ] - }, - { - "tag": "@example", - "name": "Filtering through referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections(*)')\n .eq('orchestral_sections.name', 'percussion')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": null\n },\n {\n \"name\": \"violin\",\n \"orchestral_sections\": null\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\nYou can get the number of rows in a related table by using the\n**count** property." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with count", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`*, instruments(count)`)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table characters (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('strings') returning id\n)\ninsert into instruments (name, section_id) values\n('violin', (select id from section)),\n('viola', (select id from section)),\n('cello', (select id from section)),\n('double bass', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```json\n[\n {\n \"id\": \"693694e7-d993-4360-a6d7-6294e325d9b6\",\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"count\": 4\n }\n ]\n }\n]\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying with count option\nYou can get the number of rows by using the\n[count](/docs/reference/javascript/select#parameters) option." - } - ] - }, - { - "tag": "@example", - "name": "Querying with count option", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { count, error } = await supabase\n .from('characters')\n .select('*', { count: 'exact', head: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"count\": 3,\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\nYou can select and filter data inside of\n[JSON](/docs/guides/database/json) columns. Postgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nquerying JSON data." - } - ] - }, - { - "tag": "@example", - "name": "Querying JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n id, name,\n address->city\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Frodo', '{\"city\":\"Hobbiton\"}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Frodo\",\n \"city\": \"Hobbiton\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\nIf you don't want to return the referenced table contents, you can leave the parenthesis empty.\nLike " - }, - { - "kind": "code", - "text": "`.select('name, orchestral_sections!inner()')`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with inner join", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections!inner(name)')\n .eq('orchestral_sections.name', 'woodwinds')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table instruments (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('woodwinds') returning id\n)\ninsert into instruments (name, section_id) values\n('flute', (select id from section)),\n('clarinet', (select id from section)),\n('bassoon', (select id from section)),\n('piccolo', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\nIn addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas)." - } - ] - }, - { - "tag": "@example", - "name": "Switching schemas per query", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .schema('myschema')\n .from('mytable')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```sql\ncreate schema myschema;\n\ncreate table myschema.mytable (\n id uuid primary key default gen_random_uuid(),\n data text\n);\n\ninsert into myschema.mytable (data) values ('mydata');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": \"4162e008-27b0-4c0f-82dc-ccaeee9a624d\",\n \"data\": \"mydata\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L905" - } - ], - "typeParameters": [ - { - "id": 127, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 128, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 127, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 129, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " - }, - { - "kind": "code", - "text": "`customName:columnName`" - } - ] - }, - "type": { - "type": "reference", - "target": 127, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 130, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 133, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows in the table or view.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 919, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L919" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 132, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 918, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L918" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [133, 132] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 917, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L917" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 128, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "GET" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 163, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1571" - } - ], - "signatures": [ - { - "id": 164, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update." - } - ] - }, - { - "tag": "@example", - "name": "Updating your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\nPostgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nworking with JSON data. Currently, it is only possible to update the entire JSON document." - } - ] - }, - { - "tag": "@example", - "name": "Updating JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .update({\n address: {\n street: 'Melrose Place',\n postcode: 90210\n }\n })\n .eq('address->postcode', 90210)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210 }');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Michael\",\n \"address\": {\n \"street\": \"Melrose Place\",\n \"postcode\": 90210\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1571" - } - ], - "typeParameters": [ - { - "id": 165, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 166, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to update with" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 167, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 168, - "name": "Update", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1573, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1573" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [168] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1573, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1573" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Update" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 165, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 169, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 170, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 171, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count updated rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1579, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1579" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [171] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1578, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1578" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "PATCH" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 148, - "name": "upsert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1360" - } - ], - "signatures": [ - { - "id": 149, - "name": "upsert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": " allows you to perform the equivalent of\n" - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": " if a row with the corresponding " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates`" - }, - { - "kind": "text", - "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Upsert a single row using a unique key", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting a single row, overwriting based on the 'username' unique column\nconst { data, error } = await supabase\n .from('users')\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\n\n// Example response:\n// {\n// data: [\n// { id: 4, message: 'bar', username: 'supabot' }\n// ],\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upsert with conflict resolution and exact row counting", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting and returning exact count\nconst { data, error, count } = await supabase\n .from('users')\n .upsert(\n {\n id: 3,\n message: 'foo',\n username: 'supabot'\n },\n {\n onConflict: 'username',\n count: 'exact'\n }\n )\n\n// Example response:\n// {\n// data: [\n// {\n// id: 42,\n// handle: \"saoirse\",\n// display_name: \"Saoirse\"\n// }\n// ],\n// count: 1,\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Primary keys must be included in " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " to use upsert." - } - ] - }, - { - "tag": "@example", - "name": "Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert({ id: 1, name: 'piano' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Bulk Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert([\n { id: 1, name: 'piano' },\n { id: 2, name: 'harp' },\n ])\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n },\n {\n \"id\": 2,\n \"name\": \"harp\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\nIn the following query, " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " implicitly uses the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": "\n(primary key) column to determine conflicts. If there is no existing\nrow with the same " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " inserts a new row, which\nwill fail in this case as there is already a row with " - }, - { - "kind": "code", - "text": "`handle`" - }, - { - "kind": "text", - "text": " " - }, - { - "kind": "code", - "text": "`\"saoirse\"`" - }, - { - "kind": "text", - "text": ".\nUsing the " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " option, you can instruct " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " to use\nanother column with a unique constraint to determine conflicts." - } - ] - }, - { - "tag": "@example", - "name": "Upserting into tables with constraints", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 generated by default as identity primary key,\n handle text not null unique,\n display_name text\n );\n\ninsert into\n users (id, handle, display_name)\nvalues\n (1, 'saoirse', null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (handle)=(saoirse) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"users_handle_key\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1360" - } - ], - "typeParameters": [ - { - "id": 150, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 151, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 153, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1363, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1363" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [153] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1363, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1363" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 150, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 154, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 155, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1367, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1367" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [155] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1367, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1367" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 150, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 156, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 157, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 160, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count upserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1378, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1378" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 162, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates: false`" - }, - { - "kind": "text", - "text": ". This also only applies when doing bulk upserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1379" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 159, - "name": "ignoreDuplicates", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", duplicate rows are ignored. If\n" - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", duplicate rows are merged with existing rows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1377, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1377" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 158, - "name": "onConflict", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns are equal." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1376, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1376" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [160, 162, 159, 158] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1375, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1375" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [82] - }, - { - "title": "Properties", - "children": [110, 107, 119, 108, 109, 106, 118] - }, - { - "title": "Methods", - "children": [173, 135, 125, 163, 148] - } - ], - "categories": [ - { - "title": "Database", - "children": [82, 173, 135, 125, 163, 148] - }, - { - "title": "Other", - "children": [110, 107, 119, 108, 109, 106, 118] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 12, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L12" - } - ], - "typeParameters": [ - { - "id": 179, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 180, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 181, - "name": "Relation", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 182, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 183, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 184, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 185, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ], - "type": { - "type": "inferred", - "name": "R" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [185] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - }, - { - "id": 604, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 605, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 606, - "name": "PostgrestTransformBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 607, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 608, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 609, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 610, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 611, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 612, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 613, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 614, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 620, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 623, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 624, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 625, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 626, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 627, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 628, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 629, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 630, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 618, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 631, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 616, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 634, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 619, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 632, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 621, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 622, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 617, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 633, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 620, 623, 618, 631, 616, 634, 619, 632, 621, 622, 617, 633 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 776, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 775, - "name": "default.constructor" - } - }, - { - "id": 721, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 805, - "name": "default.body" - } - }, - { - "id": 724, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 725, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 726, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 727, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 728, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 729, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 730, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 731, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 808, - "name": "default.fetch" - } - }, - { - "id": 719, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 803, - "name": "default.headers" - } - }, - { - "id": 732, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 816, - "name": "default.isMaybeSingle" - } - }, - { - "id": 717, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 801, - "name": "default.method" - } - }, - { - "id": 735, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": 819, - "name": "default.retryEnabled" - } - }, - { - "id": 720, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 804, - "name": "default.schema" - } - }, - { - "id": 733, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 817, - "name": "default.shouldStripNulls" - } - }, - { - "id": 722, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "target": 806, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 723, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 807, - "name": "default.signal" - } - }, - { - "id": 718, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 802, - "name": "default.url" - } - }, - { - "id": 734, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 818, - "name": "default.urlLengthLimit" - } - }, - { - "id": 686, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "signatures": [ - { - "id": 687, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "parameters": [ - { - "id": 688, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 695, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "signatures": [ - { - "id": 696, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 699, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "signatures": [ - { - "id": 700, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "parameters": [ - { - "id": 701, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 702, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 703, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 859, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L859" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 706, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 862, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L862" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 708, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 864, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L864" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "defaultValue": "'text'" - }, - { - "id": 705, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L861" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 704, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 860, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L860" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 707, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 863, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [703, 706, 708, 705, 704, 707] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 858, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L858" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - } - ] - }, - { - "id": 697, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "signatures": [ - { - "id": 698, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 671, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "signatures": [ - { - "id": 672, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "parameters": [ - { - "id": 673, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 674, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 675, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 676, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 677, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [676, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 714, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "signatures": [ - { - "id": 715, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "parameters": [ - { - "id": 716, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/feature-flags.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - } - } - ] - }, - { - "id": 692, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "signatures": [ - { - "id": 693, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "typeParameters": [ - { - "id": 694, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 524, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 640, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order the query result by " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": ".\n\nYou 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 " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " in the query." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to order by" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.ascending", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the result will be in ascending order" - } - ] - }, - { - "tag": "@param", - "name": "options.nullsFirst", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear first. If " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear last." - } - ] - }, - { - "tag": "@param", - "name": "options.referencedTable", - "content": [ - { - "kind": "text", - "text": "Set this to order a referenced table by\nits columns" - } - ] - }, - { - "tag": "@param", - "name": "options.foreignTable", - "content": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('id, name')\n .order('id', { ascending: false })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " doesn't affect the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .order('name', { referencedTable: 'instruments', ascending: false })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n },\n {\n \"name\": \"harp\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": []\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referenced_table(col)`" - }, - { - "kind": "text", - "text": " affects the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "Order parent table by a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('instruments')\n .select(`\n name,\n section:orchestral_sections (\n name\n )\n `)\n .order('section(name)', { ascending: true })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"violin\",\n \"orchestral_sections\": {\"name\": \"strings\"}\n },\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L322" - } - ], - "signatures": [ - { - "id": 641, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - } - ], - "typeParameters": [ - { - "id": 642, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 643, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 472, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 644, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 645, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 646, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 647, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 648, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [646, 647, 648] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 649, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - } - ], - "parameters": [ - { - "id": 650, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 651, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 652, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 653, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 654, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 655, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [653, 654, 655] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 656, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - } - ], - "typeParameters": [ - { - "id": 657, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 658, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 487, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 659, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 660, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 661, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 663, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 662, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [661, 663, 662] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 664, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - } - ], - "parameters": [ - { - "id": 665, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 666, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 667, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 668, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 670, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [668, 670, 669] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 759, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 760, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 761, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 762, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 763, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 764, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [764] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 765, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 766, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [766] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 857, - "name": "default.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 856, - "name": "default.overrideTypes" - } - }, - { - "id": 678, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "signatures": [ - { - "id": 679, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "parameters": [ - { - "id": 680, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 681, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 682, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 684, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 685, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [684, 685] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 744, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 745, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 746, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 829, - "name": "default.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 828, - "name": "default.retry" - } - }, - { - "id": 711, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "signatures": [ - { - "id": 712, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "typeParameters": [ - { - "id": 713, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 543, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": 854, - "name": "default.returns" - } - } - ], - "overwrites": { - "type": "reference", - "target": 853, - "name": "default.returns" - } - }, - { - "id": 709, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "signatures": [ - { - "id": 710, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 635, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "signatures": [ - { - "id": 636, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "typeParameters": [ - { - "id": 637, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 638, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 639, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 740, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 741, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 742, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 743, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 825, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 824, - "name": "default.setHeader" - } - }, - { - "id": 689, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "signatures": [ - { - "id": 690, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "typeParameters": [ - { - "id": 691, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 521, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 738, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 739, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 823, - "name": "default.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 822, - "name": "default.stripNulls" - } - }, - { - "id": 747, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 748, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 749, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 750, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 751, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 753, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 754, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 755, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 756, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 757, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 758, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 832, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 831, - "name": "default.then" - } - }, - { - "id": 736, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 737, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 821, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 820, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [605] - }, - { - "title": "Properties", - "children": [721, 724, 719, 732, 717, 735, 720, 733, 722, 723, 718, 734] - }, - { - "title": "Methods", - "children": [ - 686, 695, 699, 697, 671, 714, 692, 640, 759, 678, 744, 711, 709, 635, 740, 689, 738, - 747, 736 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 605, 686, 695, 699, 697, 671, 714, 692, 640, 759, 678, 711, 709, 635, 740, 689, 738, - 736 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [744] - }, - { - "title": "Other", - "children": [721, 724, 719, 732, 717, 735, 720, 733, 722, 723, 718, 734, 747] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 8, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L8" - } - ], - "typeParameters": [ - { - "id": 767, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 768, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 769, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 770, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 771, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 772, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 773, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "default", - "package": "@supabase/postgrest-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 186, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 889, - "name": "PostgrestResponseFailure", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 893, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L25" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 892, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L24" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 891, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L23" - } - ], - "type": { - "type": "reference", - "target": 867, - "name": "PostgrestError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - }, - { - "id": 894, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 895, - "name": "statusText", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.statusText" - } - }, - { - "id": 890, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L22" - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [893, 892, 891, 894, 895, 890] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 21, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L21" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase" - }, - "name": "PostgrestResponseBase", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 896, - "name": "PostgrestResponseSuccess", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 900, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L19" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 899, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L18" - } - ], - "type": { - "type": "reference", - "target": 903, - "name": "T", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestResponseSuccess.T", - "refersToTypeParameter": true - } - }, - { - "id": 898, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L17" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 901, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 902, - "name": "statusText", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.statusText" - } - }, - { - "id": 897, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 16, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L16" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [900, 899, 898, 901, 902, 897] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 15, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L15" - } - ], - "typeParameters": [ - { - "id": 903, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase" - }, - "name": "PostgrestResponseBase", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 908, - "name": "PostgrestClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L81" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 910, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L82" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [910] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 81, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L81" - } - ] - } - } - }, - { - "id": 906, - "name": "PostgrestMaybeSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 32, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L32" - } - ], - "typeParameters": [ - { - "id": 907, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 907, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 887, - "name": "PostgrestResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 33, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L33" - } - ], - "typeParameters": [ - { - "id": 888, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 888, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 904, - "name": "PostgrestSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 31, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L31" - } - ], - "typeParameters": [ - { - "id": 905, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 905, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 889, - "name": "PostgrestResponseFailure", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 911, - "name": "UnstableGetResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Main entry point for constructing the result type of a PostgREST query." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/select-query-parser/result.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/select-query-parser/result.ts#L38" - } - ], - "typeParameters": [ - { - "id": 912, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Database schema." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 913, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of a row in the current table." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 914, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the current table or view." - } - ] - } - }, - { - "id": 915, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Relationships of the current table." - } - ] - } - }, - { - "id": 916, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The select query string literal to parse." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 917, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "IsAny" - }, - "typeArguments": [ - { - "type": "reference", - "target": 912, - "name": "Schema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "IsAny", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ProcessNodesWithoutSchema" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ProcessNodesWithoutSchema", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": null - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "RPCCallNodes" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "literal", - "value": "rpc_call" - } - }, - { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RPCCallNodes", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericRelationship" - }, - "name": "GenericRelationship", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ProcessNodes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 917, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 912, - "name": "Schema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ProcessNodes", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "SelectQueryError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "Invalid Relationships cannot infer result type" - } - ], - "name": "SelectQueryError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "SelectQueryError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "Invalid RelationName cannot infer result type" - } - ], - "name": "SelectQueryError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - }, - { - "id": 1, - "name": "default", - "variant": "declaration", - "kind": 32, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 16, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L16" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 7, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L21" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 774, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 3, - "name": "PostgrestClient", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L17" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 9, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 8, - "name": "PostgrestError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L22" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 867, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 5, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L19" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 186, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 4, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L18" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 81, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 6, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L20" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 604, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [7, 3, 8, 5, 4, 6] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 16, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L16" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Classes", - "children": [774, 9, 867, 186, 81, 604] - }, - { - "title": "Interfaces", - "children": [889, 896] - }, - { - "title": "Type Aliases", - "children": [908, 906, 887, 904, 911] - }, - { - "title": "Variables", - "children": [1] - } - ], - "packageName": "@supabase/postgrest-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase PostgREST JS SDK

    \n\n

    Isomorphic JavaScript SDK for PostgREST with an ORM-like interface.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/postgrest-js)](https://www.npmjs.com/package/@supabase/postgrest-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js)\n\n
    \n\n### Quick start\n\nInstall\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nUsage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst REST_URL = 'http://localhost:3000'\nconst postgrest = new PostgrestClient(REST_URL)\n```" - }, - { - "kind": "text", - "text": "\n\n- [select()](https://supabase.com/docs/reference/javascript/select)\n- [insert()](https://supabase.com/docs/reference/javascript/insert)\n- [update()](https://supabase.com/docs/reference/javascript/update)\n- [delete()](https://supabase.com/docs/reference/javascript/delete)\n\n#### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`postgrest-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst REST_URL = 'http://localhost:3000'\nconst postgrest = new PostgrestClient(REST_URL, {\n fetch: (...args) => fetch(...args),\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Build (from monorepo root)\npnpm nx build postgrest-js\n\n# Build with watch mode for development\npnpm nx build:watch postgrest-js\n\n# TypeScript type checking\npnpm nx type-check postgrest-js\n\n# Generate documentation\npnpm nx docs postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\n**Supabase CLI Required!** The " - }, - { - "kind": "code", - "text": "`postgrest-js`" - }, - { - "kind": "text", - "text": " tests use the [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started) to run a local PostgreSQL database and PostgREST server.\n\n#### Quick Start\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run all tests (from monorepo root)\npnpm nx test:ci:postgrest postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis single command automatically:\n\n1. Stops any existing Supabase CLI containers\n2. Starts PostgreSQL database and PostgREST server via Supabase CLI\n3. Resets and seeds the database\n4. Runs all Jest unit tests with coverage\n5. Cleans up containers\n\n#### Individual Test Commands\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run Jest tests with coverage (requires infrastructure running)\npnpm nx test:run postgrest-js\n\n# Run type tests with tstyche\npnpm nx test:types postgrest-js\n\n# Run smoke tests (CommonJS and ESM imports)\npnpm nx test:smoke postgrest-js\n\n# Format code\npnpm nx format postgrest-js\n\n# Check formatting\npnpm nx format:check postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure\n\nThe tests use Supabase CLI to spin up:\n\n- **PostgreSQL** - Database with test schema and seed data (port 54322)\n- **PostgREST** - REST API server that the client connects to (port 54321)\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Manually manage test infrastructure (from monorepo root)\npnpm nx test:infra postgrest-js # Start containers\npnpm nx test:clean-pre postgrest-js # Stop and remove containers\n```" - }, - { - "kind": "text", - "text": "\n\nOr directly via Supabase CLI:\n\n" - }, - { - "kind": "code", - "text": "```bash\ncd packages/core/postgrest-js\nnpx supabase --workdir ./test start # Start all services\nnpx supabase --workdir ./test db reset # Reset and seed database\nnpx supabase --workdir ./test stop # Stop all services\n```" - }, - { - "kind": "text", - "text": "\n\n#### Regenerating TypeScript Types\n\nWhen the database schema changes, regenerate TypeScript types from the actual database:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From the monorepo root\npnpm run codegen:postgrest\n```" - }, - { - "kind": "text", - "text": "\n\nThis command automatically:\n\n1. Cleans up any existing Supabase containers\n2. Starts Supabase (PostgreSQL, PostgREST, and all services)\n3. Generates TypeScript types from the database schema\n4. Post-processes the generated types (updates JSON type definitions)\n5. Formats the generated file with Prettier\n6. Cleans up Supabase containers\n\nThe generated types are written to " - }, - { - "kind": "code", - "text": "`test/types.generated.ts`" - }, - { - "kind": "text", - "text": ".\n\n#### Test Types Explained\n\n- **Unit Tests** - Jest tests covering all client functionality (" - }, - { - "kind": "code", - "text": "`pnpm nx test:run postgrest-js`" - }, - { - "kind": "text", - "text": ")\n- **Type Tests** - Validates TypeScript types using tstyche (" - }, - { - "kind": "code", - "text": "`pnpm nx test:types postgrest-js`" - }, - { - "kind": "text", - "text": ")\n- **Smoke Tests** - Basic import/require tests for CommonJS and ESM (" - }, - { - "kind": "code", - "text": "`pnpm nx test:smoke postgrest-js`" - }, - { - "kind": "text", - "text": ")\n\n#### Prerequisites\n\n- **Supabase CLI** must be installed ([instructions](https://supabase.com/docs/guides/local-development/cli/getting-started)) or can be used through " - }, - { - "kind": "code", - "text": "`npx`" - }, - { - "kind": "text", - "text": " (" - }, - { - "kind": "code", - "text": "`npx supabase`" - }, - { - "kind": "text", - "text": ")\n- **Docker** must be installed and running (Supabase CLI uses Docker under the hood)\n- **Port 54321** - PostgREST API\n- **Port 54322** - PostgreSQL database\n- **Port 54323** - Supabase Studio (used for type generation)\n\n#### PostgREST v12 Backward Compatibility Tests\n\nWe maintain backward compatibility tests for PostgREST v12 (the current Supabase CLI uses v14+). These tests ensure the SDK works correctly for users still running older PostgREST versions.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run v12 compatibility tests (requires Docker)\npnpm nx test:ci:v12 postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command:\n\n1. Starts PostgREST v12 + PostgreSQL in Docker (ports 3012/5433)\n2. Runs runtime tests that verify v12-specific behavior\n3. Cleans up containers\n\n**Type-only tests** for v12 compatibility also run as part of the regular type tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\npnpm nx test:types postgrest-js # Includes v12-compat.test-d.ts\n```" - }, - { - "kind": "text", - "text": "\n\n**Note:** These v12 tests will be removed when v3 ships (sometime in 2026).\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n## License\n\nThis repo is licensed under MIT License." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "default" - }, - "2": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object" - }, - "3": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestClient" - }, - "4": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestQueryBuilder" - }, - "5": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestFilterBuilder" - }, - "6": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestTransformBuilder" - }, - "7": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestBuilder" - }, - "8": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestError" - }, - "9": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default" - }, - "10": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.__constructor" - }, - "11": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default" - }, - "12": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Database" - }, - "13": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "14": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "15": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "16": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "17": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.SchemaName" - }, - "18": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Schema" - }, - "19": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "url" - }, - "20": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__1" - }, - "21": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "22": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.headers" - }, - "23": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.schema" - }, - "24": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.fetch" - }, - "25": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "26": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "27": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "28": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "29": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "30": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "31": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "32": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.timeout" - }, - "33": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "34": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.retry" - }, - "35": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.url" - }, - "36": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.headers" - }, - "37": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schemaName" - }, - "38": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.fetch" - }, - "39": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "40": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "41": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "42": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "43": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "44": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "45": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "46": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "47": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.retry" - }, - "48": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "49": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "50": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "TableName" - }, - "51": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "Table" - }, - "52": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "relation" - }, - "53": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "54": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "ViewName" - }, - "55": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "View" - }, - "56": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "relation" - }, - "57": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schema" - }, - "58": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schema" - }, - "59": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "DynamicSchema" - }, - "60": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "schema" - }, - "61": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.rpc" - }, - "62": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.rpc" - }, - "63": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "FnName" - }, - "64": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "Args" - }, - "65": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "FilterBuilder" - }, - "66": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "fn" - }, - "67": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "args" - }, - "68": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__2" - }, - "69": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.head" - }, - "71": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.get" - }, - "72": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.count" - }, - "73": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "74": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Database" - }, - "75": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "76": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "77": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "78": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "79": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.SchemaName" - }, - "80": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Schema" - }, - "81": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default" - }, - "82": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "83": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default" - }, - "84": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "85": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Schema" - }, - "86": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relation" - }, - "87": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "88": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "89": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "90": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Relationships" - }, - "91": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "url" - }, - "92": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "93": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.headers" - }, - "95": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.schema" - }, - "96": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "97": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "98": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "99": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "100": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "101": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "102": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "103": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "104": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "105": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.retry" - }, - "106": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.url" - }, - "107": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.headers" - }, - "108": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.schema" - }, - "109": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.signal" - }, - "110": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.fetch" - }, - "111": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "112": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "113": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "114": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "115": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "116": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "117": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "118": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "119": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.retry" - }, - "125": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.select" - }, - "126": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.select" - }, - "127": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Query" - }, - "128": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "ResultOne" - }, - "129": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "columns" - }, - "130": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "options" - }, - "131": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "132": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.head" - }, - "133": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "134": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "135": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.insert" - }, - "136": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.insert" - }, - "137": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "138": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "139": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "140": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "141": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "142": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "143": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "144": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "145": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "146": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "147": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.defaultToNull" - }, - "148": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.upsert" - }, - "149": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.upsert" - }, - "150": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "151": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "152": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "153": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "154": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "155": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "156": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "157": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "158": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.onConflict" - }, - "159": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.ignoreDuplicates" - }, - "160": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "161": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "162": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.defaultToNull" - }, - "163": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.update" - }, - "164": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.update" - }, - "165": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "166": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "167": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "168": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Update" - }, - "169": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "170": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "171": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "172": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "173": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.delete" - }, - "174": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.delete" - }, - "175": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__0" - }, - "176": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "177": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "178": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "179": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "180": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Schema" - }, - "181": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relation" - }, - "182": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "183": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "184": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "185": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Relationships" - }, - "186": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default" - }, - "187": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "188": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "189": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "190": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Schema" - }, - "191": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Row" - }, - "192": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Result" - }, - "193": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "194": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "195": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Method" - }, - "196": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "197": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "198": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "199": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "200": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "201": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "202": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "203": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "204": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "205": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "206": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "207": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "208": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "209": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "210": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "211": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "212": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "213": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "214": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "215": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "216": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "217": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.eq" - }, - "218": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.eq" - }, - "219": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "220": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "221": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "222": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "223": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.neq" - }, - "224": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.neq" - }, - "225": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "226": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "227": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "228": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "229": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "230": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "231": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "232": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "233": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "234": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "235": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "236": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "237": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "238": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "239": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "240": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "241": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "242": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "243": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "244": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "245": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "246": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "247": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "248": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "249": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "250": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "251": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "252": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "253": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "254": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "255": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "256": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "257": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "258": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "259": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "260": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "261": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "262": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "263": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "264": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "265": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "266": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "267": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "268": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "269": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "270": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "271": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "272": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "273": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "274": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "275": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "276": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "277": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "278": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "279": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "280": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "281": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "282": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "283": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "284": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "285": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "286": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "287": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "288": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "289": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "290": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "291": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "292": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "293": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "294": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "295": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "296": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "297": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "298": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "299": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "300": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "301": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "302": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "303": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "304": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "305": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "306": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "307": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "308": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "309": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "310": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "311": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "312": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "313": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "314": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "315": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "316": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "317": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "318": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "319": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "320": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "321": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "322": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "323": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "324": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "325": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "326": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "327": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "328": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "329": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "330": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "331": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "332": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.isDistinct" - }, - "333": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.isDistinct" - }, - "334": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "335": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "336": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "337": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.in" - }, - "338": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.in" - }, - "339": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "340": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "341": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "values" - }, - "342": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.notIn" - }, - "343": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.notIn" - }, - "344": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "345": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "346": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "values" - }, - "347": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "348": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "349": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "350": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "351": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "352": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "353": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "354": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "355": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "356": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "357": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "358": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "359": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "360": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "361": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "362": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "363": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "364": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "365": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "366": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "367": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "368": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "369": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "370": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "371": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "372": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "373": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "374": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "375": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "376": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "377": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "378": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "379": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "380": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "381": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "382": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "383": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "384": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "385": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "386": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "387": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "388": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "389": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "390": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "391": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "392": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "393": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "394": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "395": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "396": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "397": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "398": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "399": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "400": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "401": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "402": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "403": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "404": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "405": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "406": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "407": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "408": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "409": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "410": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "411": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "412": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "413": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "414": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "415": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "416": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "options" - }, - "417": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "418": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.config" - }, - "419": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.type" - }, - "420": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "421": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "422": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "423": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "options" - }, - "424": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "425": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.config" - }, - "426": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.type" - }, - "427": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "428": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "429": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "430": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "431": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "432": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "433": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "434": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "435": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "436": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "437": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "438": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "439": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "440": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "441": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "442": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "443": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "444": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "445": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "446": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "447": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "448": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.or" - }, - "449": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.or" - }, - "450": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "filters" - }, - "451": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__1" - }, - "452": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "454": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "455": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "456": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "457": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "458": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "459": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "460": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "461": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "462": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "463": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "464": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "465": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "466": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "467": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "Query" - }, - "468": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResultOne" - }, - "469": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "columns" - }, - "470": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "471": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "472": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "473": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "474": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "475": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "476": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "477": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "478": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "479": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "480": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "481": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "482": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "483": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "484": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "485": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "486": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "487": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "488": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "489": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "490": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "491": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "492": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "493": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "494": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "495": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "496": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "497": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "498": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "499": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "500": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "501": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "502": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "503": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "count" - }, - "504": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__1" - }, - "505": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "506": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "507": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "508": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "509": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "510": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "from" - }, - "511": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "to" - }, - "512": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__2" - }, - "513": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "514": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "515": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "516": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "517": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "518": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "signal" - }, - "519": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "520": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "521": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "522": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "523": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "524": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "525": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "526": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "527": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "528": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "529": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "530": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "531": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__0" - }, - "532": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "533": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.analyze" - }, - "534": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.verbose" - }, - "535": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.settings" - }, - "536": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.buffers" - }, - "537": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.wal" - }, - "538": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.format" - }, - "539": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "540": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "541": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "542": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "543": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResult" - }, - "544": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "545": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "546": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "value" - }, - "547": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "548": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "549": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "550": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "551": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "552": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "553": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "554": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "555": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "556": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "557": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "558": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "559": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "560": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "561": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "562": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "563": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "564": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "565": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "566": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "567": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "568": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "569": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "570": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "571": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "572": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "573": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "574": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "575": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "576": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "577": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "578": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "579": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "580": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "581": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "582": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "583": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "584": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "585": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "586": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "587": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "588": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "589": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "590": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "591": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "592": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "593": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "594": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "595": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "596": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "597": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "598": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Schema" - }, - "599": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Row" - }, - "600": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Result" - }, - "601": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "602": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "603": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Method" - }, - "604": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default" - }, - "605": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "606": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "607": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "608": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Schema" - }, - "609": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Row" - }, - "610": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Result" - }, - "611": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "612": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "613": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Method" - }, - "614": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "615": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "617": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "618": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "619": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "620": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "621": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "622": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "623": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "624": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "625": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "626": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "627": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "628": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "629": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "630": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "631": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "632": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "633": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "634": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "635": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "636": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "637": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "Query" - }, - "638": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResultOne" - }, - "639": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "columns" - }, - "640": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "641": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "642": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "643": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "644": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "645": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "646": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "647": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "648": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "649": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "650": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "651": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "652": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "653": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "654": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "655": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "656": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "657": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "658": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "659": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "660": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "661": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "662": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "663": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "664": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "665": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "666": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "667": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "668": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "669": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "670": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "671": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "672": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "673": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "count" - }, - "674": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__1" - }, - "675": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "676": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "677": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "678": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "679": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "680": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "from" - }, - "681": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "to" - }, - "682": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__2" - }, - "683": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "684": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "685": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "686": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "687": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "688": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "signal" - }, - "689": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "690": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "691": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "692": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "693": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "694": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "695": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "696": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "697": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "698": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "699": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "700": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "701": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__0" - }, - "702": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "703": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.analyze" - }, - "704": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.verbose" - }, - "705": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.settings" - }, - "706": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.buffers" - }, - "707": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.wal" - }, - "708": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.format" - }, - "709": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "710": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "711": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "712": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "713": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResult" - }, - "714": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "715": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "716": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "value" - }, - "717": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "718": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "719": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "720": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "721": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "722": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "723": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "724": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "725": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "726": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "727": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "728": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "729": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "730": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "731": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "732": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "733": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "734": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "735": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "736": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "737": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "738": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "739": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "740": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "741": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "742": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "743": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "744": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "745": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "746": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "747": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "748": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "749": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "750": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "751": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "752": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "753": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "754": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "755": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "756": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "757": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "758": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "759": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "760": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "761": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "762": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "763": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "765": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "766": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "767": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "768": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Schema" - }, - "769": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Row" - }, - "770": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Result" - }, - "771": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "772": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "773": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Method" - }, - "774": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "775": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "776": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "777": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "778": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.Result" - }, - "779": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ThrowOnError" - }, - "780": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "781": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "782": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "783": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "784": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "785": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "786": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "787": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "788": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "789": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "790": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "791": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "792": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "793": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "794": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "795": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "796": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "797": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "798": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "799": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "800": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "801": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "802": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "803": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "804": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "805": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "806": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "807": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "808": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "809": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "810": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "811": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "812": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "813": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "814": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "815": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "816": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "817": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "818": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "819": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "820": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "821": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "822": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "823": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "824": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "825": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "826": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "827": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "828": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "829": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "830": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "831": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "832": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "833": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "834": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "835": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "836": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "837": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "838": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "839": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "840": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "841": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "842": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "853": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.returns" - }, - "854": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.returns" - }, - "855": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "856": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "857": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "858": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "859": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "860": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "861": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "862": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "863": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "864": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "865": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.Result" - }, - "866": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ThrowOnError" - }, - "867": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default" - }, - "868": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.__constructor" - }, - "869": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default" - }, - "870": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "context" - }, - "871": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "873": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "874": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "875": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "876": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.details" - }, - "877": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.hint" - }, - "878": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.code" - }, - "879": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.toJSON" - }, - "880": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.toJSON" - }, - "881": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "882": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.name" - }, - "883": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "884": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "885": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "886": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "887": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponse" - }, - "888": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "889": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure" - }, - "890": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.success" - }, - "891": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.error" - }, - "892": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.data" - }, - "893": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.count" - }, - "894": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.status" - }, - "895": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.statusText" - }, - "896": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "897": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.success" - }, - "898": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.error" - }, - "899": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.data" - }, - "900": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.count" - }, - "901": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.status" - }, - "902": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.statusText" - }, - "903": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.T" - }, - "904": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestSingleResponse" - }, - "905": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "906": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestMaybeSingleResponse" - }, - "907": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "908": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "ClientServerOptions" - }, - "909": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "__type" - }, - "910": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "911": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "GetResult" - }, - "912": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Schema" - }, - "913": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Row" - }, - "914": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "RelationName" - }, - "915": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Relationships" - }, - "916": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Query" - }, - "917": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ClientOptions" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } - }, - { - "id": 0, - "name": "@supabase/realtime-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 693, - "name": "REALTIME_LISTEN_TYPES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 694, - "name": "BROADCAST", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L138" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 696, - "name": "POSTGRES_CHANGES", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L140" - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 695, - "name": "PRESENCE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 139, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L139" - } - ], - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 697, - "name": "SYSTEM", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L141" - } - ], - "type": { - "type": "literal", - "value": "system" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [694, 696, 695, 697] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 137, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L137" - } - ] - }, - { - "id": 698, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 699, - "name": "ALL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 131, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L131" - } - ], - "type": { - "type": "literal", - "value": "*" - } - }, - { - "id": 702, - "name": "DELETE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 134, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L134" - } - ], - "type": { - "type": "literal", - "value": "DELETE" - } - }, - { - "id": 700, - "name": "INSERT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L132" - } - ], - "type": { - "type": "literal", - "value": "INSERT" - } - }, - { - "id": 701, - "name": "UPDATE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 133, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L133" - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [699, 702, 700, 701] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 130, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L130" - } - ] - }, - { - "id": 703, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 705, - "name": "JOIN", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L33" - } - ], - "type": { - "type": "literal", - "value": "join" - } - }, - { - "id": 706, - "name": "LEAVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L34" - } - ], - "type": { - "type": "literal", - "value": "leave" - } - }, - { - "id": 704, - "name": "SYNC", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L32" - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [705, 706, 704] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 31, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L31" - } - ] - }, - { - "id": 707, - "name": "REALTIME_SUBSCRIBE_STATES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 711, - "name": "CHANNEL_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 148, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L148" - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - } - }, - { - "id": 710, - "name": "CLOSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 147, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L147" - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - } - }, - { - "id": 708, - "name": "SUBSCRIBED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 145, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L145" - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - } - }, - { - "id": 709, - "name": "TIMED_OUT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L146" - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [711, 710, 708, 709] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 144, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L144" - } - ] - }, - { - "id": 10, - "name": "RealtimeChannel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "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": 15, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L238" - } - ], - "signatures": [ - { - "id": 16, - "name": "RealtimeChannel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\n\nThe topic determines which realtime stream you are subscribing to. Config options let you\nenable acknowledgement for broadcasts, presence tracking, or private channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L238" - } - ], - "parameters": [ - { - "id": 17, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 18, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - }, - { - "id": 19, - "name": "socket", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 20, - "name": "bindings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L177" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "Binding" - }, - "name": "Binding", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 22, - "name": "broadcastEndpointURL", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 179, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L179" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 241, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L241" - } - ], - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - }, - { - "id": 24, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 181, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L181" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 23, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 180, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L180" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 40, - "name": "socket", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 242, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L242" - } - ], - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 21, - "name": "subTopic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 178, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L178" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 38, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 240, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L240" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 30, - "name": "joinedOnce", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L193" - } - ], - "getSignature": { - "id": 31, - "name": "joinedOnce", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L193" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - }, - { - "id": 34, - "name": "joinPush", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 201, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L201" - } - ], - "getSignature": { - "id": 35, - "name": "joinPush", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 201, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L201" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/push.js", - "qualifiedName": "default" - }, - "name": "Push", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 36, - "name": "rejoinTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 205, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L205" - } - ], - "getSignature": { - "id": 37, - "name": "rejoinTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 205, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L205" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 26, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 185, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L185" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 189, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L189" - } - ], - "getSignature": { - "id": 27, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 185, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L185" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - }, - "setSignature": { - "id": 28, - "name": "state", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 189, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L189" - } - ], - "parameters": [ - { - "id": 29, - "name": "state", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 32, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 197, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L197" - } - ], - "getSignature": { - "id": 33, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 197, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L197" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 369, - "name": "copyBindings", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 1099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L1099" - } - ], - "signatures": [ - { - "id": 370, - "name": "copyBindings", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 1099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L1099" - } - ], - "parameters": [ - { - "id": 371, - "name": "other", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 305, - "name": "httpSend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 764, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L764" - } - ], - "signatures": [ - { - "id": 306, - "name": "httpSend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a broadcast message explicitly via REST API.\n\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\n\nPayloads that are " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`ArrayBufferView`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`Uint8Array`" - }, - { - "kind": "text", - "text": ") are sent as\n" - }, - { - "kind": "code", - "text": "`application/octet-stream`" - }, - { - "kind": "text", - "text": "; all other payloads are JSON-encoded." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise resolving to object with success status, and error details if failed" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 764, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L764" - } - ], - "parameters": [ - { - "id": 307, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the broadcast event" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 308, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent (required)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 309, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options including timeout" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 311, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 767, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L767" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [311] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 767, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L767" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 312, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 313, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [313] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 314, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 317, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 316, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 315, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [317, 316, 315] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 86, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listen to realtime events on this channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, Broadcast and Presence are enabled for all projects.\n- By default, listening to database changes is disabled for new projects due to database performance and security concerns. You can turn it on by managing Realtime's [replication](/docs/guides/api#realtime-api-overview).\n- You can receive the \"previous\" data for updates and deletes by setting the table's " - }, - { - "kind": "code", - "text": "`REPLICA IDENTITY`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`FULL`" - }, - { - "kind": "text", - "text": " (e.g., " - }, - { - "kind": "code", - "text": "`ALTER TABLE your_table REPLICA IDENTITY FULL;`" - }, - { - "kind": "text", - "text": ").\n- Row level security is not applied to delete statements. When RLS is enabled and replica identity is set to full, only the primary key is sent to clients." - } - ] - }, - { - "tag": "@example", - "name": "Listen to broadcast messages", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel(\"room1\")\n\nchannel.on(\"broadcast\", { event: \"cursor-pos\" }, (payload) => {\n console.log(\"Cursor position received!\", payload);\n}).subscribe((status) => {\n if (status === \"SUBSCRIBED\") {\n channel.send({\n type: \"broadcast\",\n event: \"cursor-pos\",\n payload: { x: Math.random(), y: Math.random() },\n });\n }\n});\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence sync", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'sync' }, () => {\n console.log('Synced presence state: ', channel.presenceState())\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence join", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'join' }, ({ newPresences }) => {\n console.log('Newly joined presences: ', newPresences)\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence leave", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'leave' }, ({ leftPresences }) => {\n console.log('Newly left presences: ', leftPresences)\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n await channel.untrack()\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to all database changes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: '*', schema: '*' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to a specific table", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: '*', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to inserts", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to updates\nBy default, Supabase will send only the updated record. If you want to receive the previous values as well you can\nenable full replication for the table you are listening to:\n\n" - }, - { - "kind": "code", - "text": "```sql\nalter table \"your_table\" replica identity full;\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to updates", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to deletes\nBy default, Supabase does not send deleted records. If you want to receive the deleted record you can\nenable full replication for the table you are listening to:\n\n" - }, - { - "kind": "code", - "text": "```sql\nalter table \"your_table\" replica identity full;\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to deletes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to multiple events\nYou can chain listeners if you want to listen to multiple events for each table." - } - ] - }, - { - "tag": "@example", - "name": "Listen to multiple events", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, handleRecordInserted)\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, handleRecordDeleted)\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to row level changes\nYou can listen to individual rows using the format " - }, - { - "kind": "code", - "text": "`{table}:{col}=eq.{val}`" - }, - { - "kind": "text", - "text": " - where " - }, - { - "kind": "code", - "text": "`{col}`" - }, - { - "kind": "text", - "text": " is the column name, and " - }, - { - "kind": "code", - "text": "`{val}`" - }, - { - "kind": "text", - "text": " is the value which you want to match." - } - ] - }, - { - "tag": "@example", - "name": "Listen to row level changes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries', filter: 'id=eq.200' }, handleRecordUpdated)\n .subscribe()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L453" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 504, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L504" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 530, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L530" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 730, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L730" - } - ], - "signatures": [ - { - "id": 87, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L453" - } - ], - "parameters": [ - { - "id": 88, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 89, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 90, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 91, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 455, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L455" - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [91] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 455, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L455" - } - ] - } - } - }, - { - "id": 92, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 456, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L456" - } - ], - "signatures": [ - { - "id": 94, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 456, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 95, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "typeParameters": [ - { - "id": 96, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 97, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "indexSignatures": [ - { - "id": 98, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "parameters": [ - { - "id": 99, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 100, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 101, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 102, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 103, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 460, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L460" - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [103] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 460, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L460" - } - ] - } - } - }, - { - "id": 104, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 461, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L461" - } - ], - "signatures": [ - { - "id": 106, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 461, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L461" - } - ], - "parameters": [ - { - "id": 107, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 662, - "typeArguments": [ - { - "type": "reference", - "target": 96, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 108, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "typeParameters": [ - { - "id": 109, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 110, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "indexSignatures": [ - { - "id": 111, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "parameters": [ - { - "id": 112, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 113, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 114, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 116, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 465, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L465" - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [116] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 465, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L465" - } - ] - } - } - }, - { - "id": 117, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 466, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L466" - } - ], - "signatures": [ - { - "id": 119, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 466, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L466" - } - ], - "parameters": [ - { - "id": 120, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 672, - "typeArguments": [ - { - "type": "reference", - "target": 109, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 121, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "typeParameters": [ - { - "id": 122, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "indexSignatures": [ - { - "id": 124, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "parameters": [ - { - "id": 125, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 126, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 127, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 128, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 129, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 470, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L470" - } - ], - "type": { - "type": "literal", - "value": "*" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [129] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 470, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L470" - } - ] - } - } - }, - { - "id": 130, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 471, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L471" - } - ], - "signatures": [ - { - "id": 132, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 471, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L471" - } - ], - "parameters": [ - { - "id": 133, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 662, - "typeArguments": [ - { - "type": "reference", - "target": 122, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 672, - "typeArguments": [ - { - "type": "reference", - "target": 122, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 134, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "typeParameters": [ - { - "id": 135, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "indexSignatures": [ - { - "id": 137, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "parameters": [ - { - "id": 138, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 139, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 140, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 141, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 142, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 476, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L476" - } - ], - "signatures": [ - { - "id": 143, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 476, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L476" - } - ], - "parameters": [ - { - "id": 144, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 628, - "typeArguments": [ - { - "type": "reference", - "target": 135, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 145, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "typeParameters": [ - { - "id": 146, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 147, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "indexSignatures": [ - { - "id": 148, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "parameters": [ - { - "id": 149, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 151, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 152, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 481, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L481" - } - ], - "signatures": [ - { - "id": 154, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 481, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L481" - } - ], - "parameters": [ - { - "id": 155, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 633, - "typeArguments": [ - { - "type": "reference", - "target": 146, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 156, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "typeParameters": [ - { - "id": 157, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 158, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "indexSignatures": [ - { - "id": 159, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "parameters": [ - { - "id": 160, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 161, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 162, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 163, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 164, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 486, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L486" - } - ], - "signatures": [ - { - "id": 165, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 486, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L486" - } - ], - "parameters": [ - { - "id": 166, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 643, - "typeArguments": [ - { - "type": "reference", - "target": 157, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 167, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "typeParameters": [ - { - "id": 168, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 169, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "indexSignatures": [ - { - "id": 170, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "parameters": [ - { - "id": 171, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 172, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 173, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 174, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 491, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L491" - } - ], - "signatures": [ - { - "id": 176, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 491, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L491" - } - ], - "parameters": [ - { - "id": 177, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 652, - "typeArguments": [ - { - "type": "reference", - "target": 168, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 178, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "typeParameters": [ - { - "id": 179, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "indexSignatures": [ - { - "id": 181, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "parameters": [ - { - "id": 182, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 183, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 184, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INSERT" - }, - { - "type": "literal", - "value": "UPDATE" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "*" - } - ] - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 185, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 496, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L496" - } - ], - "signatures": [ - { - "id": 187, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 496, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L496" - } - ], - "parameters": [ - { - "id": 188, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 628, - "typeArguments": [ - { - "type": "reference", - "target": 179, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 189, - "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": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 504, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L504" - } - ], - "parameters": [ - { - "id": 190, - "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": 191, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 193, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 506, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L506" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [193] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 506, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L506" - } - ] - } - } - }, - { - "id": 194, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function to be invoked when event handler is triggered." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 195, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "signatures": [ - { - "id": 196, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "parameters": [ - { - "id": 197, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 198, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 200, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 509, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L509" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 201, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 510, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L510" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 202, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 204, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 512, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 203, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 511, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L511" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [204, 203] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 510, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L510" - } - ] - } - } - }, - { - "id": 199, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 508, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L508" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [200, 201, 199] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "indexSignatures": [ - { - "id": 205, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 514, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L514" - } - ], - "parameters": [ - { - "id": 206, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 207, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "typeParameters": [ - { - "id": 208, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 209, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "indexSignatures": [ - { - "id": 210, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "parameters": [ - { - "id": 211, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 212, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 213, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 214, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 215, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 519, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L519" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [215] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 519, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L519" - } - ] - } - } - }, - { - "id": 216, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 217, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ], - "signatures": [ - { - "id": 218, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ], - "parameters": [ - { - "id": 219, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 220, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 222, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 522, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L522" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 223, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 523, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L523" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 226, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 525, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L525" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 524, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L524" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [226, 225] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 523, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L523" - } - ] - } - } - }, - { - "id": 227, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 527, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L527" - } - ], - "type": { - "type": "reference", - "target": 208, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 221, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 521, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L521" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [222, 223, 227, 221] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 228, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 530, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L530" - } - ], - "typeParameters": [ - { - "id": 229, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 230, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 231, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 232, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 233, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 532, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L532" - } - ], - "type": { - "type": "reference", - "target": 699, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [233] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 532, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L532" - } - ] - } - } - }, - { - "id": 234, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 235, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ], - "signatures": [ - { - "id": 236, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ], - "parameters": [ - { - "id": 237, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 238, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 240, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 535, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L535" - } - ], - "type": { - "type": "reference", - "target": 699, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - }, - { - "id": 241, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 536, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L536" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 229, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 239, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 534, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L534" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [240, 241, 239] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 242, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "typeParameters": [ - { - "id": 243, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 244, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "indexSignatures": [ - { - "id": 245, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "parameters": [ - { - "id": 246, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 247, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 248, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 249, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 250, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 541, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L541" - } - ], - "type": { - "type": "reference", - "target": 700, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [250] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 541, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L541" - } - ] - } - } - }, - { - "id": 251, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 252, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ], - "signatures": [ - { - "id": 253, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ], - "parameters": [ - { - "id": 254, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 257, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 544, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L544" - } - ], - "type": { - "type": "reference", - "target": 700, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - }, - { - "id": 258, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 545, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L545" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastInsertPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 243, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastInsertPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 256, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 543, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L543" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [257, 258, 256] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 259, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "typeParameters": [ - { - "id": 260, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "indexSignatures": [ - { - "id": 262, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "parameters": [ - { - "id": 263, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 264, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 265, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 266, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 267, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 550, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L550" - } - ], - "type": { - "type": "reference", - "target": 701, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [267] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 550, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L550" - } - ] - } - } - }, - { - "id": 268, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 269, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ], - "signatures": [ - { - "id": 270, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ], - "parameters": [ - { - "id": 271, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 272, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 274, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 553, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L553" - } - ], - "type": { - "type": "reference", - "target": 701, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - }, - { - "id": 275, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 554, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L554" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastUpdatePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 260, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastUpdatePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 273, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 552, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L552" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [274, 275, 273] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 276, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "typeParameters": [ - { - "id": 277, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 278, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "indexSignatures": [ - { - "id": 279, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "parameters": [ - { - "id": 280, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 281, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 282, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 283, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 284, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 559, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L559" - } - ], - "type": { - "type": "reference", - "target": 702, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [284] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 559, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L559" - } - ] - } - } - }, - { - "id": 285, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 286, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ], - "signatures": [ - { - "id": 287, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ], - "parameters": [ - { - "id": 288, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 289, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 291, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 562, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L562" - } - ], - "type": { - "type": "reference", - "target": 702, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - }, - { - "id": 292, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 563, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L563" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastDeletePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 277, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastDeletePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 290, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 561, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L561" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [291, 292, 290] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 293, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "typeParameters": [ - { - "id": 294, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 295, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "indexSignatures": [ - { - "id": 296, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "parameters": [ - { - "id": 297, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 298, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 299, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 300, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 301, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 302, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 569, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L569" - } - ], - "signatures": [ - { - "id": 303, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 569, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L569" - } - ], - "parameters": [ - { - "id": 304, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 63, - "name": "presenceState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "signatures": [ - { - "id": 64, - "name": "presenceState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current presence state for this channel.\n\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\ntracked metadata for that user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "typeParameters": [ - { - "id": 65, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 66, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "indexSignatures": [ - { - "id": 67, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "parameters": [ - { - "id": 68, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "target": 682, - "typeArguments": [ - { - "type": "reference", - "target": 65, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 318, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 863, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L863" - } - ], - "signatures": [ - { - "id": 319, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a message into the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- When using REST you don't need to subscribe to the channel\n- REST calls are only available from 2.37.0 onwards\n- If you create a channel only to send a REST broadcast, remove it from\n the client when the send completes" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via websocket", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\nchannel.subscribe((status) => {\n if (status === 'SUBSCRIBED') {\n channel.send({\n type: 'broadcast',\n event: 'cursor-pos',\n payload: { x: Math.random(), y: Math.random() },\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Send a message via websocket\n" - }, - { - "kind": "code", - "text": "```js\nok | timed out | error\n```" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via REST", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\ntry {\n await channel.httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\n} finally {\n await supabase.removeChannel(channel)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 863, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L863" - } - ], - "parameters": [ - { - "id": 320, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arguments to send to channel" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 323, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event being sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 866, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L866" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 324, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 867, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L867" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 322, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of event to send" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 865, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L865" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [323, 324, 322] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 864, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L864" - } - ], - "indexSignatures": [ - { - "id": 325, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 868, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L868" - } - ], - "parameters": [ - { - "id": 326, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 327, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options to be used during the send process" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 328, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 870, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L870" - } - ], - "indexSignatures": [ - { - "id": 329, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 870, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L870" - } - ], - "parameters": [ - { - "id": 330, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 41, - "name": "subscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L292" - } - ], - "signatures": [ - { - "id": 42, - "name": "subscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Subscribe registers your client with the server.\n\nThe optional " - }, - { - "kind": "code", - "text": "`callback`" - }, - { - "kind": "text", - "text": " receives a " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and, on failure, an " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " argument.\nLog the full " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " so its " - }, - { - "kind": "code", - "text": "`cause`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", and any structured fields aren't hidden\nbehind " - }, - { - "kind": "code", - "text": "`err.message`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.channel('room1').subscribe((status, err) => {\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\n // Log the full error: its `cause` often holds the underlying reason.\n console.error(status, err)\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L292" - } - ], - "parameters": [ - { - "id": 43, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 44, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 293, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L293" - } - ], - "signatures": [ - { - "id": 45, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 293, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L293" - } - ], - "parameters": [ - { - "id": 46, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 707, - "name": "REALTIME_SUBSCRIBE_STATES", - "package": "@supabase/realtime-js" - } - }, - { - "id": 47, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 48, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 337, - "name": "teardown", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L971" - } - ], - "signatures": [ - { - "id": 338, - "name": "teardown", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Destroys and stops related timers." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L971" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 70, - "name": "track", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 421, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L421" - } - ], - "signatures": [ - { - "id": 71, - "name": "track", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends the supplied payload to the presence tracker so other subscribers can see that this\nclient is online. Use " - }, - { - "kind": "code", - "text": "`untrack`" - }, - { - "kind": "text", - "text": " to stop broadcasting presence for the same key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 421, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L421" - } - ], - "parameters": [ - { - "id": 72, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 422, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L422" - } - ], - "indexSignatures": [ - { - "id": 74, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 422, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L422" - } - ], - "parameters": [ - { - "id": 75, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 76, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 77, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 423, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L423" - } - ], - "indexSignatures": [ - { - "id": 78, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 423, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L423" - } - ], - "parameters": [ - { - "id": 79, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 334, - "name": "unsubscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 956, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L956" - } - ], - "signatures": [ - { - "id": 335, - "name": "unsubscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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!\") )" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 956, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L956" - } - ], - "parameters": [ - { - "id": 336, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 80, - "name": "untrack", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "signatures": [ - { - "id": 81, - "name": "untrack", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes the current presence state for this client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "parameters": [ - { - "id": 82, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "indexSignatures": [ - { - "id": 84, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "parameters": [ - { - "id": 85, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 331, - "name": "updateJoinPayload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L941" - } - ], - "signatures": [ - { - "id": 332, - "name": "updateJoinPayload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the payload that will be sent the next time the channel joins (reconnects).\nUseful for rotating access tokens or updating config without re-creating the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L941" - } - ], - "parameters": [ - { - "id": 333, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [15] - }, - { - "title": "Properties", - "children": [20, 22, 39, 24, 23, 40, 21, 38] - }, - { - "title": "Accessors", - "children": [30, 34, 36, 26, 32] - }, - { - "title": "Methods", - "children": [369, 305, 86, 63, 318, 41, 337, 70, 334, 80, 331] - } - ], - "categories": [ - { - "title": "Other", - "children": [20, 22, 39, 24, 23, 40, 21, 38, 30, 34, 36, 26, 32, 369] - }, - { - "title": "Realtime", - "children": [15, 305, 86, 63, 318, 41, 337, 70, 334, 80, 331] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 176, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L176" - } - ] - }, - { - "id": 396, - "name": "RealtimeClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 397, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L277" - } - ], - "signatures": [ - { - "id": 398, - "name": "RealtimeClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the Socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nclient.connect()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L277" - } - ], - "parameters": [ - { - "id": 399, - "name": "endPoint", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 400, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 573, - "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": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future." - } - ], - "heartbeatIntervalMs": [ - { - "kind": "text", - "text": "The millisec interval to send a heartbeat message." - } - ], - "heartbeatCallback": [ - { - "kind": "text", - "text": "The optional function to handle heartbeat status and latency." - } - ], - "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." - } - ], - "vsn": [ - { - "kind": "text", - "text": "The protocol version to use when connecting. Supported versions are \"1.0.0\" and \"2.0.0\". Defaults to \"2.0.0\"." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 404, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 405, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "signatures": [ - { - "id": 406, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 403, - "name": "accessTokenValue", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L140" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 407, - "name": "apiKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L142" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 402, - "name": "channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L138" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - "defaultValue": "..." - }, - { - "id": 419, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L153" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 420, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 421, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 422, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 423, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 424, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 425, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 426, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 409, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "headers cannot be set on websocket connections" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "indexSignatures": [ - { - "id": 411, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "parameters": [ - { - "id": 412, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 408, - "name": "httpEndpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L144" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 418, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L151" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 413, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 414, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "indexSignatures": [ - { - "id": 415, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "parameters": [ - { - "id": 416, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 417, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 149, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L149" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 430, - "name": "serializer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L158" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/serializer.ts", - "qualifiedName": "default" - }, - "name": "Serializer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - }, - "defaultValue": "..." - }, - { - "id": 427, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 154, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L154" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 429, - "name": "workerRef", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L156" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Worker" - }, - "name": "Worker", - "package": "typescript" - } - }, - { - "id": 428, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L155" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "decode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 206, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L206" - } - ], - "getSignature": { - "id": 452, - "name": "decode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 206, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L206" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 449, - "name": "encode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 202, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L202" - } - ], - "getSignature": { - "id": 450, - "name": "encode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 202, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L202" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 431, - "name": "endPoint", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L160" - } - ], - "getSignature": { - "id": 432, - "name": "endPoint", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L160" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 437, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L172" - } - ], - "getSignature": { - "id": 438, - "name": "heartbeatCallback", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L172" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 439, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 176, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L176" - } - ], - "getSignature": { - "id": 440, - "name": "heartbeatIntervalMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 176, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L176" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 441, - "name": "heartbeatTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 180, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L180" - } - ], - "getSignature": { - "id": 442, - "name": "heartbeatTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 180, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L180" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "HeartbeatTimer" - }, - "name": "HeartbeatTimer", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 443, - "name": "pendingHeartbeatRef", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 187, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L187" - } - ], - "getSignature": { - "id": 444, - "name": "pendingHeartbeatRef", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 187, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L187" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 453, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 210, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L210" - } - ], - "getSignature": { - "id": 454, - "name": "reconnectAfterMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 210, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L210" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 455, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 74, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L74" - } - ], - "signatures": [ - { - "id": 456, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 74, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L74" - } - ], - "parameters": [ - { - "id": 457, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - } - }, - { - "id": 445, - "name": "reconnectTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L194" - } - ], - "getSignature": { - "id": 446, - "name": "reconnectTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L194" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 458, - "name": "sendBuffer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 214, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L214" - } - ], - "getSignature": { - "id": 459, - "name": "sendBuffer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 214, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L214" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 78, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L78" - } - ], - "signatures": [ - { - "id": 461, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 78, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - } - }, - { - "id": 462, - "name": "stateChangeCallbacks", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ], - "getSignature": { - "id": 463, - "name": "stateChangeCallbacks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 464, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 466, - "name": "close", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 220, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L220" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 467, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 221, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L221" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 468, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 222, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L222" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 465, - "name": "open", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 219, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L219" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [466, 467, 468, 465] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ] - } - } - } - }, - { - "id": 433, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L164" - } - ], - "getSignature": { - "id": 434, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L164" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 435, - "name": "transport", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L168" - } - ], - "getSignature": { - "id": 436, - "name": "transport", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L168" - } - ], - "type": { - "type": "reference", - "target": 782, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 447, - "name": "vsn", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 198, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L198" - } - ], - "getSignature": { - "id": 448, - "name": "vsn", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 198, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L198" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Vsn" - }, - "name": "Vsn", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 503, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L469" - } - ], - "signatures": [ - { - "id": 504, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates (or reuses) a " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RealtimeChannel", - "target": 10 - }, - { - "kind": "text", - "text": " for the provided topic.\n\nTopics are automatically prefixed with " - }, - { - "kind": "code", - "text": "`realtime:`" - }, - { - "kind": "text", - "text": " to match the Realtime service.\nIf a channel with the same topic already exists it will be returned instead of creating\na duplicate connection." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L469" - } - ], - "parameters": [ - { - "id": 505, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 506, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 475, - "name": "connect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L297" - } - ], - "signatures": [ - { - "id": 476, - "name": "connect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Connects the socket, unless already connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L297" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 495, - "name": "connectionState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 429, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L429" - } - ], - "signatures": [ - { - "id": 496, - "name": "connectionState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current state of the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 429, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L429" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "ConnectionState" - }, - "name": "ConnectionState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 479, - "name": "disconnect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 356, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L356" - } - ], - "signatures": [ - { - "id": 480, - "name": "disconnect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Disconnects the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 356, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L356" - } - ], - "parameters": [ - { - "id": 481, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A numeric status code to send on disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 482, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom reason for the disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timeout" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 477, - "name": "endpointURL", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L344" - } - ], - "signatures": [ - { - "id": 478, - "name": "endpointURL", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the URL of the websocket." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "string The URL of the websocket." - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L344" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 483, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L376" - } - ], - "signatures": [ - { - "id": 484, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all created channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L376" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 497, - "name": "isConnected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 438, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L438" - } - ], - "signatures": [ - { - "id": 498, - "name": "isConnected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " is the connection is open." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 438, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L438" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 499, - "name": "isConnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 447, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L447" - } - ], - "signatures": [ - { - "id": 500, - "name": "isConnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently connecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 447, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L447" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 501, - "name": "isDisconnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L456" - } - ], - "signatures": [ - { - "id": 502, - "name": "isDisconnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently disconnecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 490, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L420" - } - ], - "signatures": [ - { - "id": 491, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " - }, - { - "kind": "code", - "text": "`this.logger`" - }, - { - "kind": "text", - "text": " can be overridden in Client constructor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L420" - } - ], - "parameters": [ - { - "id": 492, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 493, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 494, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 517, - "name": "onHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L550" - } - ], - "signatures": [ - { - "id": 518, - "name": "onHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets a callback that receives lifecycle events for internal heartbeat messages.\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L550" - } - ], - "parameters": [ - { - "id": 519, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 507, - "name": "push", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L491" - } - ], - "signatures": [ - { - "id": 508, - "name": "push", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L491" - } - ], - "parameters": [ - { - "id": 509, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 614, - "name": "RealtimeMessage", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 488, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 401, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L401" - } - ], - "signatures": [ - { - "id": 489, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down all channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 401, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L401" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 691, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 485, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L386" - } - ], - "signatures": [ - { - "id": 486, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down a single channel" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L386" - } - ], - "parameters": [ - { - "id": 487, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A RealtimeChannel instance" - } - ] - }, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 691, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 515, - "name": "sendHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 540, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L540" - } - ], - "signatures": [ - { - "id": 516, - "name": "sendHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a heartbeat message if the socket is connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 540, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L540" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 510, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 517, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L517" - } - ], - "signatures": [ - { - "id": 511, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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.\n\nWhen a token is explicitly provided, it will be preserved across channel operations\n(including removeChannel and resubscribe). The " - }, - { - "kind": "code", - "text": "`accessToken`" - }, - { - "kind": "text", - "text": " callback will not be\ninvoked until " - }, - { - "kind": "code", - "text": "`setAuth()`" - }, - { - "kind": "text", - "text": " is called without arguments." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nSetting the authorization header\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\nclient.realtime.setAuth('my-custom-jwt')\n\n// Switch back to using the accessToken callback\nclient.realtime.setAuth()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 517, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L517" - } - ], - "parameters": [ - { - "id": 512, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A JWT string to override the token set on the client." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [397] - }, - { - "title": "Properties", - "children": [404, 403, 407, 402, 419, 409, 408, 418, 413, 417, 430, 427, 429, 428] - }, - { - "title": "Accessors", - "children": [451, 449, 431, 437, 439, 441, 443, 453, 445, 458, 462, 433, 435, 447] - }, - { - "title": "Methods", - "children": [ - 503, 475, 495, 479, 477, 483, 497, 499, 501, 490, 517, 507, 488, 485, 515, 510 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 404, 403, 407, 402, 419, 409, 408, 418, 413, 417, 430, 427, 429, 428, 451, 449, 431, - 437, 439, 441, 443, 453, 445, 458, 462, 433, 435, 447 - ] - }, - { - "title": "Realtime", - "children": [ - 397, 503, 475, 495, 479, 477, 483, 497, 499, 501, 490, 517, 507, 488, 485, 515, 510 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 135, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L135" - } - ] - }, - { - "id": 1, - "name": "RealtimePresence", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L65" - } - ], - "signatures": [ - { - "id": 3, - "name": "RealtimePresence", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Presence helper that keeps the local presence state in sync with the server." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example for a presence channel", - "content": [ - { - "kind": "code", - "text": "```ts\nconst presence = new RealtimePresence(channel)\n\nchannel.on('presence', ({ event, key }) => {\n console.log(`Presence ${event} on ${key}`)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L65" - } - ], - "parameters": [ - { - "id": 4, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 5, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom event names, e.g. " - }, - { - "kind": "code", - "text": "`{ events: { state: 'state', diff: 'diff' } }`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceOptions" - }, - "name": "RealtimePresenceOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 9, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 66, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L66" - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 6, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 42, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L42" - } - ], - "getSignature": { - "id": 7, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 42, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L42" - } - ], - "type": { - "type": "reference", - "target": 682, - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [9] - }, - { - "title": "Accessors", - "children": [6] - } - ], - "categories": [ - { - "title": "Other", - "children": [9, 6] - }, - { - "title": "Realtime", - "children": [2] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 41, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L41" - } - ] - }, - { - "id": 719, - "name": "WebSocketFactory", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Utilities for creating WebSocket instances across runtimes." - } - ] - }, - "children": [ - { - "id": 722, - "name": "getWebSocketConstructor", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 169, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L169" - } - ], - "signatures": [ - { - "id": 723, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the best available WebSocket constructor for the current runtime." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example with error handling", - "content": [ - { - "kind": "code", - "text": "```ts\ntry {\n const WS = WebSocketFactory.getWebSocketConstructor()\n const socket = new WS('wss://example.com/socket')\n} catch (error) {\n console.error('WebSocket not available in this environment.', error)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 169, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L169" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 724, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26772, - "character": 23 - } - ], - "signatures": [ - { - "id": 725, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26774, - "character": 4 - } - ], - "parameters": [ - { - "id": 726, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 727, - "name": "protocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" - }, - "name": "WebSocket", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 728, - "name": "isWebSocketSupported", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 194, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L194" - } - ], - "signatures": [ - { - "id": 729, - "name": "isWebSocketSupported", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detects whether the runtime can establish WebSocket connections." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example in a Node.js script", - "content": [ - { - "kind": "code", - "text": "```ts\nif (!WebSocketFactory.isWebSocketSupported()) {\n console.error('WebSockets are required for this script.')\n process.exitCode = 1\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 194, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L194" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [722, 728] - } - ], - "categories": [ - { - "title": "Realtime", - "children": [722, 728] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 61, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L61" - } - ] - }, - { - "id": 732, - "name": "WebSocketLike", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 775, - "name": "binaryType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L34" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 776, - "name": "bufferedAmount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L35" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 736, - "name": "CLOSED", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 5, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L5" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 735, - "name": "CLOSING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 4, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L4" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 733, - "name": "CONNECTING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 2, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L2" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 778, - "name": "dispatchEvent", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "signatures": [ - { - "id": 780, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "parameters": [ - { - "id": 781, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - }, - { - "id": 777, - "name": "extensions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 757, - "name": "onclose", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 758, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "signatures": [ - { - "id": 759, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "parameters": [ - { - "id": 760, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 761, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "CloseEvent" - }, - "name": "CloseEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 762, - "name": "onerror", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 763, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "signatures": [ - { - "id": 764, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "parameters": [ - { - "id": 765, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 766, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 752, - "name": "onmessage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 753, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "signatures": [ - { - "id": 754, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "parameters": [ - { - "id": 755, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 756, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "MessageEvent" - }, - "name": "MessageEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 747, - "name": "onopen", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 748, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "signatures": [ - { - "id": 749, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "parameters": [ - { - "id": 750, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 751, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 734, - "name": "OPEN", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 3, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L3" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 739, - "name": "protocol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 8, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L8" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 737, - "name": "readyState", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 6, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L6" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 738, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 7, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L7" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 767, - "name": "addEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L27" - } - ], - "signatures": [ - { - "id": 768, - "name": "addEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registers an event listener on the socket (compatible with browser WebSocket API)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L27" - } - ], - "parameters": [ - { - "id": 769, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 770, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 740, - "name": "close", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L13" - } - ], - "signatures": [ - { - "id": 741, - "name": "close", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Closes the socket, optionally providing a close code and reason." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L13" - } - ], - "parameters": [ - { - "id": 742, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 743, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 771, - "name": "removeEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L31" - } - ], - "signatures": [ - { - "id": 772, - "name": "removeEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a previously registered event listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L31" - } - ], - "parameters": [ - { - "id": 773, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 774, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 744, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L17" - } - ], - "signatures": [ - { - "id": 745, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends data through the socket using the underlying implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L17" - } - ], - "parameters": [ - { - "id": 746, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 775, 776, 736, 735, 733, 778, 777, 757, 762, 752, 747, 734, 739, 737, 738 - ] - }, - { - "title": "Methods", - "children": [767, 740, 771, 744] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 1, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L1" - } - ] - }, - { - "id": 782, - "name": "WebSocketLikeConstructor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal WebSocket constructor interface that RealtimeClient can work with.\nSupply a compatible implementation (native WebSocket, " - }, - { - "kind": "code", - "text": "`ws`" - }, - { - "kind": "text", - "text": ", etc) when running outside the browser." - } - ] - }, - "children": [ - { - "id": 783, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 58, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L58" - } - ], - "signatures": [ - { - "id": 784, - "name": "WebSocketLikeConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 59, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L59" - } - ], - "parameters": [ - { - "id": 785, - "name": "address", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 786, - "name": "subprotocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 732, - "name": "WebSocketLike", - "package": "@supabase/realtime-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [783] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 58, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L58" - } - ], - "indexSignatures": [ - { - "id": 787, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 61, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L61" - } - ], - "parameters": [ - { - "id": 788, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 380, - "name": "RealtimeChannelOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L22" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 381, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 382, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L23" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 383, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 384, - "name": "broadcast", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received\nreplay option instructs server to replay broadcast messages" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 387, - "name": "ack", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 388, - "name": "replay", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "ReplayOption" - }, - "name": "ReplayOption", - "package": "@supabase/realtime-js" - } - }, - { - "id": 386, - "name": "self", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [387, 388, 386] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ] - } - } - }, - { - "id": 389, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "key option is used to track presence payload across clients" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 392, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 391, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [392, 391] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ] - } - } - }, - { - "id": 393, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "defines if the channel is private or not and if RLS policies will be used to check data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [384, 389, 393] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 23, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L23" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [382] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 22, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L22" - } - ] - } - } - }, - { - "id": 394, - "name": "RealtimeChannelSendResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 128, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L128" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 395, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 128, - "character": 83, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L128" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 573, - "name": "RealtimeClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 64, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L64" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 574, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 609, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 610, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 82, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L82" - } - ], - "signatures": [ - { - "id": 611, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 591, - "name": "decode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 72, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L72" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - }, - { - "id": 612, - "name": "disconnectOnEmptyChannelsAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 590, - "name": "encode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 71, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L71" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - }, - { - "id": 606, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L79" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/realtime-js" - } - }, - { - "id": 596, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 597, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "indexSignatures": [ - { - "id": 598, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "parameters": [ - { - "id": 599, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 578, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 68, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L68" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 579, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 68, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L68" - } - ], - "signatures": [ - { - "id": 580, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 581, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "HeartbeatStatus" - }, - "name": "HeartbeatStatus", - "package": "@supabase/realtime-js" - } - }, - { - "id": 582, - "name": "latency", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 577, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 604, - "name": "log_level", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 77, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 584, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 70, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L70" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 585, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 70, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L70" - } - ], - "signatures": [ - { - "id": 586, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 587, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 588, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 589, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 605, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 78, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L78" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 600, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 601, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "indexSignatures": [ - { - "id": 602, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "parameters": [ - { - "id": 603, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 592, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L73" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 593, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 73, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L73" - } - ], - "signatures": [ - { - "id": 594, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 595, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - }, - { - "id": 613, - "name": "sessionStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage compatible object used by the underlying socket for longpoll fallback history.\nProvide a custom implementation in environments where reading " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": "\nthrows (sandboxed iframes, in-app webviews, \"block third-party storage\" privacy modes).\nDefaults to " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": " when accessible, otherwise an in-memory store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L90" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - } - }, - { - "id": 576, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 66, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L66" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 575, - "name": "transport", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L65" - } - ], - "type": { - "type": "reference", - "target": 782, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - }, - { - "id": 583, - "name": "vsn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 69, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L69" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 607, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 80, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 608, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 81, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L81" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 609, 591, 612, 590, 606, 596, 578, 577, 604, 584, 605, 600, 592, 613, 576, 575, - 583, 607, 608 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 64, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L64" - } - ] - } - } - }, - { - "id": 614, - "name": "RealtimeMessage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 32, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L32" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 617, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L34" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 620, - "name": "join_ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 618, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L35" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 619, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 616, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [617, 620, 618, 619, 616] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 32, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L32" - } - ] - } - } - }, - { - "id": 621, - "name": "RealtimePostgresChangesFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 109, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L109" - } - ], - "typeParameters": [ - { - "id": 627, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 698, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 623, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of database change to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L113" - } - ], - "type": { - "type": "reference", - "target": 627, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 626, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive database changes when filter is matched." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L125" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 624, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database schema to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 625, - "name": "table", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database table to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L121" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [623, 626, 624, 625] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 109, - "character": 99, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L109" - } - ] - } - } - }, - { - "id": 628, - "name": "RealtimePostgresChangesPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "typeParameters": [ - { - "id": 629, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "indexSignatures": [ - { - "id": 631, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "parameters": [ - { - "id": 632, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 633, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 643, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 652, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 652, - "name": "RealtimePostgresDeletePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "typeParameters": [ - { - "id": 658, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 659, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "indexSignatures": [ - { - "id": 660, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "parameters": [ - { - "id": 661, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 653, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 654, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 99, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L99" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 702, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 655, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 100, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L100" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 100, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L100" - } - ] - } - } - }, - { - "id": 657, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 101, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L101" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 658, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [654, 655, 657] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 98, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L98" - } - ] - } - } - ] - } - }, - { - "id": 633, - "name": "RealtimePostgresInsertPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "typeParameters": [ - { - "id": 639, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 640, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "indexSignatures": [ - { - "id": 641, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "parameters": [ - { - "id": 642, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 634, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 635, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 85, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L85" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 700, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 636, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 86, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L86" - } - ], - "type": { - "type": "reference", - "target": 639, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 637, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 87, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L87" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 638, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 87, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L87" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [635, 636, 637] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 84, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L84" - } - ] - } - } - ] - } - }, - { - "id": 643, - "name": "RealtimePostgresUpdatePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "typeParameters": [ - { - "id": 648, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "indexSignatures": [ - { - "id": 650, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "parameters": [ - { - "id": 651, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 644, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 645, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 92, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L92" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 701, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 646, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 93, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L93" - } - ], - "type": { - "type": "reference", - "target": 648, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 647, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 94, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L94" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 648, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [645, 646, 647] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 91, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L91" - } - ] - } - } - ] - } - }, - { - "id": 662, - "name": "RealtimePresenceJoinPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "typeParameters": [ - { - "id": 668, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 669, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 50, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "indexSignatures": [ - { - "id": 670, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "parameters": [ - { - "id": 671, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 663, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 666, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L20" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 668, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 664, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L18" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 705, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 665, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 667, - "name": "newPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L21" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 668, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [666, 664, 665, 667] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 76, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ] - } - } - }, - { - "id": 672, - "name": "RealtimePresenceLeavePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "typeParameters": [ - { - "id": 678, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 679, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "indexSignatures": [ - { - "id": 680, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "parameters": [ - { - "id": 681, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 673, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 676, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L27" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 678, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 674, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L25" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 706, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 675, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 677, - "name": "leftPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L28" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 678, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [676, 674, 675, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 77, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ] - } - } - }, - { - "id": 682, - "name": "RealtimePresenceState", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "typeParameters": [ - { - "id": 686, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 687, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "indexSignatures": [ - { - "id": 688, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "parameters": [ - { - "id": 689, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 690, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 75, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "indexSignatures": [ - { - "id": 684, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L14" - } - ], - "parameters": [ - { - "id": 685, - "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": 686, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ] - } - } - }, - { - "id": 691, - "name": "RealtimeRemoveChannelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 40, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L40" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 692, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 40, - "character": 85, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L40" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 712, - "name": "REALTIME_CHANNEL_STATES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 151, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L151" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 713, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 714, - "name": "closed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L33" - } - ], - "type": { - "type": "literal", - "value": "closed" - }, - "defaultValue": "'closed'" - }, - { - "id": 715, - "name": "errored", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L34" - } - ], - "type": { - "type": "literal", - "value": "errored" - }, - "defaultValue": "'errored'" - }, - { - "id": 716, - "name": "joined", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L35" - } - ], - "type": { - "type": "literal", - "value": "joined" - }, - "defaultValue": "'joined'" - }, - { - "id": 717, - "name": "joining", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L36" - } - ], - "type": { - "type": "literal", - "value": "joining" - }, - "defaultValue": "'joining'" - }, - { - "id": 718, - "name": "leaving", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L37" - } - ], - "type": { - "type": "literal", - "value": "leaving" - }, - "defaultValue": "'leaving'" - } - ], - "groups": [ - { - "title": "Properties", - "children": [714, 715, 716, 717, 718] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 32, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L32" - } - ] - } - }, - "defaultValue": "CHANNEL_STATES" - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [693, 698, 703, 707] - }, - { - "title": "Classes", - "children": [10, 396, 1, 719] - }, - { - "title": "Interfaces", - "children": [732, 782] - }, - { - "title": "Type Aliases", - "children": [380, 394, 573, 614, 621, 628, 652, 633, 643, 662, 672, 682, 691] - }, - { - "title": "Variables", - "children": [712] - } - ], - "packageName": "@supabase/realtime-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Realtime JS SDK

    \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
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/realtime-js)](https://www.npmjs.com/package/@supabase/realtime-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/realtime-js)](https://pkg.pr.new/~/supabase/realtime-js)\n\n
    \n\n# Overview\n\nThis SDK 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- 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## 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) => console.log(payload))\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 acknowledgment 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\n### Broadcast Replay\n\nBroadcast Replay enables **private** channels to access messages that were sent earlier. Only messages published via [Broadcast From the Database](https://supabase.com/docs/guides/realtime/broadcast#trigger-broadcast-messages-from-your-database) are available for replay.\n\nYou can configure replay with the following options:\n\n- **" - }, - { - "kind": "code", - "text": "`since`" - }, - { - "kind": "text", - "text": "** (Required): The epoch timestamp in milliseconds, specifying the earliest point from which messages should be retrieved.\n- **" - }, - { - "kind": "code", - "text": "`limit`" - }, - { - "kind": "text", - "text": "** (Optional): The number of messages to return. This must be a positive integer, with a maximum value of 25.\n\nExample:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst twelveHours = 12 * 60 * 60 * 1000\nconst twelveHoursAgo = Date.now() - twelveHours\n\nconst config = { private: true, broadcast: { replay: { since: twelveHoursAgo, limit: 10 } } }\n\nsupabase\n .channel('main:room', { config })\n .on('broadcast', { event: 'my_event' }, (payload) => {\n if (payload?.meta?.replayed) {\n console.log('This message was sent earlier:', payload)\n } else {\n console.log('This is a new message', payload)\n }\n // ...\n })\n .subscribe()\n```" - }, - { - "kind": "text", - "text": "\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('presence-test', {\n config: {\n presence: {\n key: '',\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(\n 'postgres_changes',\n { event: 'INSERT', schema: 'public', table: 'messages' },\n (payload) => {\n console.log('All inserts in messages table: ', payload)\n }\n)\n\nchannel.on(\n 'postgres_changes',\n { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' },\n (payload) => {\n console.log('All updates on users table when username is Realtime: ', payload)\n }\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.unsubscribe()\nclient.removeChannel(channel)\n```" - }, - { - "kind": "text", - "text": "\n\n- Remove all channels and close the connection\n\n" - }, - { - "kind": "code", - "text": "```js\n// Setup...\n\nclient.removeAllChannels()\nclient.disconnect()\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build realtime-js\n\n# Build with watch mode for development\npnpm nx build realtime-js --watch\n\n# Individual build targets\npnpm nx build:main realtime-js # CommonJS build (dist/main/)\npnpm nx build:module realtime-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx clean realtime-js # Clean build artifacts\npnpm nx lint realtime-js # Run ESLint\npnpm nx typecheck realtime-js # TypeScript type checking\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\nNote: Unlike some other packages, realtime-js doesn't include a UMD build since it's primarily used in Node.js or bundled applications.\n\n#### Validating Package Exports\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Check if package exports are correctly configured\npnpm nx check-exports realtime-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command uses [\"Are the types wrong?\"](https://github.com/arethetypeswrong/arethetypeswrong.github.io) to verify that the package exports work correctly in different environments. Run this before publishing to ensure your package can be imported correctly by all consumers.\n\n### Testing\n\n**No Docker or Supabase instance required!** The realtime-js tests use mocked WebSocket connections, so they're completely self-contained.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run unit tests (from monorepo root)\npnpm nx test realtime-js\n\n# Run tests with coverage report\npnpm nx test:coverage realtime-js\n\n# Run tests in watch mode during development\npnpm nx test:watch realtime-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Scripts Explained\n\n- **test** - Runs all unit tests once using Vitest\n- **test:coverage** - Runs tests and generates coverage report with terminal output\n- **test:watch** - Runs tests in interactive watch mode for development\n\nThe tests mock WebSocket connections using " - }, - { - "kind": "code", - "text": "`mock-socket`" - }, - { - "kind": "text", - "text": ", so you can run them anytime without any external dependencies.\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\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" - }, - "2": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.__constructor" - }, - "3": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "channel" - }, - "5": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "opts" - }, - "6": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "7": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "9": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.channel" - }, - "10": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "15": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.__constructor" - }, - "16": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "17": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "topic" - }, - "18": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "params" - }, - "19": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "socket" - }, - "20": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.bindings" - }, - "21": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subTopic" - }, - "22": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.broadcastEndpointURL" - }, - "23": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.private" - }, - "24": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presence" - }, - "26": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "27": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "28": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "29": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "state" - }, - "30": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "31": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "32": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "33": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "34": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "35": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "36": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "37": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "38": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.topic" - }, - "39": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.params" - }, - "40": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.socket" - }, - "41": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "42": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "43": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "44": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "45": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "46": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "status" - }, - "47": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "err" - }, - "48": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "63": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "64": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "65": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "66": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "67": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "69": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "71": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "72": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "73": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "74": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "76": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "77": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "78": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "80": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "81": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "82": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "83": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "84": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "86": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "87": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "88": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "89": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "90": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "91": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "92": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "93": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "95": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "96": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "97": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "98": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "100": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "101": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "102": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "103": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "104": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "105": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "106": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "107": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "108": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "109": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "110": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "111": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "113": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "114": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "115": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "116": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "117": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "118": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "119": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "120": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "121": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "122": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "123": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "124": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "126": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "127": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "128": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "129": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "130": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "131": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "132": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "133": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "134": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "135": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "136": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "137": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "139": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "140": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "141": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "142": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "143": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "144": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "145": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "146": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "147": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "148": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "150": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "151": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "152": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "153": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "154": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "155": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "156": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "157": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "158": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "159": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "161": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "162": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "163": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "164": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "165": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "166": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "167": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "168": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "169": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "170": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "172": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "173": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "174": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "175": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "176": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "177": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "178": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "179": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "180": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "181": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "183": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "184": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "185": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "186": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "187": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "188": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "189": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "190": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "191": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "192": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "193": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "194": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "195": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "196": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "197": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "198": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "199": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "200": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "201": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "202": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "203": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "204": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "205": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "207": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "208": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "209": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "210": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "212": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "213": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "214": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "215": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "216": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "217": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "218": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "219": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "220": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "221": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "222": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "223": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "224": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "225": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "226": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "227": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "228": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "229": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "230": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "231": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "232": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "233": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "234": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "235": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "236": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "237": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "238": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "239": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "240": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "241": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "242": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "243": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "244": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "245": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "247": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "248": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "249": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "250": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "251": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "252": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "253": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "254": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "255": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "256": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "257": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "258": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "259": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "260": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "261": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "262": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "264": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "265": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "266": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "267": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "268": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "269": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "270": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "271": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "272": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "273": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "274": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "275": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "276": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "277": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "278": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "279": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "281": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "282": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "283": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "284": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "285": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "286": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "287": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "288": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "289": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "290": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "291": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "292": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "293": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "294": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "295": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "296": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "298": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "299": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "300": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "301": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "302": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "303": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "304": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "305": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "306": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "307": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "event" - }, - "308": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "309": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "310": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "311": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.timeout" - }, - "312": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "313": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "314": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "315": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "316": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.status" - }, - "317": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.error" - }, - "318": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "319": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "320": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "args" - }, - "321": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "322": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "323": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "324": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "325": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "327": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "328": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "329": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "331": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "332": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "333": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "334": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "335": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "336": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "337": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "338": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "369": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "370": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "371": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "other" - }, - "380": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelOptions" - }, - "381": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "382": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.config" - }, - "383": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "384": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.broadcast" - }, - "385": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "386": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.self" - }, - "387": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.ack" - }, - "388": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replay" - }, - "389": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.presence" - }, - "390": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "391": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.key" - }, - "392": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.enabled" - }, - "393": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.private" - }, - "394": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelSendResponse" - }, - "395": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "396": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "397": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.__constructor" - }, - "398": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "399": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "endPoint" - }, - "400": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "options" - }, - "402": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channels" - }, - "403": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.accessTokenValue" - }, - "404": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.accessToken" - }, - "405": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "406": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "407": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.apiKey" - }, - "408": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.httpEndpoint" - }, - "409": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.headers" - }, - "410": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "411": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "413": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.params" - }, - "414": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "415": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "417": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.ref" - }, - "418": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.logLevel" - }, - "419": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.fetch" - }, - "420": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "421": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "422": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "423": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "424": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "425": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "426": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "427": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.worker" - }, - "428": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.workerUrl" - }, - "429": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.workerRef" - }, - "430": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.serializer" - }, - "431": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "432": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "433": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "434": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "435": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "436": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "437": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "438": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "439": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "440": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "441": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "442": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "443": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "444": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "445": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "446": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "447": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "448": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "449": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "450": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "451": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "452": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "453": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "454": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "455": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "456": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "457": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "tries" - }, - "458": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "459": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "460": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "461": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "462": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "463": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "464": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "465": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.open" - }, - "466": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.close" - }, - "467": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.error" - }, - "468": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.message" - }, - "475": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "476": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "477": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "478": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "479": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "480": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "481": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "code" - }, - "482": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "reason" - }, - "483": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "484": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "485": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "486": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "487": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "channel" - }, - "488": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "489": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "490": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "491": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "492": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "493": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "494": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "495": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "496": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "497": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "498": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "499": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "500": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "501": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "502": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "503": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "504": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "505": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "topic" - }, - "506": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "params" - }, - "507": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "508": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "509": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "510": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "511": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "512": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "token" - }, - "515": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "516": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "517": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "518": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "519": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "callback" - }, - "573": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeClientOptions" - }, - "574": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "575": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.transport" - }, - "576": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.timeout" - }, - "577": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatIntervalMs" - }, - "578": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatCallback" - }, - "579": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "580": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "581": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "status" - }, - "582": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "latency" - }, - "583": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.vsn" - }, - "584": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.logger" - }, - "585": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "586": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "587": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "588": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "589": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "590": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.encode" - }, - "591": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.decode" - }, - "592": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.reconnectAfterMs" - }, - "593": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "594": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "595": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "596": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.headers" - }, - "597": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "598": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "600": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.params" - }, - "601": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "602": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "604": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.log_level" - }, - "605": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.logLevel" - }, - "606": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.fetch" - }, - "607": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.worker" - }, - "608": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.workerUrl" - }, - "609": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.accessToken" - }, - "610": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "611": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "612": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.disconnectOnEmptyChannelsAfterMs" - }, - "613": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.sessionStorage" - }, - "614": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeMessage" - }, - "615": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.topic" - }, - "617": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.event" - }, - "618": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.payload" - }, - "619": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.ref" - }, - "620": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.join_ref" - }, - "621": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesFilter" - }, - "622": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "623": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "624": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.schema" - }, - "625": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.table" - }, - "626": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.filter" - }, - "627": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "628": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayload" - }, - "629": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "630": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "631": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "633": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresInsertPayload" - }, - "634": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "635": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "636": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "637": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "638": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "639": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "640": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "641": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "643": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresUpdatePayload" - }, - "644": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "645": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "646": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "647": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "648": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "649": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "650": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "652": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresDeletePayload" - }, - "653": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "654": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "655": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "656": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "657": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "658": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "659": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "660": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "662": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceJoinPayload" - }, - "663": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "664": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "665": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "666": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "667": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.newPresences" - }, - "668": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "669": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "670": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "672": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceLeavePayload" - }, - "673": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "674": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "675": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "676": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "677": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.leftPresences" - }, - "678": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "679": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "680": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "682": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceState" - }, - "683": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "684": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "686": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "687": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "688": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "690": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "691": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeRemoveChannelResponse" - }, - "692": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "693": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES" - }, - "694": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" - }, - "695": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" - }, - "696": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" - }, - "697": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" - }, - "698": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "699": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - }, - "700": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "701": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "702": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "703": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" - }, - "704": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" - }, - "705": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "706": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "707": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES" - }, - "708": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" - }, - "709": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" - }, - "710": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" - }, - "711": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" - }, - "712": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_CHANNEL_STATES" - }, - "713": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object" - }, - "714": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.closed" - }, - "715": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.errored" - }, - "716": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.joined" - }, - "717": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.joining" - }, - "718": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.leaving" - }, - "719": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory" - }, - "722": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "723": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "724": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "725": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "726": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "url" - }, - "727": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "protocols" - }, - "728": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "729": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "732": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike" - }, - "733": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CONNECTING" - }, - "734": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.OPEN" - }, - "735": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSING" - }, - "736": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSED" - }, - "737": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.readyState" - }, - "738": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.url" - }, - "739": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.protocol" - }, - "740": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "741": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "742": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "code" - }, - "743": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "reason" - }, - "744": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "745": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "746": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "data" - }, - "747": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onopen" - }, - "748": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "749": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "750": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "751": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "752": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onmessage" - }, - "753": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "754": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "755": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "756": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "757": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onclose" - }, - "758": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "760": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "761": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "762": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onerror" - }, - "763": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "765": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "766": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "767": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "768": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "769": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "770": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "771": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "772": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "773": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "774": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "775": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.binaryType" - }, - "776": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.bufferedAmount" - }, - "777": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.extensions" - }, - "778": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.dispatchEvent" - }, - "779": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "780": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "781": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "event" - }, - "782": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "783": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "784": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "785": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "address" - }, - "786": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "subprotocols" - }, - "787": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor.__index" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } - }, - { - "id": 0, - "name": "@supabase/storage-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1, - "name": "index", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 1456, - "name": "StorageVectorsErrorCode", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error codes specific to S3 Vectors API\nMaps AWS service errors to application-friendly error codes" - } - ] - }, - "children": [ - { - "id": 1457, - "name": "InternalError", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Internal server fault (HTTP 500)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 149, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L149" - } - ], - "type": { - "type": "literal", - "value": "InternalError" - } - }, - { - "id": 1460, - "name": "S3VectorBucketNotEmpty", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete bucket while not empty (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L155" - } - ], - "type": { - "type": "literal", - "value": "S3VectorBucketNotEmpty" - } - }, - { - "id": 1458, - "name": "S3VectorConflictException", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource already exists / conflict (HTTP 409)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L151" - } - ], - "type": { - "type": "literal", - "value": "S3VectorConflictException" - } - }, - { - "id": 1461, - "name": "S3VectorMaxBucketsExceeded", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exceeds bucket quota/limit (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 157, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L157" - } - ], - "type": { - "type": "literal", - "value": "S3VectorMaxBucketsExceeded" - } - }, - { - "id": 1462, - "name": "S3VectorMaxIndexesExceeded", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exceeds index quota/limit (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 159, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L159" - } - ], - "type": { - "type": "literal", - "value": "S3VectorMaxIndexesExceeded" - } - }, - { - "id": 1459, - "name": "S3VectorNotFoundException", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource not found (HTTP 404)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L153" - } - ], - "type": { - "type": "literal", - "value": "S3VectorNotFoundException" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [1457, 1460, 1458, 1461, 1462, 1459] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 147, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L147" - } - ] - }, - { - "id": 1371, - "name": "StorageApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "API error returned from Storage service\nIncludes HTTP status code and service-specific error code" - } - ] - }, - "children": [ - { - "id": 1372, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L62" - } - ], - "signatures": [ - { - "id": 1373, - "name": "StorageApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L62" - } - ], - "parameters": [ - { - "id": 1374, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1375, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1376, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1377, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - } - ], - "type": { - "type": "reference", - "target": 1371, - "name": "StorageApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1378, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 59, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1379, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 60, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L60" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1380, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "signatures": [ - { - "id": 1381, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1382, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1384, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 76, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L76" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1383, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 75, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1385, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 77, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L77" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1386, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 78, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L78" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1384, 1383, 1385, 1386] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1372] - }, - { - "title": "Properties", - "children": [1378, 1379] - }, - { - "title": "Methods", - "children": [1380] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 58, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L58" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1422, - "name": "StorageVectorsApiError" - } - ] - }, - { - "id": 984, - "name": "StorageClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 985, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L36" - } - ], - "signatures": [ - { - "id": 986, - "name": "StorageClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a client for Storage buckets, files, analytics, and vectors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst avatars = supabase.storage.from('avatars')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {\n apikey: 'your-publishable-key',\n})\nconst avatars = storage.from('avatars')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L36" - } - ], - "parameters": [ - { - "id": 987, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 988, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 989, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 38, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L38" - } - ], - "indexSignatures": [ - { - "id": 990, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 38, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L38" - } - ], - "parameters": [ - { - "id": 991, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 992, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 993, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 994, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 995, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 996, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 997, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 998, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 999, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1000, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1112, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 984, - "name": "StorageClient", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 138, - "name": "default.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 137, - "name": "default.constructor" - } - }, - { - "id": 1006, - "name": "analytics", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 95, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L95" - } - ], - "getSignature": { - "id": 1007, - "name": "analytics", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access analytics storage operations using Iceberg tables.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A StorageAnalyticsClient instance configured with the current storage settings." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 95, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L95" - } - ], - "type": { - "type": "reference", - "target": 48, - "name": "StorageAnalyticsClient", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1004, - "name": "vectors", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L75" - } - ], - "getSignature": { - "id": 1005, - "name": "vectors", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access vector storage operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A StorageVectorsClient instance configured with the current storage settings." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L75" - } - ], - "type": { - "type": "reference", - "target": 549, - "name": "StorageVectorsClient", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1026, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "signatures": [ - { - "id": 1027, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created bucket name or error" - } - ] - }, - { - "tag": "@example", - "name": "Create bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "parameters": [ - { - "id": 1028, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are creating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1029, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1030, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1033, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L193" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1032, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 192, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L192" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1031, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 191, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1034, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "(private-beta) specifies the bucket type. see " - }, - { - "kind": "code", - "text": "`BucketType`" - }, - { - "kind": "text", - "text": " for more details.\n - default bucket type is " - }, - { - "kind": "code", - "text": "`STANDARD`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1033, 1032, 1031, 1034] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1035, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1036, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 200, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "name" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1037, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 201, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1036, 1037] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 199, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L199" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1039, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 204, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1040, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1039, 1040] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 203, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 172, - "name": "default.createBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 171, - "name": "default.createBucket" - } - }, - { - "id": 1068, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "signatures": [ - { - "id": 1069, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " - }, - { - "kind": "code", - "text": "`empty()`" - }, - { - "kind": "text", - "text": " the bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "parameters": [ - { - "id": 1070, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1071, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1072, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1074, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1074] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ] - } - } - }, - { - "id": 1075, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L381" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1072, 1075] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1076, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1077, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 384, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L384" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1078, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L385" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1077, 1078] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 383, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L383" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 214, - "name": "default.deleteBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 213, - "name": "default.deleteBucket" - } - }, - { - "id": 1057, - "name": "emptyBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "signatures": [ - { - "id": 1058, - "name": "emptyBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes all objects inside a single bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Empty bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "parameters": [ - { - "id": 1059, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to empty." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1060, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1061, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1062, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1063, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1063] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ] - } - } - }, - { - "id": 1064, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L334" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1061, 1064] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 332, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1065, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1066, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L337" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1067, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 338, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L338" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1066, 1067] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 336, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L336" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 203, - "name": "default.emptyBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 202, - "name": "default.emptyBucket" - } - }, - { - "id": 1001, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L58" - } - ], - "signatures": [ - { - "id": 1002, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform file operation in a bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Accessing a bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst avatars = supabase.storage.from('avatars')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L58" - } - ], - "parameters": [ - { - "id": 1003, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The bucket id to operate on." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 261, - "name": "StorageFileApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1017, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "signatures": [ - { - "id": 1018, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing Storage bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing bucket details or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "parameters": [ - { - "id": 1019, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to retrieve." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1020, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1021, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 131, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L131" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 1022, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 132, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1021, 1022] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 130, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1023, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1024, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L135" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1025, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 136, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L136" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1024, 1025] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 134, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 163, - "name": "default.getBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 162, - "name": "default.getBucket" - } - }, - { - "id": 1008, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "signatures": [ - { - "id": 1009, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Storage buckets within an existing project." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "List buckets with options", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "parameters": [ - { - "id": 1010, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reference", - "target": 1135, - "name": "ListBucketOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "limit": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ], - "offset": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ], - "sortColumn": [ - { - "kind": "text", - "text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')" - } - ], - "sortOrder": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ], - "search": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1011, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1012, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1013, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L74" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1012, 1013] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 72, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1014, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1015, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 77, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1016, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 78, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1015, 1016] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 154, - "name": "default.listBuckets" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 153, - "name": "default.listBuckets" - } - }, - { - "id": 1096, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 1097, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 1098, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1099, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 245, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 244, - "name": "default.setHeader" - } - }, - { - "id": 1094, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 1095, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 243, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 242, - "name": "default.throwOnError" - } - }, - { - "id": 1041, - "name": "updateBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "signatures": [ - { - "id": 1042, - "name": "updateBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Update bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "parameters": [ - { - "id": 1043, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are updating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1044, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1045, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1048, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 272, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1047, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 271, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1046, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 270, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L270" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1048, 1047, 1046] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 269, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L269" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1050, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1051, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1052, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1052] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ] - } - } - }, - { - "id": 1053, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1050, 1053] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1054, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1055, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 280, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L280" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1056, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 281, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L281" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1055, 1056] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L279" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 187, - "name": "default.updateBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 186, - "name": "default.updateBucket" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [985] - }, - { - "title": "Accessors", - "children": [1006, 1004] - }, - { - "title": "Methods", - "children": [1026, 1068, 1057, 1001, 1017, 1008, 1096, 1094, 1041] - } - ], - "categories": [ - { - "title": "Other", - "children": [1096, 1094] - }, - { - "title": "Storage", - "children": [985, 1006, 1004, 1026, 1068, 1057, 1001, 1017, 1008, 1041] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L11" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 136, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1353, - "name": "StorageError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error class for all Storage errors\nSupports both 'storage' and 'vectors' namespaces" - } - ] - }, - "children": [ - { - "id": 1354, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L17" - } - ], - "signatures": [ - { - "id": 1355, - "name": "StorageError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L17" - } - ], - "parameters": [ - { - "id": 1356, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1357, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - }, - { - "id": 1358, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1359, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 1362, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1363, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1364, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1365, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1368, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1367, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1369, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1370, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1368, 1367, 1369, 1370] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1354] - }, - { - "title": "Properties", - "children": [1362, 1363] - }, - { - "title": "Methods", - "children": [1364] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L11" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1371, - "name": "StorageApiError" - }, - { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError" - }, - { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError" - } - ] - }, - { - "id": 1389, - "name": "StorageUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unknown error that doesn't match expected error patterns\nWraps the original error for debugging" - } - ] - }, - "children": [ - { - "id": 1390, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L93" - } - ], - "signatures": [ - { - "id": 1391, - "name": "StorageUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L93" - } - ], - "parameters": [ - { - "id": 1392, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1393, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1394, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - } - ], - "type": { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1395, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 91, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L91" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1398, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1399, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1400, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1401, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1404, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1403, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1405, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1406, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1404, 1403, 1405, 1406] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1390] - }, - { - "title": "Properties", - "children": [1395, 1398, 1399] - }, - { - "title": "Methods", - "children": [1400] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 90, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L90" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1439, - "name": "StorageVectorsUnknownError" - } - ] - }, - { - "id": 1422, - "name": "StorageVectorsApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageApiError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1423, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L128" - } - ], - "signatures": [ - { - "id": 1424, - "name": "StorageVectorsApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L128" - } - ], - "parameters": [ - { - "id": 1425, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1426, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1427, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1422, - "name": "StorageVectorsApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1373, - "name": "StorageApiError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1372, - "name": "StorageApiError.constructor" - } - }, - { - "id": 1428, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 59, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1378, - "name": "StorageApiError.status" - } - }, - { - "id": 1429, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 60, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L60" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1379, - "name": "StorageApiError.statusCode" - } - }, - { - "id": 1430, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "signatures": [ - { - "id": 1431, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1432, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1434, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 76, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L76" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1433, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 75, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1435, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 77, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L77" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1436, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 78, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L78" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1434, 1433, 1435, 1436] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1381, - "name": "StorageApiError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1380, - "name": "StorageApiError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1423] - }, - { - "title": "Properties", - "children": [1428, 1429] - }, - { - "title": "Methods", - "children": [1430] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 127, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L127" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1371, - "name": "StorageApiError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1407, - "name": "StorageVectorsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1408, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L109" - } - ], - "signatures": [ - { - "id": 1409, - "name": "StorageVectorsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L109" - } - ], - "parameters": [ - { - "id": 1410, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1413, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1414, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1415, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1416, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1417, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1419, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1418, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1420, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1421, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1419, 1418, 1420, 1421] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1408] - }, - { - "title": "Properties", - "children": [1413, 1414] - }, - { - "title": "Methods", - "children": [1415] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 108, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L108" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1439, - "name": "StorageVectorsUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageUnknownError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1440, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L138" - } - ], - "signatures": [ - { - "id": 1441, - "name": "StorageVectorsUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L138" - } - ], - "parameters": [ - { - "id": 1442, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1443, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 1439, - "name": "StorageVectorsUnknownError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1391, - "name": "StorageUnknownError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1390, - "name": "StorageUnknownError.constructor" - } - }, - { - "id": 1444, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 91, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L91" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 1395, - "name": "StorageUnknownError.originalError" - } - }, - { - "id": 1447, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1398, - "name": "StorageUnknownError.status" - } - }, - { - "id": 1448, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1399, - "name": "StorageUnknownError.statusCode" - } - }, - { - "id": 1449, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1450, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1451, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1453, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1452, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1454, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1455, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1453, 1452, 1454, 1455] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1401, - "name": "StorageUnknownError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1400, - "name": "StorageUnknownError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1440] - }, - { - "title": "Properties", - "children": [1444, 1447, 1448] - }, - { - "title": "Methods", - "children": [1449] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 137, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L137" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1141, - "name": "AnalyticBucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents an Analytics Bucket using Apache Iceberg table format.\nAnalytics buckets are optimized for analytical queries and data processing." - } - ] - }, - "children": [ - { - "id": 1145, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ISO 8601 timestamp of bucket creation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 42, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L42" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1144, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage format used (e.g., 'iceberg')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 40, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L40" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1142, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1143, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bucket type - always 'ANALYTICS' for analytics buckets" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L38" - } - ], - "type": { - "type": "literal", - "value": "ANALYTICS" - } - }, - { - "id": 1146, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ISO 8601 timestamp of last update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1145, 1144, 1142, 1143, 1146] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 34, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L34" - } - ] - }, - { - "id": 1125, - "name": "Bucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1131, - "name": "allowed_mime_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 16, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L16" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1132, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L17" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1130, - "name": "file_size_limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L15" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1126, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 11, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1128, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1129, - "name": "owner", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1134, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1127, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L12" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - }, - { - "id": 1133, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L18" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1131, 1132, 1130, 1126, 1128, 1129, 1134, 1127, 1133] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 10, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L10" - } - ] - }, - { - "id": 1307, - "name": "DeleteVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch deleting vectors" - } - ] - }, - "children": [ - { - "id": 1309, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L549" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1310, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector keys to delete (1-500 items)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L550" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1308, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L548" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1309, 1310, 1308] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 547, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L547" - } - ] - }, - { - "id": 1190, - "name": "DestinationOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1191, - "name": "destinationBucket", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 176, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L176" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1191] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 175, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L175" - } - ] - }, - { - "id": 1243, - "name": "EncryptionConfiguration", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration for encryption at rest" - } - ] - }, - "children": [ - { - "id": 1244, - "name": "kmsKeyArn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ARN of the KMS key used for encryption" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 362, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L362" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1245, - "name": "sseType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server-side encryption type (e.g., 'KMS')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 363, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L363" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1244, 1245] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 361, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L361" - } - ] - }, - { - "id": 1341, - "name": "ErrorResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Standard response wrapper for failed operations" - } - ] - }, - "children": [ - { - "id": 1342, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Null on error" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 646, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L646" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1343, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "StorageError with details (named StorageVectorsError for vector operations)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 647, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L647" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1342, 1343] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 645, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L645" - } - ] - }, - { - "id": 1222, - "name": "FetchParameters", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1224, - "name": "cache", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Controls how the request interacts with the browser's HTTP cache.\n- 'default': Use standard cache behavior\n- 'no-store': Bypass cache entirely (useful in Edge Functions)\n- 'reload': Bypass cache but update it with response\n- 'no-cache': Validate with server before using cached response\n- 'force-cache': Use cache even if stale\n- 'only-if-cached': Only use cache, fail if not cached" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 296, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L296" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "default" - }, - { - "type": "literal", - "value": "no-store" - }, - { - "type": "literal", - "value": "reload" - }, - { - "type": "literal", - "value": "no-cache" - }, - { - "type": "literal", - "value": "force-cache" - }, - { - "type": "literal", - "value": "only-if-cached" - } - ] - } - }, - { - "id": 1223, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pass in an AbortController's signal to cancel the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 285, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L285" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1224, 1223] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 281, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L281" - } - ] - }, - { - "id": 1147, - "name": "FileMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata object returned by the Storage API for files\nContains information about file size, type, caching, and HTTP response details" - } - ] - }, - "children": [ - { - "id": 1151, - "name": "cacheControl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cache control directive (e.g., \"max-age=3600\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 59, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1153, - "name": "contentLength", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Content length in bytes (usually same as size)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 63, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L63" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1148, - "name": "eTag", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Entity tag for caching and conditional requests" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 53, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L53" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1154, - "name": "httpStatusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code from the storage backend" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L65" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1152, - "name": "lastModified", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last modification timestamp (ISO 8601)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 61, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L61" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1150, - "name": "mimetype", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "MIME type of the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 57, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L57" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1149, - "name": "size", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File size in bytes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L55" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1151, 1153, 1148, 1154, 1152, 1150, 1149] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 51, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L51" - } - ], - "indexSignatures": [ - { - "id": 1155, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Any additional custom metadata stored with the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L67" - } - ], - "parameters": [ - { - "id": 1156, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1157, - "name": "FileObject", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the List V1 API (list() method)\nNote: Folder entries will have null values for most fields except name\n\nWarning: Some fields may not be present in all API responses. Fields like\nbucket_id, owner, and buckets are not returned by list() operations." - } - ] - }, - "children": [ - { - "id": 1164, - "name": "bucket_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Bucket identifier - NOT returned by list() operations.\nMay be present in remove() responses. Do not rely on this field." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L94" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1166, - "name": "buckets", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Bucket object - NOT returned by list() or remove() operations.\nThis field should not be relied upon." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 104, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L104" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 1161, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 85, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L85" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1159, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 81, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L81" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1162, - "name": "last_accessed_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Last access timestamp (null for folders)" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 87, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L87" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1163, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File metadata including size, mimetype, etc. (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 89, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L89" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1158, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File or folder name (relative to the prefix) - always present" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1165, - "name": "owner", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Owner identifier - NOT returned by list() or remove() operations.\nThis field should not be relied upon." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 99, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L99" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1160, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last update timestamp (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L83" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1164, 1166, 1161, 1159, 1162, 1163, 1158, 1165, 1160] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 77, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L77" - } - ] - }, - { - "id": 1167, - "name": "FileObjectV2", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the Info endpoint (info() method)\nContains detailed metadata for a specific file" - } - ] - }, - "children": [ - { - "id": 1171, - "name": "bucket_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bucket identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 119, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1174, - "name": "cache_control", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cache control header value" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L125" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1175, - "name": "content_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "MIME content type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 127, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L127" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1172, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L121" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1176, - "name": "etag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Entity tag for caching" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L129" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1168, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1177, - "name": "last_modified", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last modification timestamp (replaces updated_at)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 131, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1178, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom file metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 133, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L133" - } - ], - "type": { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - }, - { - "id": 1170, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1173, - "name": "size", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File size in bytes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1179, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The API returns last_modified instead.\nThis field may not be present in responses." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L138" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1169, - "name": "version", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File version identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1171, 1174, 1175, 1172, 1176, 1168, 1177, 1178, 1170, 1173, 1179, 1169 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 111, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L111" - } - ] - }, - { - "id": 1183, - "name": "FileOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1184, - "name": "cacheControl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " - }, - { - "kind": "code", - "text": "`Cache-Control: max-age=`" - }, - { - "kind": "text", - "text": " header. Defaults to 3600 seconds." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 150, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L150" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1185, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header value. Should be specified if using a " - }, - { - "kind": "code", - "text": "`fileBody`" - }, - { - "kind": "text", - "text": " that is neither " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": " nor " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " nor " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": ", otherwise will default to " - }, - { - "kind": "code", - "text": "`text/plain;charset=UTF-8`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 154, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L154" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1187, - "name": "duplex", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 162, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1189, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optionally add extra headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 172, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L172" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1188, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 167, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L167" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1186, - "name": "upsert", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L158" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1184, 1185, 1187, 1189, 1188, 1186] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 146, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L146" - } - ] - }, - { - "id": 1295, - "name": "GetVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch reading vectors" - } - ] - }, - "children": [ - { - "id": 1297, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L515" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1298, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector keys to retrieve" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L516" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1299, - "name": "returnData", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include vector data in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L517" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1300, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 518, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L518" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1296, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 514, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L514" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1297, 1298, 1299, 1300, 1296] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 513, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L513" - } - ] - }, - { - "id": 1301, - "name": "GetVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from getting vectors" - } - ] - }, - "children": [ - { - "id": 1302, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of retrieved vector objects" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 526, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L526" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1302] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 525, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L525" - } - ] - }, - { - "id": 1135, - "name": "ListBucketOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1136, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L23" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1137, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1140, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L27" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1138, - "name": "sortColumn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L25" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "id" - }, - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 1139, - "name": "sortOrder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L26" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1136, 1137, 1140, 1138, 1139] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 22, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L22" - } - ] - }, - { - "id": 1285, - "name": "ListIndexesOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing indexes within a bucket" - } - ] - }, - "children": [ - { - "id": 1288, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 100)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L491" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1289, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 492, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1287, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter indexes by name prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1286, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the parent vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 489, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L489" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1288, 1289, 1287, 1286] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 488, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L488" - } - ] - }, - { - "id": 1290, - "name": "ListIndexesResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing indexes" - } - ] - }, - "children": [ - { - "id": 1291, - "name": "indexes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of index names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1292, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1293, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1293] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ] - } - } - } - }, - { - "id": 1294, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 502, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L502" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1291, 1294] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 500, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L500" - } - ] - }, - { - "id": 1276, - "name": "ListVectorBucketsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for fetching vector buckets" - } - ] - }, - "children": [ - { - "id": 1278, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 100)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 467, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L467" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1279, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L468" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1277, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter buckets by name prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 466, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L466" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1278, 1279, 1277] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 465, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L465" - } - ] - }, - { - "id": 1280, - "name": "ListVectorBucketsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing vector buckets" - } - ] - }, - "children": [ - { - "id": 1284, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1281, - "name": "vectorBuckets", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of bucket names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1282, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1283, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1283] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1284, 1281] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 476, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L476" - } - ] - }, - { - "id": 1311, - "name": "ListVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing/scanning vectors in an index\nSupports parallel scanning via segment configuration" - } - ] - }, - "children": [ - { - "id": 1313, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 567, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L567" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1314, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 500, max: 1000)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 568, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L568" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1315, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 569, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L569" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1316, - "name": "returnData", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include vector data in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L570" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1317, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L571" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1318, - "name": "segmentCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of parallel segments (1-16)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 572, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L572" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1319, - "name": "segmentIndex", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Zero-based index of this segment (0 to segmentCount-1)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 573, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L573" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1312, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L566" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1313, 1314, 1315, 1316, 1317, 1318, 1319, 1312] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 565, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L565" - } - ] - }, - { - "id": 1320, - "name": "ListVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing vectors" - } - ] - }, - "children": [ - { - "id": 1322, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 583, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L583" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1321, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector objects" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 582, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L582" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1322, 1321] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 581, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L581" - } - ] - }, - { - "id": 1225, - "name": "Metadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1226, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1226] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 300, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L300" - } - ] - }, - { - "id": 1250, - "name": "MetadataConfiguration", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata configuration for vector index\nDefines which metadata keys should not be indexed for filtering" - } - ] - }, - "children": [ - { - "id": 1251, - "name": "nonFilterableMetadataKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of metadata keys that cannot be used in filters" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 384, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L384" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1251] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 383, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L383" - } - ] - }, - { - "id": 1303, - "name": "PutVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch inserting/updating vectors" - } - ] - }, - "children": [ - { - "id": 1305, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 537, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L537" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1304, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L536" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1306, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vectors to insert/upsert (1-500 items)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 538, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L538" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1267, - "name": "VectorObject", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1305, 1304, 1306] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 535, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L535" - } - ] - }, - { - "id": 1324, - "name": "QueryVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for querying similar vectors (ANN search)" - } - ] - }, - "children": [ - { - "id": 1329, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional JSON filter for metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 607, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L607" - } - ], - "type": { - "type": "reference", - "target": 1323, - "name": "VectorFilter", - "package": "@supabase/storage-js" - } - }, - { - "id": 1326, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 604, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L604" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1327, - "name": "queryVector", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query vector to find similar vectors" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L605" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1330, - "name": "returnDistance", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include distance scores" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 608, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L608" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1331, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in results" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 609, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L609" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1328, - "name": "topK", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of nearest neighbors to return (default: 10)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 606, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L606" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1325, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 603, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L603" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1329, 1326, 1327, 1330, 1331, 1328, 1325] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 602, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L602" - } - ] - }, - { - "id": 1332, - "name": "QueryVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from vector similarity query" - } - ] - }, - "children": [ - { - "id": 1334, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The distance metric used for the similarity search" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 619, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L619" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 1333, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of similar vectors ordered by distance" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L618" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1334, 1333] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 617, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L617" - } - ] - }, - { - "id": 1192, - "name": "SearchOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1193, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of files you want to be returned." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n100\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 184, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L184" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1194, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 189, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L189" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1196, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The search string to filter files by." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1195, - "name": "sortBy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to sort by. Can be any column inside a FileObject." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 194, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1180, - "name": "SortBy", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1193, 1194, 1196, 1195] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 179, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L179" - } - ] - }, - { - "id": 1214, - "name": "SearchV2Folder", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Folder entry returned by the List V2 API (listV2() method) when using with_delimiter: true" - } - ] - }, - "children": [ - { - "id": 1216, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full folder key/path" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 271, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L271" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1215, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Folder name/prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 269, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L269" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1216, 1215] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 267, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L267" - } - ] - }, - { - "id": 1206, - "name": "SearchV2Object", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the List V2 API (listV2() method)\nObjects and folders are returned in separate arrays - this type represents\nactual files only. Use SearchV2Folder for folder entries." - } - ] - }, - "children": [ - { - "id": 1211, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 257, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L257" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1209, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 253, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L253" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1208, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full object key/path" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 251, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L251" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1213, - "name": "last_accessed_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Last access timestamp" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L261" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1212, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File metadata including size, mimetype, etc. (null if not yet set)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 259, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L259" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1207, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L249" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1210, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last update timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 255, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L255" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1211, 1209, 1208, 1213, 1212, 1207, 1210] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 247, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L247" - } - ] - }, - { - "id": 1200, - "name": "SearchV2Options", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1203, - "name": "cursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cursor used for pagination. Pass the value received from nextCursor of the previous request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 222, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1201, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of files you want to be returned." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n1000\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 212, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L212" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1202, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix search string to filter files by." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 217, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L217" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1205, - "name": "sortBy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column and order to sort by" - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n'name asc'\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 239, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L239" - } - ], - "type": { - "type": "reference", - "target": 1197, - "name": "SortByV2", - "package": "@supabase/storage-js" - } - }, - { - "id": 1204, - "name": "with_delimiter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to emulate a hierarchical listing of objects using delimiters.\n\n- When " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " (default), all objects are listed as flat key/value pairs.\n- When " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the response groups objects by delimiter, making it appear\n like a file/folder hierarchy." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 233, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L233" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1203, 1201, 1202, 1205, 1204] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 207, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L207" - } - ] - }, - { - "id": 1217, - "name": "SearchV2Result", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1219, - "name": "folders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 276, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L276" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1214, - "name": "SearchV2Folder", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1218, - "name": "hasNext", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 275, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L275" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1221, - "name": "nextCursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 278, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L278" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1220, - "name": "objects", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L277" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1206, - "name": "SearchV2Object", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1219, 1218, 1221, 1220] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 274, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L274" - } - ] - }, - { - "id": 1180, - "name": "SortBy", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1181, - "name": "column", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L142" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 143, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L143" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1181, 1182] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 141, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L141" - } - ] - }, - { - "id": 1197, - "name": "SortByV2", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1198, - "name": "column", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 203, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L203" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 1199, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 204, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L204" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1198, 1199] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 202, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L202" - } - ] - }, - { - "id": 1112, - "name": "StorageClientOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1113, - "name": "useNewHostname", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L8" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 7, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L7" - } - ] - }, - { - "id": 1337, - "name": "SuccessResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Standard response wrapper for successful operations" - } - ] - }, - "children": [ - { - "id": 1338, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response data of type T" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 636, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L636" - } - ], - "type": { - "type": "reference", - "target": 1340, - "name": "T", - "package": "@supabase/storage-js", - "qualifiedName": "SuccessResponse.T", - "refersToTypeParameter": true - } - }, - { - "id": 1339, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Null on success" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 637, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L637" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1338, 1339] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L635" - } - ], - "typeParameters": [ - { - "id": 1340, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ] - }, - { - "id": 1227, - "name": "TransformOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1232, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 332, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L332" - } - ], - "type": { - "type": "literal", - "value": "origin" - } - }, - { - "id": 1229, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the image in pixels." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 312, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L312" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1231, - "name": "quality", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 325, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L325" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1230, - "name": "resize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 319, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L319" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "cover" - }, - { - "type": "literal", - "value": "contain" - }, - { - "type": "literal", - "value": "fill" - } - ] - } - }, - { - "id": 1228, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the image in pixels." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1232, 1229, 1231, 1230, 1228] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 304, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L304" - } - ] - }, - { - "id": 1246, - "name": "VectorBucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector bucket metadata" - } - ] - }, - "children": [ - { - "id": 1248, - "name": "creationTime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unix timestamp of when the bucket was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L374" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1249, - "name": "encryptionConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional encryption settings" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 375, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L375" - } - ], - "type": { - "type": "reference", - "target": 1243, - "name": "EncryptionConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 1247, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 373, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L373" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1248, 1249, 1247] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 372, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L372" - } - ] - }, - { - "id": 1264, - "name": "VectorData", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector data representation\nVectors must be float32 arrays with dimensions matching the index" - } - ] - }, - "children": [ - { - "id": 1265, - "name": "float32", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of 32-bit floating point numbers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L424" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "number" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1265] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 423, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L423" - } - ] - }, - { - "id": 1335, - "name": "VectorFetchParameters", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fetch-specific parameters like abort signals" - } - ] - }, - "children": [ - { - "id": 1336, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AbortSignal for cancelling requests" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 627, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L627" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1336] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 626, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L626" - } - ] - }, - { - "id": 1256, - "name": "VectorIndex", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector index configuration and metadata" - } - ] - }, - "children": [ - { - "id": 1263, - "name": "creationTime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unix timestamp of when the index was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L415" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1259, - "name": "dataType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data type of vector components (currently only 'float32')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L411" - } - ], - "type": { - "type": "reference", - "target": 1252, - "name": "VectorDataType", - "package": "@supabase/storage-js" - } - }, - { - "id": 1260, - "name": "dimension", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Dimensionality of vectors (e.g., 384, 768, 1536)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 412, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L412" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1261, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Similarity metric used for queries" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 413, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L413" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 1257, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name of the index within the bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L409" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1262, - "name": "metadataConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration for metadata filtering" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 414, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L414" - } - ], - "type": { - "type": "reference", - "target": 1250, - "name": "MetadataConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 1258, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the parent vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L410" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1263, 1259, 1260, 1261, 1257, 1262, 1258] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 408, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L408" - } - ] - }, - { - "id": 1271, - "name": "VectorMatch", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector object returned from queries with optional distance" - } - ] - }, - "children": [ - { - "id": 1273, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector embedding data (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 454, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L454" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1275, - "name": "distance", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Similarity distance from query vector (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1272, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the vector" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1274, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arbitrary metadata (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 455, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L455" - } - ], - "type": { - "type": "reference", - "target": 1266, - "name": "VectorMetadata", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1273, 1275, 1272, 1274] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 452, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L452" - } - ] - }, - { - "id": 1267, - "name": "VectorObject", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Single vector object for insertion/update" - } - ] - }, - "children": [ - { - "id": 1269, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector embedding data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 441, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L441" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1268, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the vector" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 440, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L440" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1270, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional arbitrary metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 442, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L442" - } - ], - "type": { - "type": "reference", - "target": 1266, - "name": "VectorMetadata", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1269, 1268, 1270] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 439, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L439" - } - ] - }, - { - "id": 1344, - "name": "ApiResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Union type for all API responses\nFollows the pattern: { data: T, error: null } | { data: null, error: Error }" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 654, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L654" - } - ], - "typeParameters": [ - { - "id": 1345, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1337, - "typeArguments": [ - { - "type": "reference", - "target": 1345, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "SuccessResponse", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 1341, - "name": "ErrorResponse", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1123, - "name": "BucketType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of storage bucket\n- STANDARD: Regular file storage buckets\n- ANALYTICS: Iceberg table-based buckets for analytical workloads" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 8, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L8" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1124, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 8, - "character": 62, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L8" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1233, - "name": "Camelize", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 339, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L339" - } - ], - "typeParameters": [ - { - "id": 1234, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1234, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1234, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - "nameType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CamelCase" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Extract", - "package": "typescript" - } - ], - "name": "CamelCase", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1254, - "name": "DistanceMetric", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Distance metrics for vector similarity search" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 396, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L396" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "cosine" - }, - { - "type": "literal", - "value": "euclidean" - }, - { - "type": "literal", - "value": "dotproduct" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1255, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 396, - "character": 79, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L396" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1235, - "name": "DownloadResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 343, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L343" - } - ], - "typeParameters": [ - { - "id": 1242, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1236, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1237, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 345, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L345" - } - ], - "type": { - "type": "reference", - "target": 1242, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - { - "id": 1238, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 346, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L346" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1237, 1238] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 344, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L344" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1239, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1240, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 349, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L349" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1241, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 350, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L350" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1240, 1241] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 348, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L348" - } - ] - } - } - ] - } - }, - { - "id": 1352, - "name": "ErrorNamespace", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace type for error classes\nDetermines the error class names and type guards" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 5, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L5" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "storage" - }, - { - "type": "literal", - "value": "vectors" - } - ] - } - }, - { - "id": 1252, - "name": "VectorDataType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supported data types for vectors\nCurrently only float32 is supported" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 391, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L391" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "float32" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1253, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 391, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L391" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1323, - "name": "VectorFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON filter expression for metadata filtering\nFormat and syntax depend on the S3 Vectors service implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 590, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L590" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1266, - "name": "VectorMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arbitrary JSON metadata attached to vectors\nKeys configured as non-filterable in the index can be stored but not queried" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 431, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L431" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1346, - "name": "isStorageError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L50" - } - ], - "signatures": [ - { - "id": 1347, - "name": "isStorageError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type guard to check if an error is a StorageError" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "True if the error is a StorageError" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L50" - } - ], - "parameters": [ - { - "id": 1348, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The error to check" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - } - ] - }, - { - "id": 1349, - "name": "isStorageVectorsError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 119, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L119" - } - ], - "signatures": [ - { - "id": 1350, - "name": "isStorageVectorsError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type guard to check if an error is a StorageVectorsError" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "True if the error is a StorageVectorsError" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 119, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L119" - } - ], - "parameters": [ - { - "id": 1351, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The error to check" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError", - "package": "@supabase/storage-js" - } - } - } - ] - }, - { - "id": 1122, - "name": "CreateIndexOptions", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 15, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L15" - } - ], - "target": 912 - }, - { - "id": 1114, - "name": "StorageAnalyticsClient", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 3, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L3" - } - ], - "target": 48 - }, - { - "id": 1115, - "name": "StorageVectorsClient", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 7, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L7" - } - ], - "target": 549 - }, - { - "id": 1118, - "name": "StorageVectorsClientOptions", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 11, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L11" - } - ], - "target": 536 - }, - { - "id": 1116, - "name": "VectorBucketScope", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L8" - } - ], - "target": 604 - }, - { - "id": 1117, - "name": "VectorIndexScope", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L9" - } - ], - "target": 672 - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [1456] - }, - { - "title": "Classes", - "children": [1371, 984, 1353, 1389, 1422, 1407, 1439] - }, - { - "title": "Interfaces", - "children": [ - 1141, 1125, 1307, 1190, 1243, 1341, 1222, 1147, 1157, 1167, 1183, 1295, 1301, 1135, - 1285, 1290, 1276, 1280, 1311, 1320, 1225, 1250, 1303, 1324, 1332, 1192, 1214, 1206, - 1200, 1217, 1180, 1197, 1112, 1337, 1227, 1246, 1264, 1335, 1256, 1271, 1267 - ] - }, - { - "title": "Type Aliases", - "children": [1344, 1123, 1233, 1254, 1235, 1352, 1252, 1323, 1266] - }, - { - "title": "Functions", - "children": [1346, 1349] - }, - { - "title": "References", - "children": [1122, 1114, 1115, 1118, 1116, 1117] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L1" - } - ] - }, - { - "id": 2, - "name": "packages/BlobDownloadBuilder", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 3, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L9" - } - ], - "signatures": [ - { - "id": 5, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L9" - } - ], - "parameters": [ - { - "id": 6, - "name": "downloadFn", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 7, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 10, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10" - } - ], - "signatures": [ - { - "id": 8, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 10, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 9, - "name": "shouldThrowOnError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": 3, - "name": "BlobDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 45, - "name": "[toStringTag]", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 6, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L6" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'BlobDownloadBuilder'", - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.[toStringTag]" - } - }, - { - "id": 15, - "name": "asStream", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14" - } - ], - "signatures": [ - { - "id": 16, - "name": "asStream", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14" - } - ], - "type": { - "type": "reference", - "target": 741, - "name": "StreamDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 29, - "name": "catch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L25" - } - ], - "signatures": [ - { - "id": 30, - "name": "catch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback for only the rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L25" - } - ], - "typeParameters": [ - { - "id": 31, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 32, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 33, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 26, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26" - } - ], - "signatures": [ - { - "id": 34, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 26, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26" - } - ], - "parameters": [ - { - "id": 35, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - }, - { - "id": 36, - "name": "finally", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "signatures": [ - { - "id": 37, - "name": "finally", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\nresolved value cannot be modified from the callback." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "parameters": [ - { - "id": 38, - "name": "onfinally", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is settled (fulfilled or rejected)." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "signatures": [ - { - "id": 40, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - }, - { - "id": 17, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18" - } - ], - "signatures": [ - { - "id": 18, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18" - } - ], - "typeParameters": [ - { - "id": 19, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - }, - { - "id": 20, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 21, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 22, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 19, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19" - } - ], - "signatures": [ - { - "id": 23, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 19, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19" - } - ], - "parameters": [ - { - "id": 24, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 25, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 26, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 20, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20" - } - ], - "signatures": [ - { - "id": 27, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 20, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20" - } - ], - "parameters": [ - { - "id": 28, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [4] - }, - { - "title": "Properties", - "children": [45] - }, - { - "title": "Methods", - "children": [15, 29, 36, 17] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 5, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L5" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [3] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L1" - } - ] - }, - { - "id": 46, - "name": "packages/StorageAnalyticsClient", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 48, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client class for managing Analytics Buckets using Iceberg tables\nProvides methods for creating, listing, and deleting analytics buckets" - } - ] - }, - "children": [ - { - "id": 49, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "signatures": [ - { - "id": 50, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new StorageAnalyticsClient instance\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.storage.analytics.listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { StorageAnalyticsClient } from '@supabase/storage-js'\n\nconst client = new StorageAnalyticsClient(url, headers)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "parameters": [ - { - "id": 51, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The base URL for the storage API" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 52, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers to include in requests" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 53, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "indexSignatures": [ - { - "id": 54, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "parameters": [ - { - "id": 55, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 56, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom fetch implementation" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 57, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 58, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 59, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 60, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 61, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 62, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 63, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 48, - "name": "StorageAnalyticsClient", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 64, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 95, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L95" - } - ], - "signatures": [ - { - "id": 65, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new analytics bucket using Iceberg tables\nAnalytics buckets are optimized for analytical queries and data processing\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created analytics bucket or error" - } - ] - }, - { - "tag": "@example", - "name": "Create analytics bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Creates a new analytics bucket using Iceberg tables\n- Analytics buckets are optimized for analytical queries and data processing" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 95, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L95" - } - ], - "parameters": [ - { - "id": 66, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique name for the bucket you are creating" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 68, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 97, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L97" - } - ], - "type": { - "type": "reference", - "target": 1141, - "name": "AnalyticBucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 69, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 98, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L98" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [68, 69] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 96, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L96" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 70, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 71, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 101, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L101" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 72, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 102, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L102" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [71, 72] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L100" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 88, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 228, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L228" - } - ], - "signatures": [ - { - "id": 89, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing analytics bucket\nA bucket can't be deleted with existing objects inside it\nYou must first empty the bucket before deletion\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete analytics bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .deleteBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deletes an analytics bucket" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 228, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L228" - } - ], - "parameters": [ - { - "id": 90, - "name": "bucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 91, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 92, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 94, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [94] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ] - } - } - }, - { - "id": 95, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 231, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L231" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [92, 95] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 229, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L229" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 96, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 97, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 234, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L234" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 98, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 235, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L235" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [97, 98] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 233, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L233" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 99, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 372, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L372" - } - ], - "signatures": [ - { - "id": 100, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get an Iceberg REST Catalog client configured for a specific analytics bucket\nUse this to perform advanced table and namespace operations within the bucket\nThe returned client provides full access to the Apache Iceberg REST Catalog API\nwith the Supabase " - }, - { - "kind": "code", - "text": "`{ data, error }`" - }, - { - "kind": "text", - "text": " pattern for consistent error handling on all operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The wrapped Iceberg catalog client" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "If the bucket name is invalid" - } - ] - }, - { - "tag": "@example", - "name": "Get catalog and create table", - "content": [ - { - "kind": "code", - "text": "```js\n// First, create an analytics bucket\nconst { data: bucket, error: bucketError } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n\n// Get the Iceberg catalog for that bucket\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Create a namespace\nconst { error: nsError } = await catalog.createNamespace({ namespace: ['default'] })\n\n// Create a table with schema\nconst { data: tableMetadata, error: tableError } = await catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false }\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1]\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: []\n },\n 'write-order': {\n 'order-id': 0,\n fields: []\n },\n properties: {\n 'write.format.default': 'parquet'\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "List tables in namespace", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all tables in the default namespace\nconst { data: tables, error: listError } = await catalog.listTables({ namespace: ['default'] })\nif (listError) {\n if (listError.isNotFound()) {\n console.log('Namespace not found')\n }\n return\n}\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Working with namespaces", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all namespaces\nconst { data: namespaces } = await catalog.listNamespaces()\n\n// Create namespace with properties\nawait catalog.createNamespace(\n { namespace: ['production'] },\n { properties: { owner: 'data-team', env: 'prod' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup operations", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Drop table with purge option (removes all data)\nconst { error: dropError } = await catalog.dropTable(\n { namespace: ['default'], name: 'events' },\n { purge: true }\n)\n\nif (dropError?.isNotFound()) {\n console.log('Table does not exist')\n}\n\n// Drop namespace (must be empty)\nawait catalog.dropNamespace({ namespace: ['default'] })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This method provides a bridge between Supabase's bucket management and the standard\nApache Iceberg REST Catalog API. The bucket name maps to the Iceberg warehouse parameter.\nAll authentication and configuration is handled automatically using your Supabase credentials.\n\n**Error Handling**: Invalid bucket names throw immediately. All catalog\noperations return " - }, - { - "kind": "code", - "text": "`{ data, error }`" - }, - { - "kind": "text", - "text": " where errors are " - }, - { - "kind": "code", - "text": "`IcebergError`" - }, - { - "kind": "text", - "text": " instances from iceberg-js.\nUse helper methods like " - }, - { - "kind": "code", - "text": "`error.isNotFound()`" - }, - { - "kind": "text", - "text": " or check " - }, - { - "kind": "code", - "text": "`error.status`" - }, - { - "kind": "text", - "text": " for specific error handling.\nUse " - }, - { - "kind": "code", - "text": "`.throwOnError()`" - }, - { - "kind": "text", - "text": " on the analytics client if you prefer exceptions for catalog operations.\n\n**Cleanup Operations**: When using " - }, - { - "kind": "code", - "text": "`dropTable`" - }, - { - "kind": "text", - "text": ", the " - }, - { - "kind": "code", - "text": "`purge: true`" - }, - { - "kind": "text", - "text": " option permanently\ndeletes all table data. Without it, the table is marked as deleted but data remains.\n\n**Library Dependency**: The returned catalog wraps " - }, - { - "kind": "code", - "text": "`IcebergRestCatalog`" - }, - { - "kind": "text", - "text": " from iceberg-js.\nFor complete API documentation and advanced usage, refer to the\n[iceberg-js documentation](https://supabase.github.io/iceberg-js/)." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 372, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L372" - } - ], - "parameters": [ - { - "id": 101, - "name": "bucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the analytics bucket (warehouse) to connect to" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 47, - "name": "WrappedIcebergRestCatalog", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 73, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ], - "signatures": [ - { - "id": 74, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Analytics Storage buckets within an existing project\nOnly returns buckets of type 'ANALYTICS'\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of analytics buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List analytics buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc'\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Retrieves the details of all Analytics Storage buckets within an existing project\n- Only returns buckets of type 'ANALYTICS'" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ], - "parameters": [ - { - "id": 75, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 77, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 162, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 78, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 163, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L163" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 81, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 166, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L166" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 79, - "name": "sortColumn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Column to sort by ('name', 'created_at', 'updated_at')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 164, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L164" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 80, - "name": "sortOrder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 165, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L165" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [77, 78, 81, 79, 80] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 82, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 83, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 169, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L169" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1141, - "name": "AnalyticBucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 84, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 170, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L170" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [83, 84] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L168" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 86, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 173, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L173" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 87, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 174, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L174" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [86, 87] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L172" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 119, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 120, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 121, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 122, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 117, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 118, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [49] - }, - { - "title": "Methods", - "children": [64, 88, 99, 73, 119, 117] - } - ], - "categories": [ - { - "title": "Other", - "children": [119, 117] - }, - { - "title": "Storage", - "children": [49, 64, 88, 99, 73] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 21, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L21" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 47, - "name": "WrappedIcebergRestCatalog", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L13" - } - ], - "type": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/iceberg-js@0.8.1/node_modules/iceberg-js/dist/index.d.ts", - "qualifiedName": "IcebergRestCatalog" - }, - "name": "IcebergRestCatalog", - "package": "iceberg-js" - } - }, - "templateType": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "WrapAsyncMethod" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/iceberg-js@0.8.1/node_modules/iceberg-js/dist/index.d.ts", - "qualifiedName": "IcebergRestCatalog" - }, - "name": "IcebergRestCatalog", - "package": "iceberg-js" - } - } - ], - "name": "WrapAsyncMethod", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Classes", - "children": [48] - }, - { - "title": "Type Aliases", - "children": [47] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L1" - } - ] - }, - { - "id": 135, - "name": "packages/StorageBucketApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 136, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 137, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L9" - } - ], - "signatures": [ - { - "id": 138, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L9" - } - ], - "parameters": [ - { - "id": 139, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 140, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L11" - } - ], - "indexSignatures": [ - { - "id": 142, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 11, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L11" - } - ], - "parameters": [ - { - "id": 143, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 144, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 145, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 146, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 147, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 148, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 149, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 150, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 151, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 152, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1112, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 136, - "name": "StorageBucketApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 171, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "signatures": [ - { - "id": 172, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created bucket name or error" - } - ] - }, - { - "tag": "@example", - "name": "Create bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "parameters": [ - { - "id": 173, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are creating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 174, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 178, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L193" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 177, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 192, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L192" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 176, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 191, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 179, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "(private-beta) specifies the bucket type. see " - }, - { - "kind": "code", - "text": "`BucketType`" - }, - { - "kind": "text", - "text": " for more details.\n - default bucket type is " - }, - { - "kind": "code", - "text": "`STANDARD`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [178, 177, 176, 179] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 181, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 200, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "name" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 182, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 201, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [181, 182] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 199, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L199" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 184, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 204, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 185, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [184, 185] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 203, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 213, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "signatures": [ - { - "id": 214, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " - }, - { - "kind": "code", - "text": "`empty()`" - }, - { - "kind": "text", - "text": " the bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "parameters": [ - { - "id": 215, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 216, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 217, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 219, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [219] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ] - } - } - }, - { - "id": 220, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L381" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [217, 220] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 222, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 384, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L384" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 223, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L385" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [222, 223] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 383, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L383" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 202, - "name": "emptyBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "signatures": [ - { - "id": 203, - "name": "emptyBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes all objects inside a single bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Empty bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "parameters": [ - { - "id": 204, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to empty." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 206, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 207, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 208, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [208] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ] - } - } - }, - { - "id": 209, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L334" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [206, 209] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 332, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 210, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 211, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L337" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 212, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 338, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L338" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [211, 212] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 336, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L336" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 162, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "signatures": [ - { - "id": 163, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing Storage bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing bucket details or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "parameters": [ - { - "id": 164, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to retrieve." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 166, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 131, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L131" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 167, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 132, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [166, 167] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 130, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 169, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L135" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 170, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 136, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L136" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [169, 170] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 134, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 153, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "signatures": [ - { - "id": 154, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Storage buckets within an existing project." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "List buckets with options", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "parameters": [ - { - "id": 155, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reference", - "target": 1135, - "name": "ListBucketOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "limit": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ], - "offset": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ], - "sortColumn": [ - { - "kind": "text", - "text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')" - } - ], - "sortOrder": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ], - "search": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 156, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 157, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 158, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L74" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [157, 158] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 72, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 160, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 77, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 161, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 78, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [160, 161] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 244, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 245, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 246, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 247, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 242, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 243, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - }, - { - "id": 186, - "name": "updateBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "signatures": [ - { - "id": 187, - "name": "updateBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Update bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "parameters": [ - { - "id": 188, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are updating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 189, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 193, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 272, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 192, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 271, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 191, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 270, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L270" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [193, 192, 191] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 269, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L269" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 195, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 197, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [197] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ] - } - } - }, - { - "id": 198, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [195, 198] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 199, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 200, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 280, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L280" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 201, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 281, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L281" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [200, 201] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L279" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [137] - }, - { - "title": "Methods", - "children": [171, 213, 202, 162, 153, 244, 242, 186] - } - ], - "categories": [ - { - "title": "Other", - "children": [137, 244, 242] - }, - { - "title": "Storage", - "children": [171, 213, 202, 162, 153, 186] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 8, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L8" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 984, - "name": "StorageClient" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [136] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L1" - } - ] - }, - { - "id": 260, - "name": "packages/StorageFileApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 261, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 262, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L55" - } - ], - "signatures": [ - { - "id": 263, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L55" - } - ], - "parameters": [ - { - "id": 264, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 265, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 266, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 57, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L57" - } - ], - "indexSignatures": [ - { - "id": 267, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 57, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L57" - } - ], - "parameters": [ - { - "id": 268, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 269, - "name": "bucketId", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 270, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 271, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 272, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 273, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 274, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 275, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 276, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 277, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 261, - "name": "StorageFileApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 369, - "name": "copy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 600, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L600" - } - ], - "signatures": [ - { - "id": 370, - "name": "copy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Copies an existing file to a new path in the same bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing copied file path or error" - } - ] - }, - { - "tag": "@example", - "name": "Copy file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .copy('public/avatar1.png', 'private/avatar2.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"avatars/private/avatar2.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 600, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L600" - } - ], - "parameters": [ - { - "id": 371, - "name": "fromPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The original file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 372, - "name": "toPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new file path, including the new file name. For example " - }, - { - "kind": "code", - "text": "`folder/image-copy.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 373, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The destination options." - } - ] - }, - "type": { - "type": "reference", - "target": 1190, - "name": "DestinationOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 374, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 375, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 376, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 377, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [377] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ] - } - } - }, - { - "id": 378, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 607, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L607" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [375, 378] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 605, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L605" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 380, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 610, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L610" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 381, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 611, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L611" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [380, 381] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 609, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L609" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 325, - "name": "createSignedUploadUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L380" - } - ], - "signatures": [ - { - "id": 326, - "name": "createSignedUploadUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing signed upload URL, token, and path or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed Upload URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUploadUrl('folder/cat.jpg')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/upload/sign/avatars/folder/cat.jpg?token=\",\n \"path\": \"folder/cat.jpg\",\n \"token\": \"\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L380" - } - ], - "parameters": [ - { - "id": 327, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 328, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 330, - "name": "upsert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, allows the file to be overwritten if it already exists." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 382, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L382" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [330] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 382, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L382" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 332, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 333, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 336, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 50, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 334, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 335, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [336, 334, 335] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ] - } - } - }, - { - "id": 337, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L386" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [332, 337] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 384, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L384" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 339, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 389, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L389" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 340, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 390, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L390" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [339, 340] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 388, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L388" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 382, - "name": "createSignedUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 689, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L689" - } - ], - "signatures": [ - { - "id": 383, - "name": "createSignedUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing signed URL or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a signed URL for an asset with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60, {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a signed URL which triggers the download of the asset", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60, {\n download: true,\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 689, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L689" - } - ], - "parameters": [ - { - "id": 384, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 385, - "name": "expiresIn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the signed URL expires. For example, " - }, - { - "kind": "code", - "text": "`60`" - }, - { - "kind": "text", - "text": " for a URL which is valid for one minute." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 386, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 387, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 390, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 695, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L695" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 388, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 693, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L693" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - }, - { - "id": 389, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform the asset before serving it to the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 694, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L694" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [390, 388, 389] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 692, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L692" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 392, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 393, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 394, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [394] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ] - } - } - }, - { - "id": 395, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 700, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L700" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [392, 395] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 698, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L698" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 396, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 397, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 703, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L703" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 398, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 704, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L704" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [397, 398] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 702, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L702" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 399, - "name": "createSignedUrls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 784, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L784" - } - ], - "signatures": [ - { - "id": 400, - "name": "createSignedUrls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of objects with signedUrl, path, and error or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed URLs", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"error\": null,\n \"path\": \"folder/avatar1.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar1.png?token=\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\"\n },\n {\n \"error\": null,\n \"path\": \"folder/avatar2.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar2.png?token=\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar2.png?token=\"\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 784, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L784" - } - ], - "parameters": [ - { - "id": 401, - "name": "paths", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file paths to be downloaded, including the current file names. For example " - }, - { - "kind": "code", - "text": "`['folder/image.png', 'folder2/image2.png']`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 402, - "name": "expiresIn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the signed URLs expire. For example, " - }, - { - "kind": "code", - "text": "`60`" - }, - { - "kind": "text", - "text": " for URLs which are valid for one minute." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 403, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 406, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [406, 405] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 407, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 408, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 409, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 410, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 411, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 412, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [410, 411, 412] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ] - } - } - } - }, - { - "id": 413, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 791, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L791" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [408, 413] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 789, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L789" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 414, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 415, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 794, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L794" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 416, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 795, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L795" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [415, 416] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 793, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L793" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 417, - "name": "download", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "signatures": [ - { - "id": 418, - "name": "download", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from " - }, - { - "kind": "code", - "text": "`getPublicUrl`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "BlobDownloadBuilder instance for downloading the file" - } - ] - }, - { - "tag": "@example", - "name": "Download file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": ,\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download file with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n quality: 80\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download with cache control (useful in Edge Functions)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {}, { cache: 'no-store' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download with abort signal", - "content": [ - { - "kind": "code", - "text": "```js\nconst controller = new AbortController()\nsetTimeout(() => controller.abort(), 5000)\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {}, { signal: controller.signal })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "typeParameters": [ - { - "id": 419, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 420, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 422, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 421, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [422, 421] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ] - } - } - } - ], - "parameters": [ - { - "id": 423, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The full path and file name of the file to be downloaded. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 424, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 419, - "name": "Options", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - { - "id": 425, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional fetch parameters like signal for cancellation. Supports standard fetch options including cache control." - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 3, - "name": "BlobDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 435, - "name": "exists", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 980, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L980" - } - ], - "signatures": [ - { - "id": 436, - "name": "exists", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Checks the existence of a file." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing boolean indicating file existence or error" - } - ] - }, - { - "tag": "@example", - "name": "Check file existence", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .exists('folder/avatar1.png')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 980, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L980" - } - ], - "parameters": [ - { - "id": 437, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 438, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 439, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 982, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L982" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 440, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 983, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L983" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [439, 440] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 981, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L981" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 441, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 442, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 986, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L986" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 443, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 987, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L987" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [442, 443] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 985, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L985" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 444, - "name": "getPublicUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1079" - } - ], - "signatures": [ - { - "id": 445, - "name": "getPublicUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Object with public URL" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL for an asset in a public bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"publicUrl\": \"https://example.supabase.co/storage/v1/object/public/public-bucket/folder/avatar1.png\"\n }\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL for an asset in a public bucket with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL which triggers the download of an asset in a public bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n download: true,\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The bucket needs to be set to public, either via [updateBucket()](/docs/reference/javascript/storage-updatebucket) or by going to Storage on [supabase.com/dashboard](https://supabase.com/dashboard), clicking the overflow menu on a bucket and choosing \"Make public\"\n- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1079" - } - ], - "parameters": [ - { - "id": 446, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path and name of the file to generate the public URL for. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 447, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 448, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 451, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1084, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1084" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 449, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1082, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1082" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - }, - { - "id": 450, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform the asset before serving it to the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1083, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1083" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [451, 449, 450] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1081, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1081" - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 455, - "name": "publicUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [455] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [453] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ] - } - } - } - ] - }, - { - "id": 426, - "name": "info", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 943, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L943" - } - ], - "signatures": [ - { - "id": 427, - "name": "info", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing file.\n\nReturns detailed file metadata including size, content type, and timestamps.\nNote: The API returns " - }, - { - "kind": "code", - "text": "`last_modified`" - }, - { - "kind": "text", - "text": " field, not " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get file info", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .info('folder/avatar1.png')\n\nif (data) {\n console.log('Last modified:', data.lastModified)\n console.log('Size:', data.size)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 943, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L943" - } - ], - "parameters": [ - { - "id": 428, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 429, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 430, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 945, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L945" - } - ], - "type": { - "type": "reference", - "target": 1233, - "typeArguments": [ - { - "type": "reference", - "target": 1167, - "name": "FileObjectV2", - "package": "@supabase/storage-js" - } - ], - "name": "Camelize", - "package": "@supabase/storage-js" - } - }, - { - "id": 431, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 946, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L946" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [430, 431] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 944, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L944" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 432, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 433, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 949, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L949" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 434, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 950, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L950" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [433, 434] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 948, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L948" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 465, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1308, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1308" - } - ], - "signatures": [ - { - "id": 466, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all the files and folders within a path of the bucket.\n\n**Important:** For folder entries, fields like " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`last_accessed_at`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`metadata`" - }, - { - "kind": "text", - "text": " will be " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ". Only files have these fields populated.\nAdditionally, deprecated fields like " - }, - { - "kind": "code", - "text": "`bucket_id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`owner`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " are NOT returned\nby this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of files/folders or error" - } - ] - }, - { - "tag": "@example", - "name": "List files in a bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .list('folder', {\n limit: 100,\n offset: 0,\n sortBy: { column: 'name', order: 'asc' },\n })\n\n// Handle files vs folders\ndata?.forEach(item => {\n if (item.id !== null) {\n // It's a file\n console.log('File:', item.name, 'Size:', item.metadata?.size)\n } else {\n // It's a folder\n console.log('Folder:', item.name)\n }\n})\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"avatar1.png\",\n \"id\": \"e668cf7f-821b-4a2f-9dce-7dfa5dd1cfd2\",\n \"updated_at\": \"2024-05-22T23:06:05.580Z\",\n \"created_at\": \"2024-05-22T23:04:34.443Z\",\n \"last_accessed_at\": \"2024-05-22T23:04:34.443Z\",\n \"metadata\": {\n \"eTag\": \"\\\"c5e8c553235d9af30ef4f6e280790b92\\\"\",\n \"size\": 32175,\n \"mimetype\": \"image/png\",\n \"cacheControl\": \"max-age=3600\",\n \"lastModified\": \"2024-05-22T23:06:05.574Z\",\n \"contentLength\": 32175,\n \"httpStatusCode\": 200\n }\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Search files in a bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .list('folder', {\n limit: 100,\n offset: 0,\n sortBy: { column: 'name', order: 'asc' },\n search: 'jon'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1308, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1308" - } - ], - "parameters": [ - { - "id": 467, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The folder path." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 468, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search options including limit (defaults to 100), offset, sortBy, and search" - } - ] - }, - "type": { - "type": "reference", - "target": 1192, - "name": "SearchOptions", - "package": "@supabase/storage-js" - } - }, - { - "id": 469, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional fetch parameters including signal for cancellation" - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 471, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1314, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1314" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1157, - "name": "FileObject", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 472, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1315, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1315" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [471, 472] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1313, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1313" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 473, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 474, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1318, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1318" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 475, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1319, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1319" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [474, 475] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1317, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1317" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 476, - "name": "listV2", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1381" - } - ], - "signatures": [ - { - "id": 477, - "name": "listV2", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all the files and folders within a bucket using the V2 API with pagination support.\n\n**Important:** Folder entries in the " - }, - { - "kind": "code", - "text": "`folders`" - }, - { - "kind": "text", - "text": " array only contain " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " and optionally " - }, - { - "kind": "code", - "text": "`key`" - }, - { - "kind": "text", - "text": " —\nthey have no " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", timestamps, or " - }, - { - "kind": "code", - "text": "`metadata`" - }, - { - "kind": "text", - "text": " fields. Full file metadata is only available\non entries in the " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " array.\n\n this method signature might change in the future" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing folders/objects arrays with pagination info or error" - } - ] - }, - { - "tag": "@example", - "name": "List files with pagination", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .listV2({\n prefix: 'folder/',\n limit: 100,\n })\n\n// Handle pagination\nif (data?.hasNext) {\n const nextPage = await supabase\n .storage\n .from('avatars')\n .listV2({\n prefix: 'folder/',\n cursor: data.nextCursor,\n })\n}\n\n// Handle files vs folders\ndata?.objects.forEach(file => {\n if (file.id !== null) {\n console.log('File:', file.name, 'Size:', file.metadata?.size)\n }\n})\ndata?.folders.forEach(folder => {\n console.log('Folder:', folder.name)\n})\n```" - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1381" - } - ], - "parameters": [ - { - "id": 478, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search options including prefix, cursor for pagination, limit, with_delimiter" - } - ] - }, - "type": { - "type": "reference", - "target": 1200, - "name": "SearchV2Options", - "package": "@supabase/storage-js" - } - }, - { - "id": 479, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional fetch parameters including signal for cancellation" - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 481, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1386" - } - ], - "type": { - "type": "reference", - "target": 1217, - "name": "SearchV2Result", - "package": "@supabase/storage-js" - } - }, - { - "id": 482, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1387, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1387" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [481, 482] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1385, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1385" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 483, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 484, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1390, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1390" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 485, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1391, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1391" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [484, 485] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1389, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1389" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 356, - "name": "move", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 537, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L537" - } - ], - "signatures": [ - { - "id": 357, - "name": "move", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Moves an existing file to a new path in the same bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Move file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .move('public/avatar1.png', 'private/avatar2.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully moved\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 537, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L537" - } - ], - "parameters": [ - { - "id": 358, - "name": "fromPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The original file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 359, - "name": "toPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new file path, including the new file name. For example " - }, - { - "kind": "code", - "text": "`folder/image-new.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The destination options." - } - ] - }, - "type": { - "type": "reference", - "target": 1190, - "name": "DestinationOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 362, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 364, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [364] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ] - } - } - }, - { - "id": 365, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L544" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [362, 365] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 542, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L542" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 367, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 547, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L547" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 368, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 548, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L548" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [367, 368] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 546, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L546" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 456, - "name": "remove", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1143" - } - ], - "signatures": [ - { - "id": 457, - "name": "remove", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes files within the same bucket\n\nReturns an array of FileObject entries for the deleted files. Note that deprecated\nfields like " - }, - { - "kind": "code", - "text": "`bucket_id`" - }, - { - "kind": "text", - "text": " may or may not be present in the response - do not rely on them." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of deleted file objects or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .remove(['folder/avatar1.png'])\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1143" - } - ], - "parameters": [ - { - "id": 458, - "name": "paths", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of files to delete, including the path and file name. For example [" - }, - { - "kind": "code", - "text": "`'folder/image.png'`" - }, - { - "kind": "text", - "text": "]." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 459, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 460, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1145" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1157, - "name": "FileObject", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 461, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1146, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1146" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [460, 461] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1144, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1144" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 463, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1149, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1149" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 464, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1150, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1150" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [463, 464] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1148, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1148" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 519, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 520, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 521, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 522, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 517, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 518, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - }, - { - "id": 489, - "name": "toBase64", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1410" - } - ], - "signatures": [ - { - "id": 490, - "name": "toBase64", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1410" - } - ], - "parameters": [ - { - "id": 491, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 341, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 476, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L476" - } - ], - "signatures": [ - { - "id": 342, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Replaces an existing file at the specified path with a new one." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path, id, and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Update file", - "content": [ - { - "kind": "code", - "text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', avatarFile, {\n cacheControl: '3600'\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update file using `ArrayBuffer` from base64 file data", - "content": [ - { - "kind": "code", - "text": "```js\nimport {decode} from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " always replaces the file at the given path regardless of the " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option.\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\n- For React Native, using either " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " does not work as intended. Update file using " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " from base64 file data instead, see example below." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 476, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L476" - } - ], - "parameters": [ - { - "id": 343, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The relative file path. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to update." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "__global.NodeJS.ReadableStream" - }, - "name": "ReadableStream", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.ReadableStream" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URLSearchParams" - }, - "name": "URLSearchParams", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/buffer.buffer.d.ts", - "qualifiedName": "__global.Buffer" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "Buffer", - "package": "@types/node", - "qualifiedName": "__global.Buffer" - } - ] - } - }, - { - "id": 345, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional file upload options including cacheControl, contentType, and metadata.\n**Note:** The " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option has no effect here. " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " always replaces the\nfile at the given path, so the " - }, - { - "kind": "code", - "text": "`x-upsert`" - }, - { - "kind": "text", - "text": " header is not sent. To control upsert\nbehavior, use " - }, - { - "kind": "code", - "text": "`upload()`" - }, - { - "kind": "text", - "text": " instead." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 346, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 347, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 348, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 351, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 349, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 350, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [351, 349, 350] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ] - } - } - }, - { - "id": 352, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 493, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L493" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [347, 352] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 491, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L491" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 353, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 354, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 496, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L496" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 355, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L497" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [354, 355] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 495, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L495" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 295, - "name": "upload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 219, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L219" - } - ], - "signatures": [ - { - "id": 296, - "name": "upload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Uploads a file to an existing bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path, id, and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Upload file", - "content": [ - { - "kind": "code", - "text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile, {\n cacheControl: '3600',\n upsert: false\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upload file using `ArrayBuffer` from base64 file data", - "content": [ - { - "kind": "code", - "text": "```js\nimport { decode } from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile)\n\nif (error) {\n // Log the full error so fields like `statusCode` and `error` (the\n // Storage error name, e.g. \"Duplicate\") aren't hidden behind `error.message`.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: only " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " when you are uploading new files and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " when you are upserting files\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\n- For React Native, using either " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " does not work as intended. Upload file using " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " from base64 file data instead, see example below." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 219, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L219" - } - ], - "parameters": [ - { - "id": 297, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to upload." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 298, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "FileBody" - }, - "name": "FileBody", - "package": "@supabase/storage-js" - } - }, - { - "id": 299, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional file upload options including cacheControl, contentType, upsert, and metadata." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 300, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 301, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 302, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 305, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 303, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 304, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [305, 303, 304] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ] - } - } - }, - { - "id": 306, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 226, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L226" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [301, 306] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 224, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L224" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 307, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 308, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 229, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L229" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 309, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 230, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L230" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [308, 309] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 228, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L228" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 310, - "name": "uploadToSignedUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L274" - } - ], - "signatures": [ - { - "id": 311, - "name": "uploadToSignedUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Upload a file with a token generated from " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Upload to a signed URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .uploadToSignedUrl('folder/cat.jpg', 'token-from-createSignedUploadUrl', file)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"folder/cat.jpg\",\n \"fullPath\": \"avatars/folder/cat.jpg\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L274" - } - ], - "parameters": [ - { - "id": 312, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to upload." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 313, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token generated from " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl`" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 314, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "FileBody" - }, - "name": "FileBody", - "package": "@supabase/storage-js" - } - }, - { - "id": 315, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers (cacheControl, contentType, etc.).\n**Note:** The " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option has no effect here. To enable upsert behavior,\npass " - }, - { - "kind": "code", - "text": "`{ upsert: true }`" - }, - { - "kind": "text", - "text": " when calling " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl()`" - }, - { - "kind": "text", - "text": " instead." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 316, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 317, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 318, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [317, 318] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 320, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 323, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "defaultValue": "data.Key" - }, - { - "id": 322, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "cleanPath" - } - ], - "groups": [ - { - "title": "Properties", - "children": [323, 322] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ] - } - } - }, - { - "id": 324, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [320, 324] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [262] - }, - { - "title": "Methods", - "children": [ - 369, 325, 382, 399, 417, 435, 444, 426, 465, 476, 356, 456, 519, 517, 489, 341, - 295, 310 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [262, 519, 517, 489] - }, - { - "title": "Storage", - "children": [ - 369, 325, 382, 399, 417, 435, 444, 426, 465, 476, 356, 456, 341, 295, 310 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 52, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L52" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [261] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1" - } - ] - }, - { - "id": 535, - "name": "packages/StorageVectorsClient", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 549, - "name": "StorageVectorsClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Main client for interacting with S3 Vectors API\nProvides access to bucket, index, and vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.\n\n**Usage Patterns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .createBucket('embeddings-prod')\n\n// Access index operations via buckets\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine'\n})\n\n// Access vector operations via index\nconst index = bucket.index('documents')\nawait index.putVectors({\n vectors: [\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\n ]\n})\n\n// Query similar vectors\nconst { data } = await index.queryVectors({\n queryVector: { float32: [...] },\n topK: 5,\n returnDistance: true\n})\n```" - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 550, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L109" - } - ], - "signatures": [ - { - "id": 551, - "name": "StorageVectorsClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\nconst client = new StorageVectorsClient(url, options)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L109" - } - ], - "parameters": [ - { - "id": 552, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base URL of the Storage Vectors REST API." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 553, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 536, - "name": "StorageVectorsClientOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "headers": [ - { - "kind": "text", - "text": "Optional headers (for example " - }, - { - "kind": "code", - "text": "`Authorization`" - }, - { - "kind": "text", - "text": ") applied to every request." - } - ], - "fetch": [ - { - "kind": "text", - "text": "Optional custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation for non-browser runtimes." - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 549, - "name": "StorageVectorsClient", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.constructor" - } - }, - { - "id": 557, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 158, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L158" - } - ], - "signatures": [ - { - "id": 558, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new vector bucket\nVector buckets are containers for vector indexes and their data\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .createBucket('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 158, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L158" - } - ], - "parameters": [ - { - "id": 559, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name for the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.createBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.createBucket" - } - }, - { - "id": 568, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 242, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L242" - } - ], - "signatures": [ - { - "id": 569, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a vector bucket (bucket must be empty)\nAll indexes must be deleted before deleting the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .deleteBucket('embeddings-old')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 242, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L242" - } - ], - "parameters": [ - { - "id": 570, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.deleteBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.deleteBucket" - } - }, - { - "id": 554, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L132" - } - ], - "signatures": [ - { - "id": 555, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access operations for a specific vector bucket\nReturns a scoped client for index and vector operations within the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Bucket-scoped client with index and vector operations" - } - ] - }, - { - "tag": "@example", - "name": "Accessing a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L132" - } - ], - "parameters": [ - { - "id": 556, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 604, - "name": "VectorBucketScope", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 560, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "signatures": [ - { - "id": 561, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves metadata for a specific vector bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with bucket metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .getBucket('embeddings-prod')\n\nconsole.log('Bucket created:', data?.vectorBucket.creationTime)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "parameters": [ - { - "id": 562, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 563, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 564, - "name": "vectorBucket", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "type": { - "type": "reference", - "target": 1246, - "name": "VectorBucket", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [564] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 65, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ] - } - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.getBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.getBucket" - } - }, - { - "id": 565, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 214, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L214" - } - ], - "signatures": [ - { - "id": 566, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all vector buckets with optional filtering and pagination\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with list of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List vector buckets", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .listBuckets({ prefix: 'embeddings-' })\n\ndata?.vectorBuckets.forEach(bucket => {\n console.log(bucket.vectorBucketName)\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 214, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L214" - } - ], - "parameters": [ - { - "id": 567, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional filters (prefix, maxResults, nextToken)" - } - ] - }, - "type": { - "type": "reference", - "target": 1276, - "name": "ListVectorBucketsOptions", - "package": "@supabase/storage-js" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1280, - "name": "ListVectorBucketsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.listBuckets" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.listBuckets" - } - }, - { - "id": 588, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 589, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 590, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 591, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.setHeader" - } - }, - { - "id": 586, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 587, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [550] - }, - { - "title": "Methods", - "children": [557, 568, 554, 560, 565, 588, 586] - } - ], - "categories": [ - { - "title": "Other", - "children": [588, 586] - }, - { - "title": "Storage", - "children": [550, 557, 568, 554, 560, 565] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 80, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L80" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 604, - "name": "VectorBucketScope", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scoped client for operations within a specific vector bucket\nProvides index management and access to vector operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 605, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 273, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L273" - } - ], - "signatures": [ - { - "id": 606, - "name": "VectorBucketScope", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a helper that automatically scopes all index operations to the provided bucket.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector bucket scope", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 273, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L273" - } - ], - "parameters": [ - { - "id": 607, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 608, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 609, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 275, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L275" - } - ], - "indexSignatures": [ - { - "id": 610, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 275, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L275" - } - ], - "parameters": [ - { - "id": 611, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 612, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 613, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 614, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 615, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 616, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 617, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 618, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 619, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 620, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 604, - "name": "VectorBucketScope", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.constructor" - } - }, - { - "id": 622, - "name": "createIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 311, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L311" - } - ], - "signatures": [ - { - "id": 623, - "name": "createIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new vector index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents-openai',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine',\n metadataConfiguration: {\n nonFilterableMetadataKeys: ['raw_text']\n }\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 311, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L311" - } - ], - "parameters": [ - { - "id": 624, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Index configuration (vectorBucketName is automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 912, - "name": "CreateIndexOptions", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "vectorBucketName" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.createIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.createIndex" - } - }, - { - "id": 633, - "name": "deleteIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 390, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L390" - } - ], - "signatures": [ - { - "id": 634, - "name": "deleteIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an index from this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.deleteIndex('old-index')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 390, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L390" - } - ], - "parameters": [ - { - "id": 635, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.deleteIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.deleteIndex" - } - }, - { - "id": 628, - "name": "getIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 366, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L366" - } - ], - "signatures": [ - { - "id": 629, - "name": "getIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves metadata for a specific index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with index metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get index metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nconst { data } = await bucket.getIndex('documents-openai')\nconsole.log('Dimension:', data?.index.dimension)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 366, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L366" - } - ], - "parameters": [ - { - "id": 630, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index to retrieve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 631, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 632, - "name": "index", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 58, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58" - } - ], - "type": { - "type": "reference", - "target": 1256, - "name": "VectorIndex", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [632] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 58, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58" - } - ] - } - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.getIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.getIndex" - } - }, - { - "id": 636, - "name": "index", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L426" - } - ], - "signatures": [ - { - "id": 637, - "name": "index", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access operations for a specific index within this bucket\nReturns a scoped client for vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Index-scoped client with vector data operations" - } - ] - }, - { - "tag": "@example", - "name": "Accessing an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\n\n// Insert vectors\nawait index.putVectors({\n vectors: [\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\n ]\n})\n\n// Query similar vectors\nconst { data } = await index.queryVectors({\n queryVector: { float32: [...] },\n topK: 5\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L426" - } - ], - "parameters": [ - { - "id": 638, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 672, - "name": "VectorIndexScope", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 625, - "name": "listIndexes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 338, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L338" - } - ], - "signatures": [ - { - "id": 626, - "name": "listIndexes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists indexes in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing indexes array and pagination token or error" - } - ] - }, - { - "tag": "@example", - "name": "List indexes", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nconst { data } = await bucket.listIndexes({ prefix: 'documents-' })\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 338, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L338" - } - ], - "parameters": [ - { - "id": 627, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listing options (vectorBucketName is automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1285, - "name": "ListIndexesOptions", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "vectorBucketName" - } - ], - "name": "Omit", - "package": "typescript" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1290, - "name": "ListIndexesResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.listIndexes" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.listIndexes" - } - }, - { - "id": 656, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 657, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 658, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 659, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.setHeader" - } - }, - { - "id": 654, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 655, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [605] - }, - { - "title": "Methods", - "children": [622, 633, 628, 636, 625, 656, 654] - } - ], - "categories": [ - { - "title": "Other", - "children": [656, 654] - }, - { - "title": "Storage", - "children": [605, 622, 633, 628, 636, 625] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 256, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L256" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 672, - "name": "VectorIndexScope", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scoped client for operations within a specific vector index\nProvides vector data operations (put, get, list, query, delete)\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 673, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L465" - } - ], - "signatures": [ - { - "id": 674, - "name": "VectorIndexScope", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a helper that automatically scopes all vector operations to the provided bucket/index names.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector index scope", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L465" - } - ], - "parameters": [ - { - "id": 675, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 676, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 677, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 467, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L467" - } - ], - "indexSignatures": [ - { - "id": 678, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 467, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L467" - } - ], - "parameters": [ - { - "id": 679, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 680, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 681, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 682, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 684, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 685, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 686, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 687, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 688, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 689, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 672, - "name": "VectorIndexScope", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.constructor" - } - }, - { - "id": 704, - "name": "deleteVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L635" - } - ], - "signatures": [ - { - "id": 705, - "name": "deleteVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete vectors by keys", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nawait index.deleteVectors({\n keys: ['doc-1', 'doc-2', 'doc-3']\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L635" - } - ], - "parameters": [ - { - "id": 706, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletion options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1307, - "name": "DeleteVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.deleteVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.deleteVectors" - } - }, - { - "id": 695, - "name": "getVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 536, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L536" - } - ], - "signatures": [ - { - "id": 696, - "name": "getVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing vectors array or error" - } - ] - }, - { - "tag": "@example", - "name": "Get vectors by keys", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.getVectors({\n keys: ['doc-1', 'doc-2'],\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 536, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L536" - } - ], - "parameters": [ - { - "id": 697, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector retrieval options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1295, - "name": "GetVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1301, - "name": "GetVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.getVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.getVectors" - } - }, - { - "id": 698, - "name": "listVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 567, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L567" - } - ], - "signatures": [ - { - "id": 699, - "name": "listVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists vectors in this index with pagination\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing vectors array and pagination token or error" - } - ] - }, - { - "tag": "@example", - "name": "List vectors with pagination", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.listVectors({\n maxResults: 500,\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 567, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L567" - } - ], - "parameters": [ - { - "id": 700, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listing options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1311, - "name": "ListVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1320, - "name": "ListVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.listVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.listVectors" - } - }, - { - "id": 692, - "name": "putVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 505, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L505" - } - ], - "signatures": [ - { - "id": 693, - "name": "putVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inserts or updates vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Insert vectors into an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nawait index.putVectors({\n vectors: [\n {\n key: 'doc-1',\n data: { float32: [0.1, 0.2, ...] },\n metadata: { title: 'Introduction', page: 1 }\n }\n ]\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 505, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L505" - } - ], - "parameters": [ - { - "id": 694, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector insertion options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1303, - "name": "PutVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.putVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.putVectors" - } - }, - { - "id": 701, - "name": "queryVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 603, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L603" - } - ], - "signatures": [ - { - "id": 702, - "name": "queryVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Queries for similar vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing matches array of similar vectors ordered by distance or error" - } - ] - }, - { - "tag": "@example", - "name": "Query similar vectors", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.queryVectors({\n queryVector: { float32: [0.1, 0.2, ...] },\n topK: 5,\n filter: { category: 'technical' },\n returnDistance: true,\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 603, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L603" - } - ], - "parameters": [ - { - "id": 703, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1324, - "name": "QueryVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1332, - "name": "QueryVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.queryVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.queryVectors" - } - }, - { - "id": 724, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 725, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 726, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 727, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.setHeader" - } - }, - { - "id": 722, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 723, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [673] - }, - { - "title": "Methods", - "children": [704, 695, 698, 692, 701, 724, 722] - } - ], - "categories": [ - { - "title": "Other", - "children": [724, 722] - }, - { - "title": "Storage", - "children": [673, 704, 695, 698, 692, 701] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 446, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L446" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 536, - "name": "StorageVectorsClientOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for the Storage Vectors client\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 541, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation (optional)\nUseful for testing or custom request handling" - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 542, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 543, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 544, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 545, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 546, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 547, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 548, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 537, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers to include in all requests" - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 538, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "indexSignatures": [ - { - "id": 539, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "parameters": [ - { - "id": 540, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [541, 537] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 26, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L26" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [549, 604, 672] - }, - { - "title": "Interfaces", - "children": [536] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L1" - } - ] - }, - { - "id": 740, - "name": "packages/StreamDownloadBuilder", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 741, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 742, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L8" - } - ], - "signatures": [ - { - "id": 743, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L8" - } - ], - "parameters": [ - { - "id": 744, - "name": "downloadFn", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 9, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L9" - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 9, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L9" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 747, - "name": "shouldThrowOnError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": 741, - "name": "StreamDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 781, - "name": "[toStringTag]", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 5, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L5" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'StreamDownloadBuilder'", - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.[toStringTag]" - } - }, - { - "id": 765, - "name": "catch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L22" - } - ], - "signatures": [ - { - "id": 766, - "name": "catch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback for only the rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L22" - } - ], - "typeParameters": [ - { - "id": 767, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 768, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 23, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L23" - } - ], - "signatures": [ - { - "id": 770, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 23, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L23" - } - ], - "parameters": [ - { - "id": 771, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - }, - { - "id": 772, - "name": "finally", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "signatures": [ - { - "id": 773, - "name": "finally", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\nresolved value cannot be modified from the callback." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "parameters": [ - { - "id": 774, - "name": "onfinally", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is settled (fulfilled or rejected)." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "signatures": [ - { - "id": 776, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - }, - { - "id": 753, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L13" - } - ], - "signatures": [ - { - "id": 754, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L13" - } - ], - "typeParameters": [ - { - "id": 755, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - }, - { - "id": 756, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 757, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 758, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 15, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L15" - } - ], - "signatures": [ - { - "id": 759, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 15, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L15" - } - ], - "parameters": [ - { - "id": 760, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 761, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 762, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 17, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L17" - } - ], - "signatures": [ - { - "id": 763, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 17, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L17" - } - ], - "parameters": [ - { - "id": 764, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [742] - }, - { - "title": "Properties", - "children": [781] - }, - { - "title": "Methods", - "children": [765, 772, 753] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 4, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L4" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [741] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L1" - } - ] - }, - { - "id": 782, - "name": "packages/VectorBucketApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorBucketApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorBucketApi.ts#L1" - } - ] - }, - { - "id": 846, - "name": "packages/VectorDataApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorDataApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorDataApi.ts#L1" - } - ] - }, - { - "id": 911, - "name": "packages/VectorIndexApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 912, - "name": "CreateIndexOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for creating a vector index\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 915, - "name": "dataType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L25" - } - ], - "type": { - "type": "reference", - "target": 1252, - "name": "VectorDataType", - "package": "@supabase/storage-js" - } - }, - { - "id": 916, - "name": "dimension", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 917, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L27" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 914, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 918, - "name": "metadataConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L28" - } - ], - "type": { - "type": "reference", - "target": 1250, - "name": "MetadataConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 913, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L23" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [915, 916, 917, 914, 918, 913] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 22, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L22" - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [912] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "children": [1, 2, 46, 135, 260, 535, 740, 782, 846, 911] - } - ], - "packageName": "@supabase/storage-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Storage JS SDK

    \n\n

    JavaScript SDK to interact with Supabase Storage, including file storage and vector embeddings.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/storage-js)](https://www.npmjs.com/package/@supabase/storage-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/storage-js)](https://pkg.pr.new/~/supabase/storage-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Features\n\n- **File Storage**: Upload, download, list, move, and delete files\n- **Access Control**: Public and private buckets with fine-grained permissions\n- **Signed URLs**: Generate time-limited URLs for secure file access\n- **Image Transformations**: On-the-fly image resizing and optimization\n- **Vector Embeddings**: Store and query high-dimensional embeddings with similarity search\n- **Analytics Buckets**: Iceberg table-based buckets optimized for analytical queries and data processing\n\n## Quick Start Guide\n\n### Installing the module\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Connecting to the storage backend\n\nThere are two ways to use the Storage SDK:\n\n#### Option 1: Via Supabase Client (Recommended)\n\nIf you're already using " - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": ", access storage through the client:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Use publishable key for frontend applications\nconst supabase = createClient('https://.supabase.co', '')\n\n// Access storage\nconst storage = supabase.storage\n\n// Access different bucket types\nconst regularBucket = storage.from('my-bucket')\nconst vectorBucket = storage.vectors.from('embeddings-bucket')\nconst analyticsBucket = storage.analytics // Analytics API\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 2: Standalone StorageClient\n\nFor backend applications or when you need to bypass Row Level Security:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { StorageClient } from '@supabase/storage-js'\n\nconst STORAGE_URL = 'https://.supabase.co/storage/v1'\nconst SERVICE_KEY = '' // Use secret key for backend operations\n\nconst storageClient = new StorageClient(STORAGE_URL, {\n apikey: SERVICE_KEY,\n Authorization: `Bearer ${SERVICE_KEY}`,\n})\n\n// Access different bucket types\nconst regularBucket = storageClient.from('my-bucket')\nconst vectorBucket = storageClient.vectors.from('embeddings-bucket')\nconst analyticsBucket = storageClient.analytics // Analytics API\n```" - }, - { - "kind": "text", - "text": "\n\n> **When to use each approach:**\n>\n> - Use " - }, - { - "kind": "code", - "text": "`supabase.storage`" - }, - { - "kind": "text", - "text": " when working with other Supabase features (auth, database, etc.) in frontend applications\n> - Use " - }, - { - "kind": "code", - "text": "`new StorageClient()`" - }, - { - "kind": "text", - "text": " for backend applications, Edge Functions, or when you need to bypass RLS policies\n\n> **Note:** Refer to the [Storage Access Control guide](https://supabase.com/docs/guides/storage/access-control) for detailed information on creating RLS policies.\n\n### Understanding Bucket Types\n\nSupabase Storage supports three types of buckets, each optimized for different use cases:\n\n#### 1. Regular Storage Buckets (File Storage)\n\nStandard buckets for storing files, images, videos, and other assets.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create regular storage bucket\nconst { data, error } = await storageClient.createBucket('my-files', {\n public: false,\n})\n\n// Upload files\nawait storageClient.from('my-files').upload('avatar.png', file)\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** User uploads, media assets, documents, backups\n\n#### 2. Vector Buckets (Embeddings Storage)\n\nSpecialized buckets for storing and querying high-dimensional vector embeddings.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create vector bucket\nawait storageClient.vectors.createBucket('embeddings-prod')\n\n// Create index and insert vectors\nconst bucket = storageClient.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents',\n dimension: 1536,\n distanceMetric: 'cosine',\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** Semantic search, AI-powered recommendations, similarity matching\n\n**[See full Vector Embeddings documentation below](#vector-embeddings)**\n\n#### 3. Analytics Buckets\n\nSpecialized buckets using Apache Iceberg table format, optimized for analytical queries and large-scale data processing.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create analytics bucket\nawait storageClient.analytics.createBucket('analytics-data')\n\n// List analytics buckets\nconst { data, error } = await storageClient.analytics.listBuckets()\n\n// Delete analytics bucket\nawait storageClient.analytics.deleteBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** Time-series data, analytical queries, data lakes, large-scale data processing, business intelligence\n\n**[See full Analytics Buckets documentation below](#analytics-buckets)**\n\n---\n\n### Handling resources\n\n#### Handling Storage Buckets\n\n- Create a new Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.createBucket(\n 'test_bucket', // Bucket name (must be unique)\n { public: false } // Bucket options\n )\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve the details of an existing Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.getBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Update a new Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.updateBucket(\n 'test_bucket', // Bucket name\n { public: false } // Bucket options\n )\n ```" - }, - { - "kind": "text", - "text": "\n\n- Remove all objects inside a single bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.emptyBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Delete an existing bucket (a bucket can't be deleted with existing objects inside it):\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.deleteBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve the details of all Storage buckets within an existing project:\n\n " - }, - { - "kind": "code", - "text": "```js\n // List all buckets\n const { data, error } = await storageClient.listBuckets()\n\n // List buckets with options (pagination, sorting, search)\n const { data, error } = await storageClient.listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod',\n })\n ```" - }, - { - "kind": "text", - "text": "\n\n#### Handling Files\n\n- Upload a file to an existing bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const fileBody = ... // load your file here\n\n const { data, error } = await storageClient.from('bucket').upload('path/to/file', fileBody)\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: \n > The path in " - }, - { - "kind": "code", - "text": "`data.Key`" - }, - { - "kind": "text", - "text": " is prefixed by the bucket ID and is not the value which should be passed to the " - }, - { - "kind": "code", - "text": "`download`" - }, - { - "kind": "text", - "text": " method in order to fetch the file. \n > To fetch the file via the " - }, - { - "kind": "code", - "text": "`download`" - }, - { - "kind": "text", - "text": " method, use " - }, - { - "kind": "code", - "text": "`data.path`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`data.bucketId`" - }, - { - "kind": "text", - "text": " as follows:\n >\n > " - }, - { - "kind": "code", - "text": "```javascript\n > const { data, error } = await storageClient.from('bucket').upload('/folder/file.txt', fileBody)\n > // check for errors\n > const { data2, error2 } = await storageClient.from(data.bucketId).download(data.path)\n > ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`upload`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).\n\n- Download a file from an exisiting bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').download('path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n- List all the files within a bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').list('folder')\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`list`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-list).\n\n- Replace an existing file at the specified path with a new one:\n\n " - }, - { - "kind": "code", - "text": "```js\n const fileBody = ... // load your file here\n\n const { data, error } = await storageClient\n .from('bucket')\n .update('path/to/file', fileBody)\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`upload`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).\n\n- Move an existing file:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient\n .from('bucket')\n .move('old/path/to/file', 'new/path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Delete files within the same bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').remove(['path/to/file'])\n ```" - }, - { - "kind": "text", - "text": "\n\n- Create signed URL to download file without requiring permissions:\n\n " - }, - { - "kind": "code", - "text": "```js\n const expireIn = 60\n\n const { data, error } = await storageClient\n .from('bucket')\n .createSignedUrl('path/to/file', expireIn)\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve URLs for assets in public buckets:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('public-bucket').getPublicUrl('path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n## Analytics Buckets\n\nSupabase Storage provides specialized analytics buckets using Apache Iceberg table format, optimized for analytical workloads and large-scale data processing. These buckets are designed for data lake architectures, time-series data, and business intelligence applications.\n\n### What are Analytics Buckets?\n\nAnalytics buckets use the Apache Iceberg open table format, providing:\n\n- **ACID transactions** for data consistency\n- **Schema evolution** without data rewrites\n- **Time travel** to query historical data\n- **Efficient metadata management** for large datasets\n- **Optimized for analytical queries** rather than individual file operations\n\n### When to Use Analytics Buckets\n\n**Use analytics buckets for:**\n\n- Time-series data (logs, metrics, events)\n- Data lake architectures\n- Business intelligence and reporting\n- Large-scale batch processing\n- Analytical workloads requiring ACID guarantees\n\n**Use regular storage buckets for:**\n\n- User file uploads (images, documents, videos)\n- Individual file management\n- Content delivery\n- Simple object storage needs\n\n### Quick Start\n\nYou can access analytics functionality through the " - }, - { - "kind": "code", - "text": "`analytics`" - }, - { - "kind": "text", - "text": " property on your storage client:\n\n#### Via Supabase Client\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')\n\n// Access analytics operations\nconst analytics = supabase.storage.analytics\n\n// Create an analytics bucket\nconst { data, error } = await analytics.createBucket('analytics-data')\nif (error) {\n console.error('Failed to create analytics bucket:', error.message)\n} else {\n console.log('Created bucket:', data.name)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Via StorageClient\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storageClient = new StorageClient('https://your-project.supabase.co/storage/v1', {\n apikey: 'YOUR_API_KEY',\n Authorization: 'Bearer YOUR_TOKEN',\n})\n\n// Access analytics operations\nconst analytics = storageClient.analytics\n\n// Create an analytics bucket\nawait analytics.createBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\n### API Reference\n\n#### Create Analytics Bucket\n\nCreates a new analytics bucket using Iceberg table format:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.createBucket('my-analytics-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n} else {\n console.log('Created bucket:', data)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: {\n id: string\n type: 'ANALYTICS'\n format: string\n created_at: string\n updated_at: string\n } | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### List Analytics Buckets\n\nRetrieves all analytics buckets in your project with optional filtering and pagination:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod',\n})\n\nif (data) {\n console.log(`Found ${data.length} analytics buckets`)\n data.forEach((bucket) => {\n console.log(`- ${bucket.id} (created: ${bucket.created_at})`)\n })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Parameters:**\n\n- " - }, - { - "kind": "code", - "text": "`limit?: number`" - }, - { - "kind": "text", - "text": " - Maximum number of buckets to return\n- " - }, - { - "kind": "code", - "text": "`offset?: number`" - }, - { - "kind": "text", - "text": " - Number of buckets to skip (for pagination)\n- " - }, - { - "kind": "code", - "text": "`sortColumn?: 'id' | 'name' | 'created_at' | 'updated_at'`" - }, - { - "kind": "text", - "text": " - Column to sort by\n- " - }, - { - "kind": "code", - "text": "`sortOrder?: 'asc' | 'desc'`" - }, - { - "kind": "text", - "text": " - Sort direction\n- " - }, - { - "kind": "code", - "text": "`search?: string`" - }, - { - "kind": "text", - "text": " - Search term to filter bucket names\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: AnalyticBucket[] | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Example with Pagination:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Fetch first page\nconst firstPage = await analytics.listBuckets({\n limit: 100,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n})\n\n// Fetch second page\nconst secondPage = await analytics.listBuckets({\n limit: 100,\n offset: 100,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Delete Analytics Bucket\n\nDeletes an analytics bucket. The bucket must be empty before deletion.\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.deleteBucket('old-analytics-bucket')\n\nif (error) {\n console.error('Failed to delete:', error.message)\n} else {\n console.log('Bucket deleted:', data.message)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: { message: string } | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n> **Note:** A bucket cannot be deleted if it contains data. You must empty the bucket first.\n\n#### Get Iceberg Catalog for Advanced Operations\n\nFor advanced operations like creating tables, namespaces, and querying Iceberg metadata, use the " - }, - { - "kind": "code", - "text": "`from()`" - }, - { - "kind": "text", - "text": " method to get a configured [iceberg-js](https://github.com/supabase/iceberg-js) client:\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Get an Iceberg REST Catalog client for your analytics bucket\nconst catalog = analytics.from('analytics-data')\n\n// Create a namespace\nawait catalog.createNamespace({ namespace: ['default'] }, { properties: { owner: 'data-team' } })\n\n// Create a table with schema\nawait catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false },\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1],\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: [],\n },\n 'write-order': {\n 'order-id': 0,\n fields: [],\n },\n properties: {\n 'write.format.default': 'parquet',\n },\n }\n)\n\n// List tables in namespace\nconst tables = await catalog.listTables({ namespace: ['default'] })\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n\n// Load table metadata\nconst table = await catalog.loadTable({ namespace: ['default'], name: 'events' })\n\n// Update table properties\nawait catalog.updateTable(\n { namespace: ['default'], name: 'events' },\n { properties: { 'read.split.target-size': '134217728' } }\n)\n\n// Drop table\nawait catalog.dropTable({ namespace: ['default'], name: 'events' })\n\n// Drop namespace\nawait catalog.dropNamespace({ namespace: ['default'] })\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:** " - }, - { - "kind": "code", - "text": "`IcebergRestCatalog`" - }, - { - "kind": "text", - "text": " instance from [iceberg-js](https://github.com/supabase/iceberg-js)\n\n> **Note:** The " - }, - { - "kind": "code", - "text": "`from()`" - }, - { - "kind": "text", - "text": " method returns an Iceberg REST Catalog client that provides full access to the Apache Iceberg REST API. For complete documentation of available operations, see the [iceberg-js documentation](https://supabase.github.io/iceberg-js/).\n\n### Error Handling\n\nAnalytics buckets use the same error handling pattern as the rest of the Storage SDK:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.createBucket('my-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n console.error('Status:', error.status)\n console.error('Status Code:', error.statusCode)\n // Handle error appropriately\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Throwing Errors\n\nYou can configure the client to throw errors instead of returning them:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst analytics = storageClient.analytics\nanalytics.throwOnError()\n\ntry {\n const { data } = await analytics.createBucket('my-bucket')\n // data is guaranteed to be present\n console.log('Success:', data)\n} catch (error) {\n if (error instanceof StorageApiError) {\n console.error('API Error:', error.statusCode, error.message)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### TypeScript Types\n\nThe library exports TypeScript types for analytics buckets:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport type { AnalyticBucket, BucketType, StorageError } from '@supabase/storage-js'\n\n// AnalyticBucket type\ninterface AnalyticBucket {\n id: string\n type: 'ANALYTICS'\n format: string\n created_at: string\n updated_at: string\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### Common Patterns\n\n#### Checking if a Bucket Exists\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function bucketExists(bucketName: string): Promise {\n const { data, error } = await analytics.listBuckets({\n search: bucketName,\n })\n\n if (error) {\n console.error('Error checking bucket:', error.message)\n return false\n }\n\n return data?.some((bucket) => bucket.id === bucketName) ?? false\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Creating Bucket with Error Handling\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function ensureAnalyticsBucket(bucketName: string) {\n // Try to create the bucket\n const { data, error } = await analytics.createBucket(bucketName)\n\n if (error) {\n // Check if bucket already exists (conflict error)\n if (error.statusCode === '409') {\n console.log(`Bucket '${bucketName}' already exists`)\n return { success: true, created: false }\n }\n\n // Other error occurred\n console.error('Failed to create bucket:', error.message)\n return { success: false, error }\n }\n\n console.log(`Created new bucket: '${bucketName}'`)\n return { success: true, created: true, data }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Listing All Buckets with Pagination\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function getAllAnalyticsBuckets() {\n const allBuckets: AnalyticBucket[] = []\n let offset = 0\n const limit = 100\n\n while (true) {\n const { data, error } = await analytics.listBuckets({\n limit,\n offset,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n })\n\n if (error) {\n console.error('Error fetching buckets:', error.message)\n break\n }\n\n if (!data || data.length === 0) {\n break\n }\n\n allBuckets.push(...data)\n\n // If we got fewer results than the limit, we've reached the end\n if (data.length < limit) {\n break\n }\n\n offset += limit\n }\n\n return allBuckets\n}\n```" - }, - { - "kind": "text", - "text": "\n\n## Vector Embeddings\n\nSupabase Storage provides built-in support for storing and querying high-dimensional vector embeddings, powered by S3 Vectors. This enables semantic search, similarity matching, and AI-powered applications without needing a separate vector database.\n\n> **Note:** Vector embeddings functionality is available in " - }, - { - "kind": "code", - "text": "`@supabase/storage-js`" - }, - { - "kind": "text", - "text": " v2.76 and later.\n\n### Features\n\n- **Vector Buckets**: Organize vector indexes into logical containers\n- **Vector Indexes**: Define schemas with configurable dimensions and distance metrics\n- **Batch Operations**: Insert/update/delete up to 500 vectors per request\n- **Similarity Search**: Query for nearest neighbors using cosine, euclidean, or dot product distance\n- **Metadata Filtering**: Store and filter vectors by arbitrary JSON metadata\n- **Pagination**: Efficiently scan large vector datasets\n- **Parallel Scanning**: Distribute scans across multiple workers for high throughput\n- **Cross-platform**: Works in Node.js, browsers, and edge runtimes\n\n### Quick Start\n\nYou can access vector functionality in three ways, depending on your use case:\n\n#### Option 1: Via Supabase Client (Most Common)\n\nIf you're using the full Supabase client:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')\n\n// Access vector operations through storage\nconst vectors = supabase.storage.vectors\n\n// Create a vector bucket\nawait vectors.createBucket('embeddings-prod')\n\n// Create an index\nconst bucket = vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents-openai',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine',\n})\n\n// Insert vectors\nconst index = bucket.index('documents-openai')\nawait index.putVectors({\n vectors: [\n {\n key: 'doc-1',\n data: { float32: [0.1, 0.2, 0.3 /* ...1536 dimensions */] },\n metadata: { title: 'Introduction', category: 'docs' },\n },\n ],\n})\n\n// Query similar vectors\nconst { data, error } = await index.queryVectors({\n queryVector: { float32: [0.15, 0.25, 0.35 /* ...1536 dimensions */] },\n topK: 5,\n returnDistance: true,\n returnMetadata: true,\n})\n\nif (data) {\n data.matches.forEach((match) => {\n console.log(`${match.key}: distance=${match.distance}`)\n console.log('Metadata:', match.metadata)\n })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 2: Via StorageClient\n\nIf you're using the standalone " - }, - { - "kind": "code", - "text": "`StorageClient`" - }, - { - "kind": "text", - "text": " for storage operations, access vectors through the " - }, - { - "kind": "code", - "text": "`vectors`" - }, - { - "kind": "text", - "text": " property:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storageClient = new StorageClient('https://your-project.supabase.co/storage/v1', {\n apikey: 'YOUR_API_KEY',\n Authorization: 'Bearer YOUR_TOKEN',\n})\n\n// Access vector operations\nconst vectors = storageClient.vectors\n\n// Use the same API as shown in Option 1\nawait vectors.createBucket('embeddings-prod')\nconst bucket = vectors.from('embeddings-prod')\n// ... rest of operations\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 3: Standalone Vector Client\n\nFor vector-only applications that don't need regular file storage operations:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\n// Initialize standalone vector client\nconst vectorClient = new StorageVectorsClient('https://your-project.supabase.co/storage/v1', {\n headers: { Authorization: 'Bearer YOUR_TOKEN' },\n})\n\n// Use the same API as shown in Option 1\nawait vectorClient.createBucket('embeddings-prod')\nconst bucket = vectorClient.from('embeddings-prod')\n// ... rest of operations\n```" - }, - { - "kind": "text", - "text": "\n\n> **When to use each approach:**\n>\n> - **Option 1**: When using other Supabase features (auth, database, realtime)\n> - **Option 2**: When working with both file storage and vectors\n> - **Option 3**: For dedicated vector-only applications without file storage\n\n### API Reference\n\n#### Client Initialization\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst vectorClient = new StorageVectorsClient(url, options?)\n```" - }, - { - "kind": "text", - "text": "\n\n**Options:**\n\n- " - }, - { - "kind": "code", - "text": "`headers?: Record`" - }, - { - "kind": "text", - "text": " - Custom HTTP headers (e.g., Authorization)\n- " - }, - { - "kind": "code", - "text": "`fetch?: Fetch`" - }, - { - "kind": "text", - "text": " - Custom fetch implementation\n\n#### Vector Buckets\n\nVector buckets are top-level containers for organizing vector indexes.\n\n##### Create Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.createBucket('my-bucket')\n```" - }, - { - "kind": "text", - "text": "\n\n##### Get Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.getBucket('my-bucket')\nconsole.log('Created at:', new Date(data.vectorBucket.creationTime! * 1000))\n```" - }, - { - "kind": "text", - "text": "\n\n##### List Buckets\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.listBuckets({\n prefix: 'prod-',\n maxResults: 100,\n})\n\n// Pagination\nif (data?.nextToken) {\n const next = await vectorClient.listBuckets({ nextToken: data.nextToken })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n##### Delete Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Bucket must be empty (all indexes deleted first)\nconst { error } = await vectorClient.deleteBucket('my-bucket')\n```" - }, - { - "kind": "text", - "text": "\n\n#### Vector Indexes\n\nVector indexes define the schema for embeddings including dimension and distance metric.\n\n##### Create Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst bucket = vectorClient.from('my-bucket')\n\nawait bucket.createIndex({\n indexName: 'my-index',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine', // 'cosine' | 'euclidean' | 'dotproduct'\n metadataConfiguration: {\n nonFilterableMetadataKeys: ['raw_text', 'internal_id'],\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Distance Metrics:**\n\n- " - }, - { - "kind": "code", - "text": "`cosine`" - }, - { - "kind": "text", - "text": " - Cosine similarity (normalized dot product)\n- " - }, - { - "kind": "code", - "text": "`euclidean`" - }, - { - "kind": "text", - "text": " - Euclidean distance (L2 norm)\n- " - }, - { - "kind": "code", - "text": "`dotproduct`" - }, - { - "kind": "text", - "text": " - Dot product similarity\n\n##### Get Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await bucket.getIndex('my-index')\nconsole.log('Dimension:', data?.index.dimension)\nconsole.log('Distance metric:', data?.index.distanceMetric)\n```" - }, - { - "kind": "text", - "text": "\n\n##### List Indexes\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await bucket.listIndexes({\n prefix: 'documents-',\n maxResults: 100,\n})\n```" - }, - { - "kind": "text", - "text": "\n\n##### Delete Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Deletes index and all its vectors\nawait bucket.deleteIndex('my-index')\n```" - }, - { - "kind": "text", - "text": "\n\n#### Vector Operations\n\n##### Insert/Update Vectors (Upsert)\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst index = vectorClient.from('my-bucket').index('my-index')\n\nawait index.putVectors({\n vectors: [\n {\n key: 'unique-id-1',\n data: {\n float32: [\n /* 1536 numbers */\n ],\n },\n metadata: {\n title: 'Document Title',\n category: 'technical',\n page: 1,\n },\n },\n // ... up to 500 vectors per request\n ],\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Limitations:**\n\n- 1-500 vectors per request\n- Vectors must match index dimension\n- Keys must be unique within index\n\n##### Get Vectors by Key\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await index.getVectors({\n keys: ['doc-1', 'doc-2', 'doc-3'],\n returnData: true, // Include embeddings\n returnMetadata: true, // Include metadata\n})\n\ndata?.vectors.forEach((v) => {\n console.log(v.key, v.metadata)\n})\n```" - }, - { - "kind": "text", - "text": "\n\n##### Query Similar Vectors (ANN Search)\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await index.queryVectors({\n queryVector: {\n float32: [\n /* 1536 numbers */\n ],\n },\n topK: 10,\n filter: {\n category: 'technical',\n published: true,\n },\n returnDistance: true,\n returnMetadata: true,\n})\n\n// Results ordered by similarity\ndata?.matches.forEach((match) => {\n console.log(`${match.key}: distance=${match.distance}`)\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Filter Syntax:**\nThe " - }, - { - "kind": "code", - "text": "`filter`" - }, - { - "kind": "text", - "text": " parameter accepts arbitrary JSON for metadata filtering. Non-filterable keys (configured at index creation) cannot be used in filters but can still be returned.\n\n##### List/Scan Vectors\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Simple pagination\nlet nextToken: string | undefined\ndo {\n const { data } = await index.listVectors({\n maxResults: 500,\n nextToken,\n returnMetadata: true,\n })\n\n console.log('Batch:', data?.vectors.length)\n nextToken = data?.nextToken\n} while (nextToken)\n\n// Parallel scanning (4 workers)\nconst workers = [0, 1, 2, 3].map(async (segmentIndex) => {\n const { data } = await index.listVectors({\n segmentCount: 4,\n segmentIndex,\n returnMetadata: true,\n })\n return data?.vectors || []\n})\n\nconst results = await Promise.all(workers)\nconst allVectors = results.flat()\n```" - }, - { - "kind": "text", - "text": "\n\n**Limitations:**\n\n- " - }, - { - "kind": "code", - "text": "`maxResults`" - }, - { - "kind": "text", - "text": ": 1-1000 (default: 500)\n- " - }, - { - "kind": "code", - "text": "`segmentCount`" - }, - { - "kind": "text", - "text": ": 1-16\n- Response may be limited by 1MB size\n\n##### Delete Vectors\n\n" - }, - { - "kind": "code", - "text": "```typescript\nawait index.deleteVectors({\n keys: ['doc-1', 'doc-2', 'doc-3'],\n // ... up to 500 keys per request\n})\n```" - }, - { - "kind": "text", - "text": "\n\n### Error Handling\n\nThe library uses a consistent error handling pattern:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.createBucket('my-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n console.error('Status:', error.status)\n console.error('Code:', error.statusCode)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Error Codes\n\n| Code | HTTP | Description |\n| ---------------------------- | ---- | ----------------------- |\n| " - }, - { - "kind": "code", - "text": "`InternalError`" - }, - { - "kind": "text", - "text": " | 500 | Internal server error |\n| " - }, - { - "kind": "code", - "text": "`S3VectorConflictException`" - }, - { - "kind": "text", - "text": " | 409 | Resource already exists |\n| " - }, - { - "kind": "code", - "text": "`S3VectorNotFoundException`" - }, - { - "kind": "text", - "text": " | 404 | Resource not found |\n| " - }, - { - "kind": "code", - "text": "`S3VectorBucketNotEmpty`" - }, - { - "kind": "text", - "text": " | 400 | Bucket contains indexes |\n| " - }, - { - "kind": "code", - "text": "`S3VectorMaxBucketsExceeded`" - }, - { - "kind": "text", - "text": " | 400 | Bucket quota exceeded |\n| " - }, - { - "kind": "code", - "text": "`S3VectorMaxIndexesExceeded`" - }, - { - "kind": "text", - "text": " | 400 | Index quota exceeded |\n\n#### Throwing Errors\n\nYou can configure the client to throw errors instead:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst vectorClient = new StorageVectorsClient(url, options)\nvectorClient.throwOnError()\n\ntry {\n const { data } = await vectorClient.createBucket('my-bucket')\n // data is guaranteed to be present\n} catch (error) {\n if (error instanceof StorageVectorsApiError) {\n console.error('API Error:', error.statusCode)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### Advanced Usage\n\n#### Scoped Clients\n\nCreate scoped clients for cleaner code:\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Bucket-scoped operations\nconst bucket = vectorClient.from('embeddings-prod')\nawait bucket.createIndex({\n /* ... */\n})\nawait bucket.listIndexes()\n\n// Index-scoped operations\nconst index = bucket.index('documents-openai')\nawait index.putVectors({\n /* ... */\n})\nawait index.queryVectors({\n /* ... */\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Custom Fetch\n\nProvide a custom fetch implementation:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\nconst vectorClient = new StorageVectorsClient(url, {\n fetch: customFetch,\n headers: {\n /* ... */\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Batch Processing\n\nProcess large datasets in batches:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function insertLargeDataset(vectors: VectorObject[]) {\n const batchSize = 500\n\n for (let i = 0; i < vectors.length; i += batchSize) {\n const batch = vectors.slice(i, i + batchSize)\n await index.putVectors({ vectors: batch })\n console.log(`Inserted ${i + batch.length}/${vectors.length}`)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Float32 Validation\n\nEnsure vectors are properly normalized to float32:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { normalizeToFloat32 } from '@supabase/storage-js'\n\nconst vector = normalizeToFloat32([0.1, 0.2, 0.3 /* ... */])\n```" - }, - { - "kind": "text", - "text": "\n\n### Type Definitions\n\nThe library exports comprehensive TypeScript types:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport type {\n VectorBucket,\n VectorIndex,\n VectorData,\n VectorObject,\n VectorMatch,\n VectorMetadata,\n DistanceMetric,\n ApiResponse,\n StorageVectorsError,\n} from '@supabase/storage-js'\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n#### Build Scripts Overview\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Build the package\npnpm nx build storage-js\n\n# Watch mode for development\npnpm nx build storage-js --watch\n\n# Generate documentation\npnpm nx docs storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\n**Important:** The storage-js tests require a local Supabase stack running via the Supabase CLI. Docker must be running since the Supabase CLI uses it internally.\n\n#### Prerequisites\n\n1. **Docker** must be installed and running (used by Supabase CLI internally)\n2. **Supabase CLI** — installed automatically via " - }, - { - "kind": "code", - "text": "`pnpm exec supabase`" - }, - { - "kind": "text", - "text": "\n\n#### Test Scripts Overview\n\n| Script | Description | What it does |\n| ----------------- | --------------------------------- | ----------------------------------------------------------------- |\n| " - }, - { - "kind": "code", - "text": "`test:storage`" - }, - { - "kind": "text", - "text": " | **Complete test workflow** | Runs the full test cycle: clean → start infra → run tests → clean |\n| " - }, - { - "kind": "code", - "text": "`test:suite`" - }, - { - "kind": "text", - "text": " | **Jest tests only** | Runs Jest tests with coverage (requires infra to be running) |\n| " - }, - { - "kind": "code", - "text": "`test:infra`" - }, - { - "kind": "text", - "text": " | **Start test infrastructure** | Starts Supabase CLI stack (PostgreSQL, Storage API, Kong, etc.) |\n| " - }, - { - "kind": "code", - "text": "`test:clean-post`" - }, - { - "kind": "text", - "text": " | **Stop and clean infrastructure** | Stops the Supabase CLI stack |\n\n#### Running Tests\n\n##### Option 1: Complete Test Run (Recommended)\n\nThis handles everything automatically - starting infrastructure, running tests, and cleaning up:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From monorepo root\npnpm nx test:storage storage-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command will:\n\n1. Stop any existing test containers\n2. Build and start fresh test infrastructure\n3. Wait for services to be ready\n4. Run all Jest tests with coverage\n5. Clean up all containers after tests complete\n\n##### Option 2: Manual Infrastructure Management\n\nUseful for development when you want to run tests multiple times without restarting Docker:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Step 1: Start the test infrastructure\n# From root\npnpm nx test:infra storage-js\n# This starts: PostgreSQL, Storage API, Kong Gateway, and imgproxy\n\n# Step 2: Run tests (can run multiple times)\npnpm nx test:suite storage-js\n\n# Step 3: When done, clean up the infrastructure\npnpm nx test:clean-post storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n##### Option 3: Development Mode\n\nFor actively developing and debugging tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Start infrastructure once (from root)\npnpm nx test:infra storage-js\n\n# Run tests in watch mode\npnpm nx test:suite storage-js --watch\n\n# Clean up when done\npnpm nx test:clean-post storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure Details\n\nThe test infrastructure is managed via the Supabase CLI (" - }, - { - "kind": "code", - "text": "`pnpm exec supabase start --workdir test`" - }, - { - "kind": "text", - "text": "), which starts a local Supabase stack defined by the config in " - }, - { - "kind": "code", - "text": "`test/`" - }, - { - "kind": "text", - "text": ". This includes PostgreSQL, the Storage API, Kong Gateway, and supporting services.\n\n#### Common Issues and Solutions\n\n| Issue | Solution |\n| --------------------------------- | ------------------------------------------------------------------------------------------------- |\n| Port conflicts | Another service is using a required port. Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:clean-post storage-js`" - }, - { - "kind": "text", - "text": " then try again |\n| \"request failed, reason:\" errors | Infrastructure isn't running. Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:infra storage-js`" - }, - { - "kind": "text", - "text": " first |\n| Tests fail with connection errors | Ensure Docker is running (Supabase CLI requires Docker) |\n| Stack already running | Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:clean-post storage-js`" - }, - { - "kind": "text", - "text": " to stop it before restarting |\n\n#### Understanding Test Failures\n\n- **StorageUnknownError with \"request failed\"**: Infrastructure not running\n- **Snapshot failures**: Expected test data has changed — review and update snapshots if needed\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 11 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "2": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "" - }, - "3": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "5": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default" - }, - "6": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "downloadFn" - }, - "7": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "8": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "9": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "shouldThrowOnError" - }, - "15": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.asStream" - }, - "16": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.asStream" - }, - "17": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "18": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "19": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult1" - }, - "20": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult2" - }, - "21": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "22": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "23": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "24": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "value" - }, - "25": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "26": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "27": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "28": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "29": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "30": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "31": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult" - }, - "32": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "33": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "34": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "35": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "36": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "37": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "38": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onfinally" - }, - "39": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "40": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "45": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.[toStringTag]" - }, - "46": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "" - }, - "47": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "WrappedIcebergRestCatalog" - }, - "48": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default" - }, - "49": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.__constructor" - }, - "50": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default" - }, - "51": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "url" - }, - "52": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "headers" - }, - "53": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "54": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.__index" - }, - "56": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "fetch" - }, - "57": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "58": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "59": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "60": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "61": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "62": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "63": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "64": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.createBucket" - }, - "65": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.createBucket" - }, - "66": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "name" - }, - "67": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "69": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "70": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "71": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "72": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "73": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.listBuckets" - }, - "74": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.listBuckets" - }, - "75": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "options" - }, - "76": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "77": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.limit" - }, - "78": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.offset" - }, - "79": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.sortColumn" - }, - "80": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.sortOrder" - }, - "81": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.search" - }, - "82": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "83": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "84": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "85": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "86": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "87": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "88": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.deleteBucket" - }, - "89": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.deleteBucket" - }, - "90": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "bucketName" - }, - "91": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "92": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "93": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.message" - }, - "95": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "96": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "97": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "98": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "99": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.from" - }, - "100": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.from" - }, - "101": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "bucketName" - }, - "117": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "118": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "119": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "120": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "121": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "122": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "135": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "" - }, - "136": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default" - }, - "137": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.__constructor" - }, - "138": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default" - }, - "139": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "url" - }, - "140": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "headers" - }, - "141": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "142": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.__index" - }, - "144": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "fetch" - }, - "145": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "146": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "147": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "148": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "149": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "150": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "151": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "152": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "opts" - }, - "153": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "154": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "155": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "156": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "157": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "158": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "159": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "160": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "161": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "162": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "163": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "164": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "165": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "166": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "167": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "168": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "169": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "170": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "171": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "172": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "173": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "174": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "175": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "176": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "177": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "178": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "179": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.type" - }, - "180": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "181": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "182": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "183": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "184": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "185": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "186": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "187": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "188": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "189": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "190": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "191": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "192": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "193": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "194": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "195": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "196": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "197": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "198": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "199": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "200": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "201": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "202": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "203": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "204": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "205": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "206": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "207": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "208": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "209": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "210": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "211": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "212": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "213": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "214": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "215": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "216": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "217": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "218": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "219": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "220": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "221": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "222": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "223": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "242": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "243": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "244": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "245": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "246": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "247": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "260": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "" - }, - "261": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default" - }, - "262": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.__constructor" - }, - "263": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default" - }, - "264": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "url" - }, - "265": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "headers" - }, - "266": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "267": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.__index" - }, - "269": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "bucketId" - }, - "270": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fetch" - }, - "271": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "272": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "273": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "274": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "275": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "276": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "277": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "295": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.upload" - }, - "296": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.upload" - }, - "297": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "298": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "299": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "300": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "301": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "302": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "303": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.id" - }, - "304": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "305": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.fullPath" - }, - "306": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "307": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "308": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "309": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "310": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.uploadToSignedUrl" - }, - "311": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.uploadToSignedUrl" - }, - "312": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "313": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "token" - }, - "314": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "315": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "316": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type" - }, - "317": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.data" - }, - "318": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.error" - }, - "319": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type" - }, - "320": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.data" - }, - "321": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object" - }, - "322": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object.path" - }, - "323": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object.fullPath" - }, - "324": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.error" - }, - "325": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUploadUrl" - }, - "326": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUploadUrl" - }, - "327": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "328": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "329": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "330": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.upsert" - }, - "331": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "332": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "333": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "334": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "335": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.token" - }, - "336": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "337": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "338": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "339": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "340": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "341": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.update" - }, - "342": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.update" - }, - "343": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "344": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "345": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "346": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "347": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "348": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "349": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.id" - }, - "350": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "351": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.fullPath" - }, - "352": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "353": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "354": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "355": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "356": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.move" - }, - "357": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.move" - }, - "358": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fromPath" - }, - "359": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "toPath" - }, - "360": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "361": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "362": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "363": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "364": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.message" - }, - "365": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "366": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "367": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "368": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "369": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.copy" - }, - "370": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.copy" - }, - "371": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fromPath" - }, - "372": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "toPath" - }, - "373": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "374": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "375": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "376": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "377": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "378": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "379": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "380": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "381": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "382": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrl" - }, - "383": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrl" - }, - "384": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "385": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "expiresIn" - }, - "386": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "387": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "388": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "389": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "390": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "391": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "392": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "393": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "394": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "395": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "396": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "397": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "398": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "399": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrls" - }, - "400": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrls" - }, - "401": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "paths" - }, - "402": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "expiresIn" - }, - "403": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "404": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "405": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "406": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "407": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "408": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "409": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "410": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "411": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "412": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "413": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "414": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "415": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "416": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "417": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.download" - }, - "418": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.download" - }, - "419": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "Options" - }, - "420": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "421": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "422": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "423": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "424": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "425": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "426": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.info" - }, - "427": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.info" - }, - "428": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "429": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "430": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "431": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "432": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "433": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "434": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "435": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.exists" - }, - "436": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.exists" - }, - "437": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "438": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "439": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "440": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "441": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "442": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "443": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "444": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.getPublicUrl" - }, - "445": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.getPublicUrl" - }, - "446": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "447": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "448": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "449": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "450": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "451": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "452": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "454": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "455": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.publicUrl" - }, - "456": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.remove" - }, - "457": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.remove" - }, - "458": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "paths" - }, - "459": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "460": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "461": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "462": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "463": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "464": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "465": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.list" - }, - "466": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.list" - }, - "467": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "468": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "469": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "470": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "471": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "472": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "473": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "474": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "475": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "476": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.listV2" - }, - "477": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.listV2" - }, - "478": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "479": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "480": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "481": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "482": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "483": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "484": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "485": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "489": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.toBase64" - }, - "490": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.toBase64" - }, - "491": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "data" - }, - "517": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "518": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "519": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "520": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "521": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "522": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "535": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "" - }, - "536": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions" - }, - "537": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions.headers" - }, - "538": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "539": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "541": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions.fetch" - }, - "542": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "543": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "544": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "545": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "546": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "547": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "548": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "549": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient" - }, - "550": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.__constructor" - }, - "551": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient" - }, - "552": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "553": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "554": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.from" - }, - "555": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.from" - }, - "556": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "557": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.createBucket" - }, - "558": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.createBucket" - }, - "559": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "560": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.getBucket" - }, - "561": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.getBucket" - }, - "562": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "563": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "564": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.vectorBucket" - }, - "565": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.listBuckets" - }, - "566": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.listBuckets" - }, - "567": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "568": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.deleteBucket" - }, - "569": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.deleteBucket" - }, - "570": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "586": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "587": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "588": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "589": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "590": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "591": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "604": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope" - }, - "605": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.__constructor" - }, - "606": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope" - }, - "607": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "608": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "headers" - }, - "609": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "610": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "612": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "613": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "fetch" - }, - "614": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "615": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "616": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "617": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "618": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "619": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "620": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "622": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.createIndex" - }, - "623": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.createIndex" - }, - "624": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "625": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.listIndexes" - }, - "626": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.listIndexes" - }, - "627": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "628": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.getIndex" - }, - "629": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.getIndex" - }, - "630": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "631": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "__type" - }, - "632": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "__type.index" - }, - "633": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.deleteIndex" - }, - "634": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.deleteIndex" - }, - "635": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "636": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.index" - }, - "637": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.index" - }, - "638": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "654": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "655": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "656": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "657": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "658": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "659": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "672": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope" - }, - "673": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.__constructor" - }, - "674": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope" - }, - "675": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "676": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "headers" - }, - "677": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "678": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "680": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "681": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "682": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "fetch" - }, - "683": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "684": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "685": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "686": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "687": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "688": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "689": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "692": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.putVectors" - }, - "693": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.putVectors" - }, - "694": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "695": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.getVectors" - }, - "696": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.getVectors" - }, - "697": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "698": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.listVectors" - }, - "699": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.listVectors" - }, - "700": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "701": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.queryVectors" - }, - "702": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.queryVectors" - }, - "703": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "704": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.deleteVectors" - }, - "705": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.deleteVectors" - }, - "706": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "722": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "723": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "724": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "725": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "726": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "727": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "740": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "" - }, - "741": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default" - }, - "742": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "743": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default" - }, - "744": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "downloadFn" - }, - "745": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "746": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "747": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "shouldThrowOnError" - }, - "753": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "754": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "755": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult1" - }, - "756": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult2" - }, - "757": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "758": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "760": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "value" - }, - "761": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "762": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "763": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "765": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "766": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "767": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult" - }, - "768": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "769": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "770": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "771": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "772": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "773": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "774": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onfinally" - }, - "775": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "776": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "781": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.[toStringTag]" - }, - "782": { - "sourceFileName": "src/packages/VectorBucketApi.ts", - "qualifiedName": "" - }, - "846": { - "sourceFileName": "src/packages/VectorDataApi.ts", - "qualifiedName": "" - }, - "911": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "" - }, - "912": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions" - }, - "913": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.vectorBucketName" - }, - "914": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.indexName" - }, - "915": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.dataType" - }, - "916": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.dimension" - }, - "917": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.distanceMetric" - }, - "918": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.metadataConfiguration" - }, - "984": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient" - }, - "985": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.__constructor" - }, - "986": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient" - }, - "987": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "url" - }, - "988": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "headers" - }, - "989": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "__type" - }, - "990": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "__type.__index" - }, - "992": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "fetch" - }, - "993": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "994": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "995": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "996": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "997": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "998": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "999": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1000": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "opts" - }, - "1001": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.from" - }, - "1002": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.from" - }, - "1003": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "id" - }, - "1004": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.vectors" - }, - "1005": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.vectors" - }, - "1006": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.analytics" - }, - "1007": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.analytics" - }, - "1008": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "1009": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "1010": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1011": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1012": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1013": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1014": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1015": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1016": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1017": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "1018": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "1019": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1020": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1021": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1022": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1023": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1024": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1025": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1026": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "1027": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "1028": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1029": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1030": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1031": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "1032": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "1033": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "1034": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.type" - }, - "1035": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1036": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1037": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1038": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1039": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1040": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1041": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "1042": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "1043": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1044": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1045": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1046": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "1047": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "1048": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "1049": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1050": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1051": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1052": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1053": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1054": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1055": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1056": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1057": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "1058": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "1059": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1060": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1061": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1062": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1063": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1064": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1065": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1066": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1067": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1068": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "1069": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "1070": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1071": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1072": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1073": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1074": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1075": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1076": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1077": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1078": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1094": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1095": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1096": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "1097": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "1098": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "1099": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "1112": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClientOptions" - }, - "1113": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClientOptions.useNewHostname" - }, - "1114": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageAnalyticsClient" - }, - "1115": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageVectorsClient" - }, - "1116": { - "sourceFileName": "src/index.ts", - "qualifiedName": "VectorBucketScope" - }, - "1117": { - "sourceFileName": "src/index.ts", - "qualifiedName": "VectorIndexScope" - }, - "1118": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageVectorsClientOptions" - }, - "1122": { - "sourceFileName": "src/index.ts", - "qualifiedName": "CreateIndexOptions" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "BucketType" - }, - "1124": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1125": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket" - }, - "1126": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.id" - }, - "1127": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.type" - }, - "1128": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.name" - }, - "1129": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.owner" - }, - "1130": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.file_size_limit" - }, - "1131": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.allowed_mime_types" - }, - "1132": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.created_at" - }, - "1133": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.updated_at" - }, - "1134": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.public" - }, - "1135": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions" - }, - "1136": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.limit" - }, - "1137": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.offset" - }, - "1138": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.sortColumn" - }, - "1139": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.sortOrder" - }, - "1140": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.search" - }, - "1141": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket" - }, - "1142": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.name" - }, - "1143": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.type" - }, - "1144": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.format" - }, - "1145": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.created_at" - }, - "1146": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.updated_at" - }, - "1147": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata" - }, - "1148": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.eTag" - }, - "1149": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.size" - }, - "1150": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.mimetype" - }, - "1151": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.cacheControl" - }, - "1152": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.lastModified" - }, - "1153": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.contentLength" - }, - "1154": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.httpStatusCode" - }, - "1155": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.__index" - }, - "1157": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject" - }, - "1158": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.name" - }, - "1159": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.id" - }, - "1160": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.updated_at" - }, - "1161": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.created_at" - }, - "1162": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.last_accessed_at" - }, - "1163": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.metadata" - }, - "1164": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.bucket_id" - }, - "1165": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.owner" - }, - "1166": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.buckets" - }, - "1167": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2" - }, - "1168": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.id" - }, - "1169": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.version" - }, - "1170": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.name" - }, - "1171": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.bucket_id" - }, - "1172": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.created_at" - }, - "1173": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.size" - }, - "1174": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.cache_control" - }, - "1175": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.content_type" - }, - "1176": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.etag" - }, - "1177": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.last_modified" - }, - "1178": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.metadata" - }, - "1179": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.updated_at" - }, - "1180": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy" - }, - "1181": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy.column" - }, - "1182": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy.order" - }, - "1183": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions" - }, - "1184": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.cacheControl" - }, - "1185": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.contentType" - }, - "1186": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.upsert" - }, - "1187": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.duplex" - }, - "1188": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.metadata" - }, - "1189": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.headers" - }, - "1190": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DestinationOptions" - }, - "1191": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DestinationOptions.destinationBucket" - }, - "1192": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions" - }, - "1193": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.limit" - }, - "1194": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.offset" - }, - "1195": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.sortBy" - }, - "1196": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.search" - }, - "1197": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2" - }, - "1198": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2.column" - }, - "1199": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2.order" - }, - "1200": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options" - }, - "1201": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.limit" - }, - "1202": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.prefix" - }, - "1203": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.cursor" - }, - "1204": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.with_delimiter" - }, - "1205": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.sortBy" - }, - "1206": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object" - }, - "1207": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.name" - }, - "1208": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.key" - }, - "1209": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.id" - }, - "1210": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.updated_at" - }, - "1211": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.created_at" - }, - "1212": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.metadata" - }, - "1213": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.last_accessed_at" - }, - "1214": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder" - }, - "1215": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder.name" - }, - "1216": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder.key" - }, - "1217": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result" - }, - "1218": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.hasNext" - }, - "1219": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.folders" - }, - "1220": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.objects" - }, - "1221": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.nextCursor" - }, - "1222": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters" - }, - "1223": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters.signal" - }, - "1224": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters.cache" - }, - "1225": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Metadata" - }, - "1226": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Metadata.name" - }, - "1227": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions" - }, - "1228": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.width" - }, - "1229": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.height" - }, - "1230": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.resize" - }, - "1231": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.quality" - }, - "1232": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.format" - }, - "1233": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Camelize" - }, - "1234": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1235": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DownloadResult" - }, - "1236": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1237": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1238": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1239": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1240": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1241": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1242": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1243": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration" - }, - "1244": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration.kmsKeyArn" - }, - "1245": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration.sseType" - }, - "1246": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket" - }, - "1247": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.vectorBucketName" - }, - "1248": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.creationTime" - }, - "1249": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.encryptionConfiguration" - }, - "1250": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MetadataConfiguration" - }, - "1251": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MetadataConfiguration.nonFilterableMetadataKeys" - }, - "1252": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorDataType" - }, - "1253": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1254": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DistanceMetric" - }, - "1255": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1256": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex" - }, - "1257": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.indexName" - }, - "1258": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.vectorBucketName" - }, - "1259": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.dataType" - }, - "1260": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.dimension" - }, - "1261": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.distanceMetric" - }, - "1262": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.metadataConfiguration" - }, - "1263": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.creationTime" - }, - "1264": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorData" - }, - "1265": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorData.float32" - }, - "1266": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMetadata" - }, - "1267": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject" - }, - "1268": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.key" - }, - "1269": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.data" - }, - "1270": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.metadata" - }, - "1271": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch" - }, - "1272": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.key" - }, - "1273": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.data" - }, - "1274": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.metadata" - }, - "1275": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.distance" - }, - "1276": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions" - }, - "1277": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.prefix" - }, - "1278": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.maxResults" - }, - "1279": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.nextToken" - }, - "1280": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse" - }, - "1281": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse.vectorBuckets" - }, - "1282": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1283": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.vectorBucketName" - }, - "1284": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse.nextToken" - }, - "1285": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions" - }, - "1286": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.vectorBucketName" - }, - "1287": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.prefix" - }, - "1288": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.maxResults" - }, - "1289": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.nextToken" - }, - "1290": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse" - }, - "1291": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse.indexes" - }, - "1292": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1293": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.indexName" - }, - "1294": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse.nextToken" - }, - "1295": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions" - }, - "1296": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.vectorBucketName" - }, - "1297": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.indexName" - }, - "1298": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.keys" - }, - "1299": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.returnData" - }, - "1300": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.returnMetadata" - }, - "1301": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsResponse" - }, - "1302": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsResponse.vectors" - }, - "1303": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions" - }, - "1304": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.vectorBucketName" - }, - "1305": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.indexName" - }, - "1306": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.vectors" - }, - "1307": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions" - }, - "1308": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.vectorBucketName" - }, - "1309": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.indexName" - }, - "1310": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.keys" - }, - "1311": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions" - }, - "1312": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.vectorBucketName" - }, - "1313": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.indexName" - }, - "1314": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.maxResults" - }, - "1315": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.nextToken" - }, - "1316": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.returnData" - }, - "1317": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.returnMetadata" - }, - "1318": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.segmentCount" - }, - "1319": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.segmentIndex" - }, - "1320": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse" - }, - "1321": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse.vectors" - }, - "1322": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse.nextToken" - }, - "1323": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFilter" - }, - "1324": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions" - }, - "1325": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.vectorBucketName" - }, - "1326": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.indexName" - }, - "1327": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.queryVector" - }, - "1328": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.topK" - }, - "1329": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.filter" - }, - "1330": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.returnDistance" - }, - "1331": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.returnMetadata" - }, - "1332": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse" - }, - "1333": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse.vectors" - }, - "1334": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse.distanceMetric" - }, - "1335": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFetchParameters" - }, - "1336": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFetchParameters.signal" - }, - "1337": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse" - }, - "1338": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.data" - }, - "1339": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.error" - }, - "1340": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.T" - }, - "1341": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse" - }, - "1342": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse.data" - }, - "1343": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse.error" - }, - "1344": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ApiResponse" - }, - "1345": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1346": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageError" - }, - "1347": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageError" - }, - "1348": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "error" - }, - "1349": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageVectorsError" - }, - "1350": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageVectorsError" - }, - "1351": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "error" - }, - "1352": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "1353": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "1354": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.__constructor" - }, - "1355": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "1356": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1357": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1358": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1359": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1362": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1363": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1364": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1365": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1366": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1368": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1369": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1370": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1371": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "1372": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.__constructor" - }, - "1373": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "1374": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1375": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1376": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1377": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1378": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "1379": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "1380": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1381": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1382": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1383": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1384": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1385": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1386": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1389": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError" - }, - "1390": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.__constructor" - }, - "1391": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError" - }, - "1392": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1393": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "originalError" - }, - "1394": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1395": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.originalError" - }, - "1398": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1399": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1400": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1401": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1402": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1404": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1405": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1406": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1407": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError" - }, - "1408": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError.__constructor" - }, - "1409": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError" - }, - "1410": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1413": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1414": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1415": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1416": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1417": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1418": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1419": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1420": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1421": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1422": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError" - }, - "1423": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError.__constructor" - }, - "1424": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError" - }, - "1425": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1426": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1427": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1428": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "1429": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "1430": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1431": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1432": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1433": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1434": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1435": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1436": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1439": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError" - }, - "1440": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError.__constructor" - }, - "1441": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError" - }, - "1442": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1443": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "originalError" - }, - "1444": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.originalError" - }, - "1447": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1448": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1449": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1450": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1451": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1452": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1453": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1454": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1455": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1456": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode" - }, - "1457": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.InternalError" - }, - "1458": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorConflictException" - }, - "1459": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorNotFoundException" - }, - "1460": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorBucketNotEmpty" - }, - "1461": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorMaxBucketsExceeded" - }, - "1462": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorMaxIndexesExceeded" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "src/packages/BlobDownloadBuilder.ts", - "3": "src/packages/StorageAnalyticsClient.ts", - "4": "src/packages/StorageBucketApi.ts", - "5": "src/packages/StorageFileApi.ts", - "6": "src/packages/StorageVectorsClient.ts", - "7": "src/packages/StreamDownloadBuilder.ts", - "8": "src/packages/VectorBucketApi.ts", - "9": "src/packages/VectorDataApi.ts", - "10": "src/packages/VectorIndexApi.ts", - "11": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 1, - "2": 2, - "3": 46, - "4": 135, - "5": 260, - "6": 535, - "7": 740, - "8": 782, - "9": 846, - "10": 911 - } - } - }, - { - "id": 0, - "name": "@supabase/functions-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 93, - "name": "FunctionRegion", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 94, - "name": "Any", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L96" - } - ], - "type": { - "type": "literal", - "value": "any" - } - }, - { - "id": 95, - "name": "ApNortheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 97, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L97" - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-1" - } - }, - { - "id": 96, - "name": "ApNortheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 98, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L98" - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-2" - } - }, - { - "id": 97, - "name": "ApSouth1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 99, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L99" - } - ], - "type": { - "type": "literal", - "value": "ap-south-1" - } - }, - { - "id": 98, - "name": "ApSoutheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 100, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L100" - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-1" - } - }, - { - "id": 99, - "name": "ApSoutheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 101, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L101" - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-2" - } - }, - { - "id": 100, - "name": "CaCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 102, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L102" - } - ], - "type": { - "type": "literal", - "value": "ca-central-1" - } - }, - { - "id": 101, - "name": "EuCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 103, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L103" - } - ], - "type": { - "type": "literal", - "value": "eu-central-1" - } - }, - { - "id": 102, - "name": "EuWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 104, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L104" - } - ], - "type": { - "type": "literal", - "value": "eu-west-1" - } - }, - { - "id": 103, - "name": "EuWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 105, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L105" - } - ], - "type": { - "type": "literal", - "value": "eu-west-2" - } - }, - { - "id": 104, - "name": "EuWest3", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 106, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L106" - } - ], - "type": { - "type": "literal", - "value": "eu-west-3" - } - }, - { - "id": 105, - "name": "SaEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L107" - } - ], - "type": { - "type": "literal", - "value": "sa-east-1" - } - }, - { - "id": 106, - "name": "UsEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 108, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L108" - } - ], - "type": { - "type": "literal", - "value": "us-east-1" - } - }, - { - "id": 107, - "name": "UsWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L109" - } - ], - "type": { - "type": "literal", - "value": "us-west-1" - } - }, - { - "id": 108, - "name": "UsWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 110, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L110" - } - ], - "type": { - "type": "literal", - "value": "us-west-2" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 95, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L95" - } - ] - }, - { - "id": 1, - "name": "FunctionsClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for invoking Supabase Edge Functions." - } - ] - }, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44" - } - ], - "signatures": [ - { - "id": 3, - "name": "FunctionsClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Functions client bound to an Edge Functions URL." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.functions.invoke('hello-world')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsClient, FunctionRegion } from '@supabase/functions-js'\n\nconst functions = new FunctionsClient('https://xyzcompany.supabase.co/functions/v1', {\n headers: { apikey: 'your-publishable-key' },\n region: FunctionRegion.UsEast1,\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44" - } - ], - "parameters": [ - { - "id": 4, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 6, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 8, - "name": "customFetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 52, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L52" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 10, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 11, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 12, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 13, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 14, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 15, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 7, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 51, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L51" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 16, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 53, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L53" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - }, - "defaultValue": "FunctionRegion.Any" - } - ], - "groups": [ - { - "title": "Properties", - "children": [8, 7, 16] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 50, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L50" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "FunctionsClient", - "package": "@supabase/functions-js" - } - } - ] - }, - { - "id": 20, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 19, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L19" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 22, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 23, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 24, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 25, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 26, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 27, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 18, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 17, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L17" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 19, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 18, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L18" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 17, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 31, - "name": "invoke", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 202, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202" - } - ], - "signatures": [ - { - "id": 32, - "name": "invoke", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Invokes a function" - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Ada' },\n})\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires an Authorization header.\n- Invoke params generally match the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) spec.\n- When you pass in a body to your function, we automatically attach the Content-Type header for " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`String`" - }, - { - "kind": "text", - "text": ". If it doesn't match any of these types we assume the payload is " - }, - { - "kind": "code", - "text": "`json`" - }, - { - "kind": "text", - "text": ", serialize it and attach the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header as " - }, - { - "kind": "code", - "text": "`application/json`" - }, - { - "kind": "text", - "text": ". You can override this behavior by passing in a " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header of your own.\n- Responses are automatically parsed as " - }, - { - "kind": "code", - "text": "`json`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`blob`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`form-data`" - }, - { - "kind": "text", - "text": " depending on the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header sent by your function. Responses are parsed as " - }, - { - "kind": "code", - "text": "`text`" - }, - { - "kind": "text", - "text": " by default." - } - ] - }, - { - "tag": "@example", - "name": "Basic invocation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n body: { foo: 'bar' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Error handling\nA " - }, - { - "kind": "code", - "text": "`FunctionsHttpError`" - }, - { - "kind": "text", - "text": " error is returned if your function throws an error, " - }, - { - "kind": "code", - "text": "`FunctionsRelayError`" - }, - { - "kind": "text", - "text": " if the Supabase Relay has an error processing your function and " - }, - { - "kind": "code", - "text": "`FunctionsFetchError`" - }, - { - "kind": "text", - "text": " if there is a network error in calling your function. Log the full error object so fields like " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`context`" - }, - { - "kind": "text", - "text": ", and any structured body aren't hidden." - } - ] - }, - { - "tag": "@example", - "name": "Error handling", - "content": [ - { - "kind": "code", - "text": "```js\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \"@supabase/supabase-js\";\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n\nif (error instanceof FunctionsHttpError) {\n const errorMessage = await error.context.json()\n console.error('Function returned an error', errorMessage)\n} else if (error instanceof FunctionsRelayError) {\n console.error('Relay error:', error)\n} else if (error instanceof FunctionsFetchError) {\n console.error('Fetch error:', error)\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Passing custom headers\nYou can pass custom headers to your function. Note: supabase-js automatically passes the " - }, - { - "kind": "code", - "text": "`Authorization`" - }, - { - "kind": "text", - "text": " header with the signed in user's JWT." - } - ] - }, - { - "tag": "@example", - "name": "Passing custom headers", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Calling with DELETE HTTP verb\nYou can also set the HTTP verb to " - }, - { - "kind": "code", - "text": "`DELETE`" - }, - { - "kind": "text", - "text": " when calling your Edge Function." - } - ] - }, - { - "tag": "@example", - "name": "Calling with DELETE HTTP verb", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' },\n method: 'DELETE'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Invoking a Function in the UsEast1 region\nHere are the available regions:\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.Any`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApNortheast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApNortheast2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSouth1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSoutheast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSoutheast2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.CaCentral1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuCentral1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest3`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.SaEast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsEast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsWest1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsWest2`" - } - ] - }, - { - "tag": "@example", - "name": "Invoking a Function in the UsEast1 region", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient, FunctionRegion } from '@supabase/supabase-js'\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n body: { foo: 'bar' },\n region: FunctionRegion.UsEast1\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Calling with GET HTTP verb\nYou can also set the HTTP verb to " - }, - { - "kind": "code", - "text": "`GET`" - }, - { - "kind": "text", - "text": " when calling your Edge Function." - } - ] - }, - { - "tag": "@example", - "name": "Calling with GET HTTP verb", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n method: 'GET'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone client invoke", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Ada' },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 202, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202" - } - ], - "typeParameters": [ - { - "id": 33, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - } - ], - "parameters": [ - { - "id": 34, - "name": "functionName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Function to invoke." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 35, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for invoking the Function." - } - ] - }, - "type": { - "type": "reference", - "target": 36, - "name": "FunctionInvokeOptions", - "package": "@supabase/functions-js" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 109, - "typeArguments": [ - { - "type": "reference", - "target": 33, - "name": "T", - "package": "@supabase/functions-js", - "refersToTypeParameter": true - } - ], - "name": "FunctionsResponse", - "package": "@supabase/functions-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 28, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73" - } - ], - "signatures": [ - { - "id": 29, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the authorization header" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@example", - "name": "Setting the authorization header", - "content": [ - { - "kind": "code", - "text": "```ts\nfunctions.setAuth(session.access_token)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73" - } - ], - "parameters": [ - { - "id": 30, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the new jwt token sent in the authorisation header" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [20, 18, 19, 17] - }, - { - "title": "Methods", - "children": [31, 28] - } - ], - "categories": [ - { - "title": "Edge Functions", - "children": [2, 31, 28] - }, - { - "title": "Other", - "children": [20, 18, 19, 17] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 15, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L15" - } - ] - }, - { - "id": 47, - "name": "FunctionsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error for Supabase Edge Function invocations." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsError } from '@supabase/functions-js'\n\nthrow new FunctionsError('Unexpected error invoking function', 'FunctionsError', {\n requestId: 'abc123',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 48, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32" - } - ], - "signatures": [ - { - "id": 49, - "name": "FunctionsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32" - } - ], - "parameters": [ - { - "id": 50, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 51, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'FunctionsError'" - }, - { - "id": 52, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 53, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 54, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 55, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 59, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 58, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 57, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [59, 58, 57] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [48] - }, - { - "title": "Properties", - "children": [53] - }, - { - "title": "Methods", - "children": [54] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 30, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L30" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 60, - "name": "FunctionsFetchError" - }, - { - "type": "reference", - "target": 71, - "name": "FunctionsHttpError" - }, - { - "type": "reference", - "target": 82, - "name": "FunctionsRelayError" - } - ] - }, - { - "id": 60, - "name": "FunctionsFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the network request to an Edge Function fails." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsFetchError } from '@supabase/functions-js'\n\nthrow new FunctionsFetchError({ requestId: 'abc123' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 61, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58" - } - ], - "signatures": [ - { - "id": 62, - "name": "FunctionsFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58" - } - ], - "parameters": [ - { - "id": 63, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 60, - "name": "FunctionsFetchError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 64, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 65, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 66, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 70, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 69, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 68, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [70, 69, 68] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [61] - }, - { - "title": "Properties", - "children": [64] - }, - { - "title": "Methods", - "children": [65] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 57, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L57" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 71, - "name": "FunctionsHttpError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Edge Function returns a non-2xx status code." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsHttpError } from '@supabase/functions-js'\n\nthrow new FunctionsHttpError({ status: 500 })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 72, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90" - } - ], - "signatures": [ - { - "id": 73, - "name": "FunctionsHttpError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90" - } - ], - "parameters": [ - { - "id": 74, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 71, - "name": "FunctionsHttpError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 75, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 76, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 77, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 81, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 80, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 79, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [81, 80, 79] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [72] - }, - { - "title": "Properties", - "children": [75] - }, - { - "title": "Methods", - "children": [76] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 89, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L89" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 82, - "name": "FunctionsRelayError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Supabase relay cannot reach the Edge Function." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsRelayError } from '@supabase/functions-js'\n\nthrow new FunctionsRelayError({ region: 'us-east-1' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 83, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74" - } - ], - "signatures": [ - { - "id": 84, - "name": "FunctionsRelayError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74" - } - ], - "parameters": [ - { - "id": 85, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 82, - "name": "FunctionsRelayError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 86, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 87, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 88, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 89, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 92, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 91, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 90, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [92, 91, 90] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [83] - }, - { - "title": "Properties", - "children": [86] - }, - { - "title": "Methods", - "children": [87] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 73, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L73" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 36, - "name": "FunctionInvokeOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 113, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 44, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L129" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 38, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Object representing the headers to send with the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "indexSignatures": [ - { - "id": 40, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "parameters": [ - { - "id": 41, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 42, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP verb of the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L121" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 43, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Region to invoke the function in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L125" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 45, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L140" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 46, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timeout for the request in milliseconds.\nIf the function takes longer than this, the request will be aborted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 145, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L145" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [44, 38, 42, 43, 45, 46] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 113, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113" - } - ] - } - } - }, - { - "id": 109, - "name": "FunctionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L16" - } - ], - "typeParameters": [ - { - "id": 110, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 110, - "name": "T", - "package": "@supabase/functions-js", - "refersToTypeParameter": true - } - ], - "name": "FunctionsResponseSuccess", - "package": "@supabase/functions-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponseFailure" - }, - "name": "FunctionsResponseFailure", - "package": "@supabase/functions-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [93] - }, - { - "title": "Classes", - "children": [1, 47, 60, 71, 82] - }, - { - "title": "Type Aliases", - "children": [36, 109] - } - ], - "packageName": "@supabase/functions-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Functions JS SDK

    \n\n

    JavaScript SDK to interact with Supabase Edge Functions.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/functions-js)](https://www.npmjs.com/package/@supabase/functions-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/functions-js)](https://pkg.pr.new/~/supabase/functions-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Quick Start\n\n### Installation\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/functions-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Usage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { FunctionsClient } from '@supabase/functions-js'\n\nconst functionsUrl = 'https://.supabase.co/functions/v1'\nconst publishableKey = ''\n\nconst functions = new FunctionsClient(functionsUrl, {\n headers: {\n Authorization: `Bearer ${publishableKey}`,\n },\n})\n\n// Invoke a function\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Functions' },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build functions-js\n\n# Build with watch mode for development\npnpm nx build functions-js --watch\n\n# Individual build targets\npnpm nx build:main functions-js # CommonJS build (dist/main/)\npnpm nx build:module functions-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx clean functions-js # Clean build artifacts\npnpm nx typecheck functions-js # TypeScript type checking\npnpm nx docs functions-js # Generate documentation\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\n### Testing\n\n**Docker Required** for relay tests. The functions-js tests use testcontainers to spin up a Deno relay server for testing Edge Function invocations.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run all tests (from monorepo root)\npnpm nx test functions-js\n\n# Run tests with coverage report\npnpm nx test functions-js --coverage\n\n# Run tests in watch mode during development\npnpm nx test functions-js --watch\n\n# CI test command (runs with coverage)\npnpm nx test:ci functions-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Requirements\n\n- **Node.js 20+** - Required for testcontainers\n- **Docker** - Must be installed and running for relay tests\n- No Supabase instance needed - Tests use mocked services and testcontainers\n\n#### What Gets Tested\n\n- **Function invocation** - Testing the " - }, - { - "kind": "code", - "text": "`invoke()`" - }, - { - "kind": "text", - "text": " method with various options\n- **Relay functionality** - Using a containerized Deno relay to test real Edge Function scenarios\n- **Error handling** - Ensuring proper error responses and retries\n- **Request/response models** - Validating headers, body, and response formats\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "2": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.__constructor" - }, - "3": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "4": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "url" - }, - "5": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__1" - }, - "6": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type" - }, - "7": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.headers" - }, - "8": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.customFetch" - }, - "9": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "10": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "11": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "12": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "13": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "14": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "15": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "16": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.region" - }, - "17": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.url" - }, - "18": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.headers" - }, - "19": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.region" - }, - "20": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.fetch" - }, - "21": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "22": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "23": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "24": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "25": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "26": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "27": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "28": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.setAuth" - }, - "29": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.setAuth" - }, - "30": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "token" - }, - "31": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.invoke" - }, - "32": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.invoke" - }, - "33": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "T" - }, - "34": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "functionName" - }, - "35": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "options" - }, - "36": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionInvokeOptions" - }, - "37": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "38": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.headers" - }, - "39": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "40": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.__index" - }, - "42": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.method" - }, - "43": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.region" - }, - "44": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.body" - }, - "45": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.signal" - }, - "46": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.timeout" - }, - "47": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError" - }, - "48": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.__constructor" - }, - "49": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError" - }, - "50": { - "sourceFileName": "src/types.ts", - "qualifiedName": "message" - }, - "51": { - "sourceFileName": "src/types.ts", - "qualifiedName": "name" - }, - "52": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "53": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "54": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "55": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "56": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "57": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "58": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "59": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "60": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "61": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError.__constructor" - }, - "62": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "63": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "64": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "65": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "66": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "67": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "69": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "70": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "71": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "72": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError.__constructor" - }, - "73": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "74": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "75": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "76": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "77": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "78": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "79": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "80": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "81": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "82": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "83": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError.__constructor" - }, - "84": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "85": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "86": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "87": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "88": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "89": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "90": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "91": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "92": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "93": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion" - }, - "94": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.Any" - }, - "95": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast1" - }, - "96": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast2" - }, - "97": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSouth1" - }, - "98": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast1" - }, - "99": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast2" - }, - "100": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.CaCentral1" - }, - "101": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuCentral1" - }, - "102": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest1" - }, - "103": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest2" - }, - "104": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest3" - }, - "105": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.SaEast1" - }, - "106": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsEast1" - }, - "107": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsWest1" - }, - "108": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsWest2" - }, - "109": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponse" - }, - "110": { - "sourceFileName": "src/types.ts", - "qualifiedName": "T" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } - } - ] -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/combined_raw.json b/apps/docs/spec/enrichments/tsdoc_v2/combined_raw.json deleted file mode 100644 index 9e2f73cc033..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/combined_raw.json +++ /dev/null @@ -1,45929 +0,0 @@ -{ - "name": "Combined Specs", - "children": [ - { - "id": 0, - "name": "@supabase/supabase-js", - "kind": 1, - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1, - "name": "index", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 194, - "name": "SupabaseClientOptions", - "kind": 16777216, - "kindString": "Reference", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 20, - "character": 14 - } - ], - "target": 61 - }, - { - "id": 104, - "name": "SupabaseClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "shortText": "Supabase Client.", - "text": "An isomorphic Javascript client for interacting with Postgres.\n" - }, - "children": [ - { - "id": 105, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 82, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "new SupabaseClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Create a new client for use in the browser." - }, - "typeParameter": [ - { - "id": 107, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 108, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 109, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 110, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 111, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 112, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 108, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 104, - "typeArguments": [ - { - "type": "reference", - "id": 107, - "name": "Database" - }, - { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 109, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 113, - "name": "auth", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 54, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "SupabaseAuthClient" - } - }, - { - "id": 115, - "name": "authUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 57, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 126, - "name": "changedAccessToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 64, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 121, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 63, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 122, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 123, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 124, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 125, - "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": 117, - "name": "functionsUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 59, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 127, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 66, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 128, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 129, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 130, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 118, - "name": "realtime", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 60, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" - } - }, - { - "id": 114, - "name": "realtimeUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 56, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 119, - "name": "rest", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 61, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 107, - "name": "Database" - }, - { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "qualifiedName": "GenericSchema", - "package": "@supabase/postgrest-js", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "qualifiedName": "PostgrestClient", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 120, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 62, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 116, - "name": "storageUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 58, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 132, - "name": "supabaseKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 131, - "name": "supabaseUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 133, - "name": "functions", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 137, - "character": 6 - } - ], - "getSignature": [ - { - "id": 134, - "name": "functions", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Functions allows you to deploy and invoke edge functions." - }, - "type": { - "type": "reference", - "qualifiedName": "FunctionsClient", - "package": "@supabase/functions-js", - "name": "FunctionsClient" - } - } - ] - }, - { - "id": 135, - "name": "storage", - "kind": 262144, - "kindString": "Accessor", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 147, - "character": 6 - } - ], - "getSignature": [ - { - "id": 136, - "name": "storage", - "kind": 524288, - "kindString": "Get signature", - "flags": {}, - "comment": { - "shortText": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - }, - "type": { - "type": "reference", - "qualifiedName": "StorageClient", - "package": "@supabase/storage-js", - "name": "StorageClient" - } - } - ] - }, - { - "id": 169, - "name": "_getAccessToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 234, - "character": 16 - } - ], - "signatures": [ - { - "id": 170, - "name": "_getAccessToken", - "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" - } - } - ] - }, - { - "id": 186, - "name": "_handleTokenChanged", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 281, - "character": 10 - } - ], - "signatures": [ - { - "id": 187, - "name": "_handleTokenChanged", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 188, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "AuthChangeEvent", - "package": "@supabase/gotrue-js", - "name": "AuthChangeEvent" - } - }, - { - "id": 189, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 190, - "name": "source", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "CLIENT" - }, - { - "type": "literal", - "value": "STORAGE" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 180, - "name": "_initRealtimeClient", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 267, - "character": 10 - } - ], - "signatures": [ - { - "id": 181, - "name": "_initRealtimeClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 182, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - } - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClient", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ] - }, - { - "id": 171, - "name": "_initSupabaseAuthClient", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 240, - "character": 10 - } - ], - "signatures": [ - { - "id": 172, - "name": "_initSupabaseAuthClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 173, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 59, - "name": "SupabaseAuthClientOptions" - } - }, - { - "id": 174, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 175, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 176, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 177, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 178, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 179, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "name": "SupabaseAuthClient" - } - } - ] - }, - { - "id": 183, - "name": "_listenForAuthEvents", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 274, - "character": 10 - } - ], - "signatures": [ - { - "id": 184, - "name": "_listenForAuthEvents", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 185, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - }, - { - "id": 158, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 206, - "character": 2 - } - ], - "signatures": [ - { - "id": 159, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." - }, - "parameters": [ - { - "id": 160, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The name of the Realtime channel." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 161, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The options to pass to the Realtime channel.\n\n" - }, - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannelOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ] - }, - { - "id": 137, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 156, - "character": 2 - } - ], - "signatures": [ - { - "id": 138, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a table operation." - }, - "typeParameter": [ - { - "id": 139, - "name": "TableName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 140, - "name": "Table", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 79, - "name": "GenericTable" - } - } - ], - "parameters": [ - { - "id": 141, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 139, - "name": "TableName" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "Schema" - }, - { - "type": "reference", - "id": 140, - "name": "Table" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 142, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 143, - "name": "ViewName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 144, - "name": "View", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 92, - "name": "GenericView" - } - } - ], - "parameters": [ - { - "id": 145, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 143, - "name": "ViewName" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "Schema" - }, - { - "type": "reference", - "id": 144, - "name": "View" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - }, - { - "id": 146, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 147, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "Schema" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "qualifiedName": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - } - ] - }, - { - "id": 162, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 213, - "character": 2 - } - ], - "signatures": [ - { - "id": 163, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns all Realtime channels." - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - } - ] - }, - { - "id": 167, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 230, - "character": 2 - } - ], - "signatures": [ - { - "id": 168, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes all Realtime channels from Realtime client." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 164, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 223, - "character": 2 - } - ], - "signatures": [ - { - "id": 165, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unsubscribes and removes Realtime channel from Realtime client." - }, - "parameters": [ - { - "id": 166, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The name of the Realtime channel.\n\n" - }, - "type": { - "type": "reference", - "qualifiedName": "RealtimeChannel", - "package": "@supabase/realtime-js", - "name": "default" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 148, - "name": "rpc", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 177, - "character": 2 - } - ], - "signatures": [ - { - "id": 149, - "name": "rpc", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform a function call." - }, - "typeParameter": [ - { - "id": 150, - "name": "FunctionName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 151, - "name": "Function_", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 93, - "name": "GenericFunction" - } - } - ], - "parameters": [ - { - "id": 152, - "name": "fn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The function name to call." - }, - "type": { - "type": "reference", - "id": 150, - "name": "FunctionName" - } - }, - { - "id": 153, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The parameters to pass to the function call." - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Args" - }, - "objectType": { - "type": "reference", - "id": 151, - "name": "Function_" - } - }, - "defaultValue": "{}" - }, - { - "id": 154, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 157, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Count algorithm to use to count rows in a table.\n\n" - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 185, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 156, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When set to true, no data will be returned." - }, - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 184, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [157, 156] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 109, - "name": "Schema" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 151, - "name": "Function_" - } - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - } - }, - "extendsType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 151, - "name": "Function_" - } - } - ], - "qualifiedName": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [105] - }, - { - "title": "Properties", - "kind": 1024, - "children": [113, 115, 126, 121, 117, 127, 118, 114, 119, 120, 116, 132, 131] - }, - { - "title": "Accessors", - "kind": 262144, - "children": [133, 135] - }, - { - "title": "Methods", - "kind": 2048, - "children": [169, 186, 180, 171, 183, 158, 137, 162, 167, 164, 148] - } - ], - "sources": [ - { - "fileName": "src/SupabaseClient.ts", - "line": 42, - "character": 21 - } - ], - "typeParameter": [ - { - "id": 191, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 192, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 107, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 193, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 108, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 107, - "name": "Database" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 2, - "name": "createClient", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/index.ts", - "line": 25, - "character": 13 - } - ], - "signatures": [ - { - "id": 3, - "name": "createClient", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Supabase Client." - }, - "typeParameter": [ - { - "id": 4, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 6, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "id": 97, - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 7, - "name": "supabaseUrl", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 8, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 9, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 104, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 6, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "References", - "kind": 16777216, - "children": [194] - }, - { - "title": "Classes", - "kind": 128, - "children": [104] - }, - { - "title": "Functions", - "kind": 64, - "children": [2] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 10, - "name": "lib/constants", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 11, - "name": "DEFAULT_HEADERS", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 3, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 13, - "name": "X-Client-Info", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 3, - "character": 33 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [13] - } - ] - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [11] - } - ], - "sources": [ - { - "fileName": "src/lib/constants.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 14, - "name": "lib/fetch", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 29, - "name": "fetchWithAuth", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 25, - "character": 13 - } - ], - "signatures": [ - { - "id": 30, - "name": "fetchWithAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 31, - "name": "supabaseKey", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "getAccessToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 33, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 34, - "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" - } - } - ] - } - } - }, - { - "id": 35, - "name": "customFetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 36, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 37, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 38, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 39, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 40, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 41, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 42, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 43, - "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": 15, - "name": "resolveFetch", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 5, - "character": 13 - } - ], - "signatures": [ - { - "id": 16, - "name": "resolveFetch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 17, - "name": "customFetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 19, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 20, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 21, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 22, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 23, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 24, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 25, - "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": 26, - "name": "resolveHeadersConstructor", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 17, - "character": 13 - } - ], - "signatures": [ - { - "id": 27, - "name": "resolveHeadersConstructor", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 28, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "kind": 64, - "children": [29, 15, 26] - } - ], - "sources": [ - { - "fileName": "src/lib/fetch.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 44, - "name": "lib/helpers", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 50, - "name": "applySettingDefaults", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 18, - "character": 16 - } - ], - "signatures": [ - { - "id": 51, - "name": "applySettingDefaults", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 52, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 53, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 52, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 52, - "name": "Database" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 54, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 53, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - }, - { - "id": 55, - "name": "defaults", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "SupabaseClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 61, - "typeArguments": [ - { - "type": "reference", - "id": 53, - "name": "SchemaName" - } - ], - "name": "SupabaseClientOptions" - } - } - ] - }, - { - "id": 56, - "name": "isBrowser", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 16, - "character": 13 - } - ], - "signatures": [ - { - "id": 57, - "name": "isBrowser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 47, - "name": "stripTrailingSlash", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 12, - "character": 16 - } - ], - "signatures": [ - { - "id": 48, - "name": "stripTrailingSlash", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 49, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 45, - "name": "uuid", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 4, - "character": 16 - } - ], - "signatures": [ - { - "id": 46, - "name": "uuid", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "groups": [ - { - "title": "Functions", - "kind": 64, - "children": [50, 56, 47, 45] - } - ], - "sources": [ - { - "fileName": "src/lib/helpers.ts", - "line": 2, - "character": 0 - } - ] - }, - { - "id": 58, - "name": "lib/types", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 59, - "name": "SupabaseAuthClientOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 6, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "name": "GoTrueClientOptions" - } - ] - }, - { - "id": 60, - "name": "Fetch", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "id": 18, - "qualifiedName": "fetch", - "package": "typescript", - "name": "fetch" - } - } - }, - { - "id": 93, - "name": "GenericFunction", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 74, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 94, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 95, - "name": "Args", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 75, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 96, - "name": "Returns", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 76, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [95, 96] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 74, - "character": 30 - } - ] - } - } - }, - { - "id": 89, - "name": "GenericNonUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 68, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 90, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 91, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 69, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [91] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 68, - "character": 38 - } - ] - } - } - }, - { - "id": 97, - "name": "GenericSchema", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 98, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 101, - "name": "Functions", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 93, - "name": "GenericFunction" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 99, - "name": "Tables", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 79, - "name": "GenericTable" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 100, - "name": "Views", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 92, - "name": "GenericView" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [101, 99, 100] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 28 - } - ] - } - } - }, - { - "id": 79, - "name": "GenericTable", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 80, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 82, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 81, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 83, - "name": "Update", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [82, 81, 83] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 27 - } - ] - } - } - }, - { - "id": 84, - "name": "GenericUpdatableView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 87, - "name": "Insert", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 86, - "name": "Row", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 88, - "name": "Update", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 65, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [87, 86, 88] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 35 - } - ] - } - } - }, - { - "id": 92, - "name": "GenericView", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 84, - "name": "GenericUpdatableView" - }, - { - "type": "reference", - "id": 89, - "name": "GenericNonUpdatableView" - } - ] - } - }, - { - "id": 61, - "name": "SupabaseClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 10, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 78, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 62, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 66, - "name": "auth", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 68, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Automatically refreshes the token for logged in users." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 71, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Detect a session from the URL. Used for OAuth login callbacks." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 70, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Whether to persist a logged in session to storage." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 72, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A storage provider. Used to store the logged in session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 38, - "character": 4 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "id": 59, - "name": "SupabaseAuthClientOptions" - } - } - }, - { - "id": 69, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [68, 71, 70, 72, 69] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 9 - } - ] - } - } - }, - { - "id": 63, - "name": "db", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 65, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 78, - "name": "SchemaName" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [65] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 7 - } - ] - } - } - }, - { - "id": 74, - "name": "global", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 75, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 76, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom `fetch` implementation." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 60, - "name": "Fetch" - } - }, - { - "id": 77, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional headers for initializing the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [76, 77] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 44, - "character": 11 - } - ] - } - } - }, - { - "id": 73, - "name": "realtime", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Options passed to the realtime-js instance" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "RealtimeClientOptions", - "package": "@supabase/realtime-js", - "name": "RealtimeClientOptions" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [66, 63, 74, 73] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 10, - "character": 48 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Interfaces", - "kind": 256, - "children": [59] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [60, 93, 89, 97, 79, 84, 92, 61] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 102, - "name": "lib/version", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 103, - "name": "version", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "src/lib/version.ts", - "line": 1, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "0.0.0-automated" - }, - "defaultValue": "'0.0.0-automated'" - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [103] - } - ], - "sources": [ - { - "fileName": "src/lib/version.ts", - "line": 1, - "character": 0 - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "kind": 2, - "children": [1, 10, 14, 44, 58, 102] - } - ] - }, - { - "id": 0, - "name": "@supabase/gotrue-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 699, - "name": "AuthApiError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 700, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 17, - "character": 2 - } - ], - "signatures": [ - { - "id": 701, - "name": "new AuthApiError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 702, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 703, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 699, - "name": "AuthApiError" - }, - "overwrites": { - "type": "reference", - "id": 696, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 695, - "name": "AuthError.constructor" - } - }, - { - "id": 704, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 705, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 23, - "character": 2 - } - ], - "signatures": [ - { - "id": 706, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 707, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 709, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 26, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 708, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 710, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 27, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [709, 708, 710] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [700] - }, - { - "title": "Properties", - "kind": 1024, - "children": [704] - }, - { - "title": "Methods", - "kind": 2048, - "children": [705] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 694, - "name": "AuthError" - } - ] - }, - { - "id": 694, - "name": "AuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 695, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 2 - } - ], - "signatures": [ - { - "id": 696, - "name": "new AuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 697, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [695] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 1, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 699, - "name": "AuthApiError" - }, - { - "type": "reference", - "id": 712, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "id": 719, - "name": "CustomAuthError" - } - ] - }, - { - "id": 759, - "name": "AuthImplicitGrantRedirectError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 760, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 74, - "character": 2 - } - ], - "signatures": [ - { - "id": 761, - "name": "new AuthImplicitGrantRedirectError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 762, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 763, - "name": "details", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 764, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 766, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 74, - "character": 57 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 765, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 74, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [766, 765] - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "id": 759, - "name": "AuthImplicitGrantRedirectError" - }, - "overwrites": { - "type": "reference", - "id": 721, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 720, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 767, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 768, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 770, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 769, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [770, 769] - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 781, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 725, - "name": "CustomAuthError.name" - } - }, - { - "id": 782, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 726, - "name": "CustomAuthError.status" - } - }, - { - "id": 771, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 79, - "character": 2 - } - ], - "signatures": [ - { - "id": 772, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 773, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 777, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 84, - "character": 6 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 778, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 780, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 28 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 779, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [780, 779] - } - ] - } - } - ] - }, - "defaultValue": "..." - }, - { - "id": 775, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 82, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 774, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 81, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 776, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 83, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [777, 775, 774, 776] - } - ] - } - }, - "overwrites": { - "type": "reference", - "id": 728, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "id": 727, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [760] - }, - { - "title": "Properties", - "kind": 1024, - "children": [767, 781, 782] - }, - { - "title": "Methods", - "kind": 2048, - "children": [771] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 72, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 719, - "name": "CustomAuthError" - } - ] - }, - { - "id": 746, - "name": "AuthInvalidCredentialsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 747, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 67, - "character": 2 - } - ], - "signatures": [ - { - "id": 748, - "name": "new AuthInvalidCredentialsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 749, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 746, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 721, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 720, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 750, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 725, - "name": "CustomAuthError.name" - } - }, - { - "id": 751, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 726, - "name": "CustomAuthError.status" - } - }, - { - "id": 752, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 753, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 754, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 756, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 755, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 757, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [756, 755, 757] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 728, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 727, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [747] - }, - { - "title": "Properties", - "kind": 1024, - "children": [750, 751] - }, - { - "title": "Methods", - "kind": 2048, - "children": [752] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 66, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 719, - "name": "CustomAuthError" - } - ] - }, - { - "id": 784, - "name": "AuthRetryableFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 785, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 90, - "character": 2 - } - ], - "signatures": [ - { - "id": 786, - "name": "new AuthRetryableFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 787, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 788, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 784, - "name": "AuthRetryableFetchError" - }, - "overwrites": { - "type": "reference", - "id": 721, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 720, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 789, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 725, - "name": "CustomAuthError.name" - } - }, - { - "id": 790, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 726, - "name": "CustomAuthError.status" - } - }, - { - "id": 791, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 792, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 793, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 795, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 794, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 796, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [795, 794, 796] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 728, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 727, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [785] - }, - { - "title": "Properties", - "kind": 1024, - "children": [789, 790] - }, - { - "title": "Methods", - "kind": 2048, - "children": [791] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 89, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 719, - "name": "CustomAuthError" - } - ] - }, - { - "id": 734, - "name": "AuthSessionMissingError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 735, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 2 - } - ], - "signatures": [ - { - "id": 736, - "name": "new AuthSessionMissingError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "type": { - "type": "reference", - "id": 734, - "name": "AuthSessionMissingError" - }, - "overwrites": { - "type": "reference", - "id": 721, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 720, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 737, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 725, - "name": "CustomAuthError.name" - } - }, - { - "id": 738, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 726, - "name": "CustomAuthError.status" - } - }, - { - "id": 739, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 740, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 741, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 743, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 742, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 744, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [743, 742, 744] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 728, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 727, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [735] - }, - { - "title": "Properties", - "kind": 1024, - "children": [737, 738] - }, - { - "title": "Methods", - "kind": 2048, - "children": [739] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 60, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 719, - "name": "CustomAuthError" - } - ] - }, - { - "id": 712, - "name": "AuthUnknownError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 713, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 35, - "character": 2 - } - ], - "signatures": [ - { - "id": 714, - "name": "new AuthUnknownError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 715, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 716, - "name": "originalError", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 712, - "name": "AuthUnknownError" - }, - "overwrites": { - "type": "reference", - "id": 696, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 695, - "name": "AuthError.constructor" - } - }, - { - "id": 717, - "name": "originalError", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [713] - }, - { - "title": "Properties", - "kind": 1024, - "children": [717] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 32, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 694, - "name": "AuthError" - } - ] - }, - { - "id": 719, - "name": "CustomAuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 720, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 45, - "character": 2 - } - ], - "signatures": [ - { - "id": 721, - "name": "new CustomAuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 722, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 723, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 724, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 719, - "name": "CustomAuthError" - }, - "overwrites": { - "type": "reference", - "id": 696, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 695, - "name": "AuthError.constructor" - } - }, - { - "id": 725, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "name": "AuthError.name" - } - }, - { - "id": 726, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 727, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 728, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 729, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 731, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 730, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 732, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [731, 730, 732] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [720] - }, - { - "title": "Properties", - "kind": 1024, - "children": [725, 726] - }, - { - "title": "Methods", - "kind": 2048, - "children": [727] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 42, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 694, - "name": "AuthError" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 734, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "id": 746, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "id": 759, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "id": 784, - "name": "AuthRetryableFetchError" - } - ] - }, - { - "id": 1, - "name": "GoTrueAdminApi", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 28, - "character": 2 - } - ], - "signatures": [ - { - "id": 3, - "name": "new GoTrueAdminApi", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 4, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 11, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 37, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 13, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 14, - "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": 15, - "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": 7, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 8, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 9, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 10, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 6, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 33, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [11, 7, 6] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 16, - "name": "mfa", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Contains all MFA administration methods." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 20, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 673, - "name": "GoTrueAdminMFAApi" - } - }, - { - "id": 43, - "name": "createUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 139, - "character": 8 - } - ], - "signatures": [ - { - "id": 44, - "name": "createUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." - }, - "parameters": [ - { - "id": 45, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 395, - "name": "AdminUserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 320, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 65, - "name": "deleteUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 229, - "character": 8 - } - ], - "signatures": [ - { - "id": 66, - "name": "deleteUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Delete a user. Requires a `service_role` key." - }, - "parameters": [ - { - "id": 67, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user id you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 320, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 40, - "name": "generateLink", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 105, - "character": 8 - } - ], - "signatures": [ - { - "id": 41, - "name": "generateLink", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates email links and OTPs. This will not send links or OTPs to the end user. This function is for custom admin functionality." - }, - "parameters": [ - { - "id": 42, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 517, - "name": "GenerateLinkParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 518, - "name": "GenerateLinkResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 58, - "name": "getUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 184, - "character": 8 - } - ], - "signatures": [ - { - "id": 59, - "name": "getUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get user by id." - }, - "parameters": [ - { - "id": 60, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 320, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 33, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 75, - "character": 8 - } - ], - "signatures": [ - { - "id": 34, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 35, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 39, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata\n" - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 79, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 38, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 78, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [39, 38] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 320, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 46, - "name": "listUsers", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 160, - "character": 8 - } - ], - "signatures": [ - { - "id": 47, - "name": "listUsers", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 48, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 49, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 161, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 50, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 51, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 161, - "character": 14 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 368, - "name": "User" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [51] - } - ] - } - } - }, - { - "id": 52, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 161, - "character": 31 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [49, 52] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 53, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 54, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 161, - "character": 49 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 55, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 56, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 161, - "character": 57 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [56] - } - ] - } - } - }, - { - "id": 57, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 161, - "character": 70 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [54, 57] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 27, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 52, - "character": 8 - } - ], - "signatures": [ - { - "id": 28, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes a logged-in session." - }, - "parameters": [ - { - "id": 29, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 30, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 31, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 52, - "character": 40 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 32, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 52, - "character": 52 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 694, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [31, 32] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 61, - "name": "updateUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 206, - "character": 8 - } - ], - "signatures": [ - { - "id": 62, - "name": "updateUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates the user data." - }, - "parameters": [ - { - "id": 63, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 64, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "reference", - "id": 395, - "name": "AdminUserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 320, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [2] - }, - { - "title": "Properties", - "kind": 1024, - "children": [16] - }, - { - "title": "Methods", - "kind": 2048, - "children": [43, 65, 40, 58, 33, 46, 27, 61] - } - ], - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 18, - "character": 21 - } - ] - }, - { - "id": 74, - "name": "GoTrueClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 75, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 124, - "character": 2 - } - ], - "signatures": [ - { - "id": 76, - "name": "new GoTrueClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Create a new client for use in the browser." - }, - "parameters": [ - { - "id": 77, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 281, - "name": "GoTrueClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 74, - "name": "default" - } - } - ] - }, - { - "id": 78, - "name": "admin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - }, - { - "id": 79, - "name": "mfa", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Namespace for the MFA methods." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 88, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 628, - "name": "GoTrueMFAApi" - } - }, - { - "id": 120, - "name": "getSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 440, - "character": 8 - } - ], - "signatures": [ - { - "id": 121, - "name": "getSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 122, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 123, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 442, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 124, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 125, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 443, - "character": 10 - } - ], - "type": { - "type": "reference", - "id": 331, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [125] - } - ] - } - } - }, - { - "id": 126, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 445, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [123, 126] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 127, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 128, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 448, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 129, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 130, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 449, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [130] - } - ] - } - } - }, - { - "id": 131, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 451, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [128, 131] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 132, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 133, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 454, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 134, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 135, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 455, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [135] - } - ] - } - } - }, - { - "id": 136, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 457, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [133, 136] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 137, - "name": "getUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 504, - "character": 8 - } - ], - "signatures": [ - { - "id": 138, - "name": "getUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the current user details if there is an existing session." - }, - "parameters": [ - { - "id": 139, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 320, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 101, - "name": "initialize", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 159, - "character": 2 - } - ], - "signatures": [ - { - "id": 102, - "name": "initialize", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 681, - "name": "InitializeResult" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 178, - "name": "onAuthStateChange", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 784, - "character": 2 - } - ], - "signatures": [ - { - "id": 179, - "name": "onAuthStateChange", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Receive a notification every time an auth event happens." - }, - "parameters": [ - { - "id": 180, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A callback function to be invoked when an auth event happens.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 181, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 182, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 183, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 280, - "name": "AuthChangeEvent" - } - }, - { - "id": 184, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 331, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 185, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 186, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 785, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 187, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 188, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 785, - "character": 12 - } - ], - "type": { - "type": "reference", - "id": 405, - "name": "Subscription" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [188] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [186] - } - ] - } - } - } - ] - }, - { - "id": 153, - "name": "refreshSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 645, - "character": 8 - } - ], - "signatures": [ - { - "id": 154, - "name": "refreshSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." - }, - "parameters": [ - { - "id": 155, - "name": "currentSession", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The current session. If passed in, it must contain a refresh token.\n" - }, - "type": { - "type": "reflection", - "declaration": { - "id": 156, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 157, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 645, - "character": 42 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [157] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 294, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 189, - "name": "resetPasswordForEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 807, - "character": 8 - } - ], - "signatures": [ - { - "id": 190, - "name": "resetPasswordForEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a password reset request to an email address." - }, - "parameters": [ - { - "id": 191, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 192, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 193, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 195, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 811, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 194, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The URL to send the user to after they click the password reset link." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 810, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [195, 194] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 197, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 815, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 198, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 199, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 816, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [197, 199] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 200, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 201, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 818, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 202, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 818, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [201, 202] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 150, - "name": "setSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 581, - "character": 8 - } - ], - "signatures": [ - { - "id": 151, - "name": "setSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token in the current session is invalid and the current session has expired, an error will be thrown.\nIf the current session does not contain at expires_at field, setSession will use the exp claim defined in the access token." - }, - "parameters": [ - { - "id": 152, - "name": "currentSession", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The current session that minimally contains an access token, refresh token and a user.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 331, - "name": "Session" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "access_token" - }, - { - "type": "literal", - "value": "refresh_token" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 294, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 111, - "name": "signInWithOAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 337, - "character": 8 - } - ], - "signatures": [ - { - "id": 112, - "name": "signInWithOAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user via a third-party provider." - }, - "parameters": [ - { - "id": 113, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 462, - "name": "SignInWithOAuthCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 307, - "name": "OAuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 114, - "name": "signInWithOtp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 352, - "character": 8 - } - ], - "signatures": [ - { - "id": 115, - "name": "signInWithOtp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in a user using magiclink or a one-time password (OTP).\nIf 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." - }, - "parameters": [ - { - "id": 116, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 446, - "name": "SignInWithPasswordlessCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 294, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 108, - "name": "signInWithPassword", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 285, - "character": 8 - } - ], - "signatures": [ - { - "id": 109, - "name": "signInWithPassword", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user with an email and password or phone and password." - }, - "parameters": [ - { - "id": 110, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 431, - "name": "SignInWithPasswordCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 294, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 174, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 765, - "character": 8 - } - ], - "signatures": [ - { - "id": 175, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 176, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 177, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 765, - "character": 29 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 694, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [177] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 105, - "name": "signUp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 222, - "character": 8 - } - ], - "signatures": [ - { - "id": 106, - "name": "signUp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" - }, - "parameters": [ - { - "id": 107, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 415, - "name": "SignUpWithPasswordCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 294, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 140, - "name": "updateUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 533, - "character": 8 - } - ], - "signatures": [ - { - "id": 141, - "name": "updateUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates user data, if there is a logged in user." - }, - "parameters": [ - { - "id": 142, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 390, - "name": "UserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 320, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 117, - "name": "verifyOtp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 396, - "character": 8 - } - ], - "signatures": [ - { - "id": 118, - "name": "verifyOtp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in a user given a User supplied OTP received via mobile." - }, - "parameters": [ - { - "id": 119, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 473, - "name": "VerifyOtpParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 294, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [75] - }, - { - "title": "Properties", - "kind": 1024, - "children": [78, 79] - }, - { - "title": "Methods", - "kind": 2048, - "children": [120, 137, 101, 178, 153, 189, 150, 111, 114, 108, 174, 105, 140, 117] - } - ], - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 79, - "character": 21 - } - ] - }, - { - "id": 340, - "name": "AMREntry", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "An authentication methord reference (AMR) entry.", - "text": "An entry designates what method was used by the user to verify their\nidentity and at what time.\n", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}.\n" - } - ] - }, - "children": [ - { - "id": 341, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Authentication method name." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 342, - "name": "timestamp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 148, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [341, 342] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 140, - "character": 17 - } - ] - }, - { - "id": 395, - "name": "AdminUserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 397, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", - "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 270, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 400, - "name": "ban_duration", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Determines how long a user is banned for.", - "text": "The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 296, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 404, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 245, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - }, - "inheritedFrom": { - "type": "reference", - "id": 394, - "name": "UserAttributes.data" - } - }, - { - "id": 401, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 227, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 391, - "name": "UserAttributes.email" - } - }, - { - "id": 398, - "name": "email_confirm", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Confirms the user's email address if set to true.", - "text": "Only a service role can modify.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 277, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 403, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 237, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 393, - "name": "UserAttributes.password" - } - }, - { - "id": 402, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 232, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 392, - "name": "UserAttributes.phone" - } - }, - { - "id": 399, - "name": "phone_confirm", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Confirms the user's phone number if set to true.", - "text": "Only a service role can modify.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 396, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 260, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [397, 400, 404, 401, 398, 403, 402, 399, 396] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 248, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 390, - "name": "UserAttributes" - } - ] - }, - { - "id": 354, - "name": "Factor", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "A MFA factor.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#listFactors}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAAdminApi#listFactors}\n" - } - ] - }, - "children": [ - { - "id": 359, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 186, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 357, - "name": "factor_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of factor. Only `totp` supported with this version but may change in\nfuture versions." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 181, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 356, - "name": "friendly_name", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Friendly name of the factor, useful to disambiguate between multiple factors." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 175, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 355, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 172, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 358, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Factor's status." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 184, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "verified" - }, - { - "type": "literal", - "value": "unverified" - } - ] - } - }, - { - "id": 360, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 187, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [359, 357, 356, 355, 358, 360] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 170, - "character": 17 - } - ] - }, - { - "id": 514, - "name": "GenerateLinkOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 515, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 507, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 516, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The URL which will be appended to the email link generated." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 509, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [515, 516] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 501, - "character": 17 - } - ] - }, - { - "id": 673, - "name": "GoTrueAdminMFAApi", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "Contains the full multi-factor authentication administration API.", - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "children": [ - { - "id": 677, - "name": "deleteFactor", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 678, - "name": "deleteFactor", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes a factor on a user. This will log the user out of all active\nsessions (if the deleted factor was verified). There's no need to delete\nunverified factors.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#unenroll}\n" - }, - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 679, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 657, - "name": "AuthMFAAdminDeleteFactorParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 648, - "name": "AuthMFAAdminDeleteFactorResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 674, - "name": "listFactors", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 675, - "name": "listFactors", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Lists all factors attached to a user.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 676, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 670, - "name": "AuthMFAAdminListFactorsParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 661, - "name": "AuthMFAAdminListFactorsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "kind": 2048, - "children": [677, 674] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 900, - "character": 17 - } - ] - }, - { - "id": 628, - "name": "GoTrueMFAApi", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "comment": { - "shortText": "Contains the full multi-factor authentication API.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "children": [ - { - "id": 632, - "name": "challenge", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 633, - "name": "challenge", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Prepares a challenge used to verify that a user has access to a MFA\nfactor. Provide the challenge ID and verification code by calling\n{@link GoTrueMFAApi#verify}.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 634, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 552, - "name": "MFAChallengeParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 596, - "name": "AuthMFAChallengeResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 641, - "name": "challengeAndVerify", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 642, - "name": "challengeAndVerify", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#challengeAndVerify}\n" - }, - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 643, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 555, - "name": "MFAChallengeAndVerifyParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 559, - "name": "AuthMFAVerifyResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 629, - "name": "enroll", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 630, - "name": "enroll", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Starts the enrollment process for a new Multi-Factor Authentication\nfactor. This method creates a new factor in the 'unverified' state.\nPresent the QR code or secret to the user and ask them to add it to their\nauthenticator app. Ask the user to provide you with an authenticator code\nfrom their app and verify it by calling challenge and then verify.", - "text": "The first successful verification of an unverified factor activates the\nfactor. All other sessions are logged out and the current one gets an\n`aal2` authenticator level.\n", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#challenge}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#verify}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}\n" - }, - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 631, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 539, - "name": "MFAEnrollParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 572, - "name": "AuthMFAEnrollResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 646, - "name": "getAuthenticatorAssuranceLevel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 647, - "name": "getAuthenticatorAssuranceLevel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the Authenticator Assurance Level (AAL) for the active session.", - "text": "- `aal1` (or `null`) means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- `aal2` means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nAlthough this method returns a promise, it's fairly quick (microseconds)\nand rarely uses the network. You can use this to check whether the current\nuser needs to be shown a screen to verify their MFA factors.\n", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 617, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 644, - "name": "listFactors", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 645, - "name": "listFactors", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the list of MFA factors enabled for this user. For most use cases\nyou should consider using {@link\nGoTrueMFAApi#getAuthenticatorAssuranceLevel}. This uses a cached version\nof the factors and avoids incurring a network call. If you need to update\nthis list, call {@link GoTrueClient#getUser} first.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#enroll}" - }, - { - "tag": "see", - "text": "{@link GoTrueMFAApi#getAuthenticatorAssuranceLevel}" - }, - { - "tag": "see", - "text": "{@link GoTrueClient#getUser}\n" - }, - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 606, - "name": "AuthMFAListFactorsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 638, - "name": "unenroll", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 639, - "name": "unenroll", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Unenroll removes a MFA factor. Unverified factors can safely be ignored\nand it's not necessary to unenroll them. Unenrolling a verified MFA factor\ncannot be done from a session with an `aal1` authenticator level.", - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 640, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 544, - "name": "MFAUnenrollParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 587, - "name": "AuthMFAUnenrollResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 635, - "name": "verify", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "signatures": [ - { - "id": 636, - "name": "verify", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Verifies a verification code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#challenge}\n" - }, - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "parameters": [ - { - "id": 637, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 547, - "name": "MFAVerifyParams" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 559, - "name": "AuthMFAVerifyResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "kind": 2048, - "children": [632, 641, 629, 646, 644, 638, 635] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 760, - "character": 17 - } - ] - }, - { - "id": 331, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 334, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 115, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 337, - "name": "expires_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 127, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 336, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 123, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 333, - "name": "provider_refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 332, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 106, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 335, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "A one-time used refresh token that never expires." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 119, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 338, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 339, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 129, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 368, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [334, 337, 336, 333, 332, 335, 338, 339] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 17 - } - ] - }, - { - "id": 405, - "name": "Subscription", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 406, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The subscriber UUID. This will be set by the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 303, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "callback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 307, - "character": 2 - } - ], - "signatures": [ - { - "id": 408, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ - { - "id": 409, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 280, - "name": "AuthChangeEvent" - } - }, - { - "id": 410, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 331, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 411, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 311, - "character": 2 - } - ], - "signatures": [ - { - "id": 412, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Call this to remove the listener." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [406] - }, - { - "title": "Methods", - "kind": 2048, - "children": [407, 411] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 299, - "character": 17 - } - ] - }, - { - "id": 413, - "name": "UpdatableFactorAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 414, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 315, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [414] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 314, - "character": 17 - } - ] - }, - { - "id": 368, - "name": "User", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 378, - "name": "action_link", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 209, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 370, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 201, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 361, - "name": "UserAppMetadata" - } - }, - { - "id": 372, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 203, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 373, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 204, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 382, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 213, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 381, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 212, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 379, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 210, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 375, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 206, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 383, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 214, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 389, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 220, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 354, - "name": "Factor" - } - } - }, - { - "id": 369, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 200, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 388, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 219, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 343, - "name": "UserIdentity" - } - } - }, - { - "id": 377, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 208, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 385, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 216, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 376, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 207, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 380, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 211, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 384, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 215, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 374, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 205, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 386, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 217, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 387, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 218, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 371, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 202, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 365, - "name": "UserMetadata" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 378, 370, 372, 373, 382, 381, 379, 375, 383, 389, 369, 388, 377, 385, 376, 380, 384, - 374, 386, 387, 371 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 199, - "character": 17 - } - ] - }, - { - "id": 361, - "name": "UserAppMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 362, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 191, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [362] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 190, - "character": 17 - } - ], - "indexSignature": { - "id": 363, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 364, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "id": 390, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 394, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 245, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 391, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 227, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 393, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 237, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 392, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 232, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [394, 391, 393, 392] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 223, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 395, - "name": "AdminUserAttributes" - } - ] - }, - { - "id": 343, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 351, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 158, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 346, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 154, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 347, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 348, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 349, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 352, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 159, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 350, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 353, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 160, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 345, - "name": "user_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 153, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [351, 344, 346, 352, 350, 353, 345] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 151, - "character": 17 - } - ] - }, - { - "id": 365, - "name": "UserMetadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 195, - "character": 17 - } - ], - "indexSignature": { - "id": 366, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 367, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "id": 482, - "name": "VerifyEmailOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 483, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 453, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 486, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 458, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 487, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 489, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 462, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 488, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 460, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [489, 488] - } - ] - } - } - }, - { - "id": 484, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The otp sent to the user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 455, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 485, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 457, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 491, - "name": "EmailOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [483, 486, 484, 485] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 451, - "character": 17 - } - ] - }, - { - "id": 474, - "name": "VerifyMobileOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 478, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 444, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 479, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 481, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 448, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 480, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 446, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [481, 480] - } - ] - } - } - }, - { - "id": 475, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 439, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 476, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The otp sent to the user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 441, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 477, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 443, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 490, - "name": "MobileOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [478, 475, 476, 477] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 437, - "character": 17 - } - ] - }, - { - "id": 280, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 28, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "USER_DELETED" - }, - { - "type": "reference", - "id": 279, - "name": "AuthChangeEventMFA" - } - ] - } - }, - { - "id": 279, - "name": "AuthChangeEventMFA", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 26, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 657, - "name": "AuthMFAAdminDeleteFactorParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 866, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 658, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 659, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the MFA factor to delete." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 868, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 660, - "name": "userId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the user whose factor is being deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 871, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [659, 660] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 866, - "character": 45 - } - ] - } - } - }, - { - "id": 648, - "name": "AuthMFAAdminDeleteFactorResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 853, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 650, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 855, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 651, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 652, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully deleted." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 857, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [652] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 855, - "character": 12 - } - ] - } - } - }, - { - "id": 653, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 859, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [650, 653] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 854, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 654, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 655, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 861, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 656, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 861, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [655, 656] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 861, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 670, - "name": "AuthMFAAdminListFactorsParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 890, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 671, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 672, - "name": "userId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the user for which to list all MFA factors." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 892, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [672] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 890, - "character": 44 - } - ] - } - } - }, - { - "id": 661, - "name": "AuthMFAAdminListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "expermental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 877, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 662, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 663, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 879, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 664, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 665, - "name": "factors", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All factors attached to the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 881, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 354, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [665] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 879, - "character": 12 - } - ] - } - } - }, - { - "id": 666, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 883, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [663, 666] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 878, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 667, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 668, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 885, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 669, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 885, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [668, 669] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 885, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 596, - "name": "AuthMFAChallengeResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 693, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 597, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 598, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 695, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 599, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 601, - "name": "expires_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Timestamp in UNIX seconds when this challenge will no longer be usable." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 700, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 600, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the newly created challenge." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 697, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [601, 600] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 695, - "character": 12 - } - ] - } - } - }, - { - "id": 602, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 702, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [598, 602] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 694, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 603, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 604, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 704, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 605, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 704, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [604, 605] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 704, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 572, - "name": "AuthMFAEnrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 644, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 573, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 574, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 646, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 575, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 576, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was just enrolled (in an unverified state)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 648, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 578, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "TOTP enrollment information." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 654, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 579, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 580, - "name": "qr_code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Contains a QR code encoding the authenticator URI. You can\nconvert it to a URL by prepending `data:image/svg+xml;utf-8,` to\nthe value. Avoid logging this value to the console." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 658, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 581, - "name": "secret", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The TOTP secret (also encoded in the QR code). Show this secret\nin a password-style field to the user, in case they are unable to\nscan the QR code. Avoid logging this value to the console." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 663, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 582, - "name": "uri", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The authenticator URI encoded within the QR code, should you need\nto use it. Avoid loggin this value to the console." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 667, - "character": 10 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [580, 581, 582] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 654, - "character": 14 - } - ] - } - } - }, - { - "id": 577, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of MFA factor. Only `totp` supported for now." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 651, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [576, 578, 577] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 646, - "character": 12 - } - ] - } - } - }, - { - "id": 583, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 670, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [574, 583] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 645, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 584, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 585, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 673, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 586, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 674, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [585, 586] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 672, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 617, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 730, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 618, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 619, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 732, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 620, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 623, - "name": "currentAuthenticationMethods", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 749, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 340, - "name": "AMREntry" - } - } - }, - { - "id": 621, - "name": "currentLevel", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Current AAL level of the session." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 734, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 616, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 622, - "name": "nextLevel", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA.", - "tags": [ - { - "tag": "see", - "text": "{@link GoTrueMFAApi#challenge}\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 742, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 616, - "name": "AuthenticatorAssuranceLevels" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [623, 621, 622] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 732, - "character": 12 - } - ] - } - } - }, - { - "id": 624, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 751, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [619, 624] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 731, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 625, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 626, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 753, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 627, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 753, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [626, 627] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 753, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 606, - "name": "AuthMFAListFactorsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 709, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 607, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 608, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 711, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 609, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 610, - "name": "all", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "All available factors (verified and unverified)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 713, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 354, - "name": "Factor" - } - } - }, - { - "id": 611, - "name": "totp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Only verified TOTP factors. (A subset of `all`.)" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 716, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 354, - "name": "Factor" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [610, 611] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 711, - "character": 12 - } - ] - } - } - }, - { - "id": 612, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 718, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [608, 612] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 710, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 613, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 614, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 720, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 615, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 720, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [614, 615] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 720, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 587, - "name": "AuthMFAUnenrollResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 588, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 589, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 682, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 590, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 591, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor that was successfully unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 684, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [591] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 682, - "character": 12 - } - ] - } - } - }, - { - "id": 592, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 686, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [589, 592] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 681, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 593, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 594, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 688, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 595, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 688, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [594, 595] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 688, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 559, - "name": "AuthMFAVerifyResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 616, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 560, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 561, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 618, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 562, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 563, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "New access token (JWT) after successful verification." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 620, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 565, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Number of seconds in which the access token will expire." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 626, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 566, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Refresh token you can use to obtain new access tokens when expired." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 629, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 564, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Type of token, typically `Bearer`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 623, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 567, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Updated user profile." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 632, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 368, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [563, 565, 566, 564, 567] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 618, - "character": 12 - } - ] - } - } - }, - { - "id": 568, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 634, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [561, 568] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 617, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 569, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 570, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 637, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 571, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 638, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [570, 571] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 636, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 294, - "name": "AuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 295, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 296, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 297, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 299, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 331, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 298, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 368, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [299, 298] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 58, - "character": 12 - } - ] - } - } - }, - { - "id": 300, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [296, 300] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 301, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 302, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 65, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 303, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 305, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 67, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 304, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 66, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [305, 304] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 65, - "character": 12 - } - ] - } - } - }, - { - "id": 306, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 69, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [302, 306] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 616, - "name": "AuthenticatorAssuranceLevels", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 725, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - } - ] - } - }, - { - "id": 684, - "name": "CallRefreshTokenResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 933, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 685, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 687, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 936, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 686, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 935, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 331, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [687, 686] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 934, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 688, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 690, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 940, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - }, - { - "id": 689, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 939, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [690, 689] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 938, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 491, - "name": "EmailOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 467, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - }, - { - "id": 508, - "name": "GenerateEmailChangeLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 490, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 509, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 511, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 493, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 512, - "name": "newEmail", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 497, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 513, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 498, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 514, - "name": "GenerateLinkOptions" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 510, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 491, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [511, 512, 513, 510] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 490, - "character": 44 - } - ] - } - } - }, - { - "id": 498, - "name": "GenerateInviteOrMagiclinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 476, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 499, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 501, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 479, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 502, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 480, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 514, - "name": "GenerateLinkOptions" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 500, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 477, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [501, 502, 500] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 476, - "character": 46 - } - ] - } - } - }, - { - "id": 517, - "name": "GenerateLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 512, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 492, - "name": "GenerateSignupLinkParams" - }, - { - "type": "reference", - "id": 498, - "name": "GenerateInviteOrMagiclinkParams" - }, - { - "type": "reference", - "id": 503, - "name": "GenerateRecoveryLinkParams" - }, - { - "type": "reference", - "id": 508, - "name": "GenerateEmailChangeLinkParams" - } - ] - } - }, - { - "id": 531, - "name": "GenerateLinkProperties", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "The properties related to the email link generated" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 535, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 532, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 533, - "name": "action_link", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 540, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 534, - "name": "email_otp", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 545, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 535, - "name": "hashed_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The hashed token appended to the action link." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 549, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 536, - "name": "redirect_to", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The URL appended to the action link." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 551, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 537, - "name": "verification_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The verification type that the email link is associated to." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 553, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 538, - "name": "GenerateLinkType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [533, 534, 535, 536, 537] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 535, - "character": 37 - } - ] - } - } - }, - { - "id": 518, - "name": "GenerateLinkResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 518, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 519, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 520, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 521, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 522, - "name": "properties", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 521, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 531, - "name": "GenerateLinkProperties" - } - }, - { - "id": 523, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 522, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 368, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [522, 523] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 520, - "character": 12 - } - ] - } - } - }, - { - "id": 524, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 524, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [520, 524] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 519, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 525, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 526, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 527, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 528, - "name": "properties", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 528, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 529, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 529, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [528, 529] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 527, - "character": 12 - } - ] - } - } - }, - { - "id": 530, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 531, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [526, 530] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 526, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 538, - "name": "GenerateLinkType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 556, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - }, - { - "id": 503, - "name": "GenerateRecoveryLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 483, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 504, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 506, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 486, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 507, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 487, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 514, - "name": "GenerateLinkOptions" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 505, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 484, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [506, 507, 505] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 483, - "character": 41 - } - ] - } - } - }, - { - "id": 492, - "name": "GenerateSignupLinkParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 469, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 493, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 495, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 471, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 497, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 473, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 514, - "name": "GenerateLinkOptions" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 496, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 472, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 494, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 470, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [495, 497, 496, 494] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 469, - "character": 39 - } - ] - } - } - }, - { - "id": 281, - "name": "GoTrueClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 37, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 282, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 290, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 289, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 45, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 293, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 53, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "Fetch" - } - }, - { - "id": 284, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 285, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 41, - "character": 12 - } - ], - "indexSignature": { - "id": 286, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 287, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 291, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 292, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 680, - "name": "SupportedStorage" - } - }, - { - "id": 288, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 283, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [290, 289, 293, 284, 291, 292, 288, 283] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 37, - "character": 34 - } - ] - } - } - }, - { - "id": 681, - "name": "InitializeResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 931, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 682, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 683, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 931, - "character": 33 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 694, - "name": "AuthError" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [683] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 931, - "character": 31 - } - ] - } - } - }, - { - "id": 555, - "name": "MFAChallengeAndVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 606, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 558, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 610, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 557, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being verified." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 608, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [558, 557] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 606, - "character": 42 - } - ] - } - } - }, - { - "id": 552, - "name": "MFAChallengeParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 598, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 553, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 554, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor to be challenged." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 600, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [554] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 598, - "character": 33 - } - ] - } - } - }, - { - "id": 539, - "name": "MFAEnrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 567, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 540, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 541, - "name": "factorType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 568, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "totp" - } - }, - { - "id": 543, - "name": "friendlyName", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 570, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 542, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 569, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [541, 543, 542] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 567, - "character": 30 - } - ] - } - } - }, - { - "id": 544, - "name": "MFAUnenrollParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 576, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 545, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 546, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being unenrolled." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 578, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [546] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 576, - "character": 32 - } - ] - } - } - }, - { - "id": 547, - "name": "MFAVerifyParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "experimental", - "text": "\n" - } - ] - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 584, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 548, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 550, - "name": "challengeId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the challenge being verified." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 589, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 551, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Verification code provided by the user." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 592, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 549, - "name": "factorId", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "ID of the factor being verified." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 586, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [550, 551, 549] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 584, - "character": 30 - } - ] - } - } - }, - { - "id": 490, - "name": "MobileOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 466, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - }, - { - "id": 307, - "name": "OAuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 308, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 309, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 74, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 310, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 311, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 75, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 278, - "name": "Provider" - } - }, - { - "id": 312, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 76, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [311, 312] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 74, - "character": 12 - } - ] - } - } - }, - { - "id": 313, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [309, 313] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 314, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 315, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 81, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 316, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 317, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 278, - "name": "Provider" - } - }, - { - "id": 318, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 83, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [317, 318] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 81, - "character": 12 - } - ] - } - } - }, - { - "id": 319, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [315, 319] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 80, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 278, - "name": "Provider", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 5, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "workos" - } - ] - } - }, - { - "id": 462, - "name": "SignInWithOAuthCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 423, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 463, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 465, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 426, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 466, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 469, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An object of query params" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 432, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 432, - "character": 18 - } - ], - "indexSignature": { - "id": 471, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 472, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 467, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 428, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 468, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 430, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [469, 467, 468] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 426, - "character": 12 - } - ] - } - } - }, - { - "id": 464, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 425, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 278, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [465, 464] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 423, - "character": 41 - } - ] - } - } - }, - { - "id": 431, - "name": "SignInWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 353, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 432, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 433, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 356, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 359, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 436, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 438, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 367, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 437, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 365, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [438, 437] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 359, - "character": 16 - } - ] - } - } - }, - { - "id": 434, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 358, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [433, 435, 434] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 354, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 439, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 442, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 375, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 443, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 445, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 383, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 444, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 381, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [445, 444] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 375, - "character": 16 - } - ] - } - } - }, - { - "id": 441, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 374, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 440, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 372, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [442, 441, 440] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 370, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 446, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 387, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 447, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 448, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 390, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 449, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 391, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 450, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 454, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 403, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 453, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 401, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 451, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 393, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 452, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 395, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [454, 453, 451, 452] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 391, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [448, 449] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 388, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 455, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 457, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 409, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 458, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 461, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 419, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 460, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 417, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 459, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 411, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [461, 460, 459] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 409, - "character": 16 - } - ] - } - } - }, - { - "id": 456, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 408, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [457, 456] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 406, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 415, - "name": "SignUpWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 318, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 416, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 417, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 321, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 419, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 420, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 423, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 334, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 332, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 421, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 326, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [423, 422, 421] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 16 - } - ] - } - } - }, - { - "id": 418, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 323, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [417, 419, 418] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 319, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 424, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 427, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 428, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 430, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 429, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", - "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 348, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [430, 429] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 342, - "character": 16 - } - ] - } - } - }, - { - "id": 426, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 341, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 425, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 339, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [427, 426, 425] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 337, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 680, - "name": "SupportedStorage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 929, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - ], - "name": "PromisifyMethods" - } - }, - { - "id": 320, - "name": "UserResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 88, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 322, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 323, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 324, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 91, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 368, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [324] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 90, - "character": 12 - } - ] - } - } - }, - { - "id": 325, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [322, 325] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 89, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 326, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 327, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 96, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 328, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 329, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 97, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [329] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 96, - "character": 12 - } - ] - } - } - }, - { - "id": 330, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [327, 330] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 95, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 473, - "name": "VerifyOtpParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 436, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 474, - "name": "VerifyMobileOtpParams" - }, - { - "type": "reference", - "id": 482, - "name": "VerifyEmailOtpParams" - } - ] - } - }, - { - "id": 691, - "name": "isAuthError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 10, - "character": 16 - } - ], - "signatures": [ - { - "id": 692, - "name": "isAuthError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 693, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 694, - "name": "AuthError" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [699, 694, 759, 746, 784, 734, 712, 719, 1, 74] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [ - 340, 395, 354, 514, 673, 628, 331, 405, 413, 368, 361, 390, 343, 365, 482, 474 - ] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [ - 280, 279, 657, 648, 670, 661, 596, 572, 617, 606, 587, 559, 294, 616, 684, 491, 508, - 498, 517, 531, 518, 538, 503, 492, 281, 681, 555, 552, 539, 544, 547, 490, 307, 278, - 462, 431, 446, 415, 680, 320, 473 - ] - }, - { - "title": "Functions", - "kind": 64, - "children": [691] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 0, - "name": "@supabase/postgrest-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 498, - "name": "PostgrestBuilder", - "kind": 128, - "kindString": "Class", - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 499, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L18" - } - ], - "signatures": [ - { - "id": 500, - "name": "new PostgrestBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 501, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 502, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 515, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 507, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 510, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L15" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 511, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 18044, - "character": 17 - } - ], - "signatures": [ - { - "id": 512, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 513, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestInfo", - "qualifiedName": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 514, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "name": "RequestInit", - "qualifiedName": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Response", - "qualifiedName": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "qualifiedName": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 505, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L10" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 503, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L8" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 506, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 508, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 509, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L14" - } - ], - "type": { - "type": "reference", - "name": "AbortSignal", - "qualifiedName": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 504, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L9" - } - ], - "type": { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - }, - { - "id": 518, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L48" - } - ], - "signatures": [ - { - "id": 519, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 520, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - }, - { - "id": 521, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 522, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 50, - "character": 9, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L50" - } - ], - "signatures": [ - { - "id": 524, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 525, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 526, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 53, - "character": 18, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L53" - } - ], - "signatures": [ - { - "id": 528, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 529, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ] - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "name": "PromiseLike.then" - } - }, - { - "id": 516, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L43" - } - ], - "signatures": [ - { - "id": 517, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ] - }, - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [499] - }, - { - "title": "Properties", - "children": [515, 507, 510, 505, 503, 506, 508, 509, 504] - }, - { - "title": "Methods", - "children": [518, 516] - } - ], - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 5, - "character": 30, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L5" - } - ], - "typeParameters": [ - { - "id": 530, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 401, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 501, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - }, - { - "id": 1, - "name": "PostgrestClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "PostgREST client." - } - ] - }, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 41, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L41" - } - ], - "signatures": [ - { - "id": 3, - "name": "new PostgrestClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a PostgREST client." - } - ] - }, - "typeParameter": [ - { - "id": 4, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 6, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 7, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the PostgREST endpoint" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 8, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 12, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 50, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L50" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 13, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 18044, - "character": 17 - } - ], - "signatures": [ - { - "id": 14, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch" - } - ] - }, - "parameters": [ - { - "id": 15, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestInfo", - "qualifiedName": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 16, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "name": "RequestInit", - "qualifiedName": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Response", - "qualifiedName": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "qualifiedName": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 10, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 48, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L48" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 11, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to switch to" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 49, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L49" - } - ], - "type": { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [12, 10, 11] - } - ], - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 47, - "character": 7, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L47" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 1, - "typeArguments": [ - { - "type": "reference", - "id": 4, - "name": "Database" - }, - { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - { - "type": "reference", - "id": 6, - "name": "Schema" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 20, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 29, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L29" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 18044, - "character": 17 - } - ], - "signatures": [ - { - "id": 22, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 23, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestInfo", - "qualifiedName": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 24, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "name": "RequestInit", - "qualifiedName": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Response", - "qualifiedName": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "qualifiedName": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 18, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L27" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 19, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L28" - } - ], - "type": { - "type": "reference", - "id": 5, - "name": "SchemaName" - } - }, - { - "id": 17, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 25, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 64, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L64" - }, - { - "fileName": "src/PostgrestClient.ts", - "line": 68, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L68" - }, - { - "fileName": "src/PostgrestClient.ts", - "line": 71, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L71" - }, - { - "fileName": "src/PostgrestClient.ts", - "line": 72, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L72" - } - ], - "signatures": [ - { - "id": 26, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a query on a table or a view." - } - ] - }, - "typeParameter": [ - { - "id": 27, - "name": "TableName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 28, - "name": "Table", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericTable" - } - } - ], - "parameters": [ - { - "id": 29, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The table or view name to query" - } - ] - }, - "type": { - "type": "reference", - "id": 27, - "name": "TableName" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "reference", - "id": 28, - "name": "Table" - } - ], - "name": "default" - } - }, - { - "id": 30, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 31, - "name": "ViewName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "View", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericView" - } - } - ], - "parameters": [ - { - "id": 33, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 31, - "name": "ViewName" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "reference", - "id": 32, - "name": "View" - } - ], - "name": "default" - } - }, - { - "id": 34, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 35, - "name": "relation", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 36, - "name": "rpc", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 102, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L102" - } - ], - "signatures": [ - { - "id": 37, - "name": "rpc", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a function call." - } - ] - }, - "typeParameter": [ - { - "id": 38, - "name": "FunctionName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "Function_", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericFunction" - } - } - ], - "parameters": [ - { - "id": 40, - "name": "fn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function name to call" - } - ] - }, - "type": { - "type": "reference", - "id": 38, - "name": "FunctionName" - } - }, - { - "id": 41, - "name": "args", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The arguments to pass to the function call" - } - ] - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Args" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - }, - "defaultValue": "{}" - }, - { - "id": 42, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 43, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 45, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 113, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L113" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 44, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 112, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L112" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [45, 44] - } - ], - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 111, - "character": 7, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L111" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 6, - "name": "Schema" - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - } - }, - "extendsType": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Returns" - }, - "objectType": { - "type": "reference", - "id": 39, - "name": "Function_" - } - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [20, 18, 19, 17] - }, - { - "title": "Methods", - "children": [25, 36] - } - ], - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 17, - "character": 21, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestClient.ts#L17" - } - ], - "typeParameters": [ - { - "id": 46, - "name": "Database", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)" - } - ] - }, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 47, - "name": "SchemaName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n" - }, - { - "kind": "code", - "text": "`\"public\"`" - }, - { - "kind": "text", - "text": ", this must be supplied manually." - } - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "id": 4, - "name": "Database" - } - } - ] - } - } - }, - { - "id": 48, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "extendsType": { - "type": "reference", - "name": "GenericSchema" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 5, - "name": "SchemaName" - }, - "objectType": { - "type": "reference", - "id": 4, - "name": "Database" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 112, - "name": "PostgrestFilterBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 113, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L18" - } - ], - "signatures": [ - { - "id": 114, - "name": "new PostgrestFilterBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 115, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 116, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 117, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 118, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 403, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 402, - "name": "default.constructor" - } - }, - { - "id": 383, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 480, - "name": "default.allowEmpty" - } - }, - { - "id": 375, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "id": 472, - "name": "default.body" - } - }, - { - "id": 378, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L15" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 379, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 18044, - "character": 17 - } - ], - "signatures": [ - { - "id": 380, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 381, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestInfo", - "qualifiedName": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 382, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "name": "RequestInit", - "qualifiedName": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Response", - "qualifiedName": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "qualifiedName": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 475, - "name": "default.fetch" - } - }, - { - "id": 373, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L10" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 470, - "name": "default.headers" - } - }, - { - "id": 371, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L8" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 468, - "name": "default.method" - } - }, - { - "id": 374, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 471, - "name": "default.schema" - } - }, - { - "id": 376, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 473, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 377, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L14" - } - ], - "type": { - "type": "reference", - "name": "AbortSignal", - "qualifiedName": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 474, - "name": "default.signal" - } - }, - { - "id": 372, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L9" - } - ], - "type": { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 469, - "name": "default.url" - } - }, - { - "id": 345, - "name": "abortSignal", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 130, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L130" - } - ], - "signatures": [ - { - "id": 346, - "name": "abortSignal", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ] - }, - "parameters": [ - { - "id": 347, - "name": "signal", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "name": "AbortSignal", - "qualifiedName": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 443, - "name": "default.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 442, - "name": "default.abortSignal" - } - }, - { - "id": 207, - "name": "containedBy", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 216, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L216" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 220, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L220" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 221, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L221" - } - ], - "signatures": [ - { - "id": 208, - "name": "containedBy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is contained by " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 209, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 210, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The jsonb, array, or range column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 209, - "name": "ColumnName" - } - }, - { - "id": 211, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The jsonb, array, or range value to filter with" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 209, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 212, - "name": "containedBy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 213, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 199, - "name": "contains", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 189, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L189" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 193, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L193" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 194, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L194" - } - ], - "signatures": [ - { - "id": 200, - "name": "contains", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " contains every element appearing in " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 201, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 202, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The jsonb, array, or range column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 201, - "name": "ColumnName" - } - }, - { - "id": 203, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The jsonb, array, or range value to filter with" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 201, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 204, - "name": "contains", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 205, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 206, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 352, - "name": "csv", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 161, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L161" - } - ], - "signatures": [ - { - "id": 353, - "name": "csv", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 450, - "name": "default.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 449, - "name": "default.csv" - } - }, - { - "id": 119, - "name": "eq", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 41, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L41" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 42, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L42" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L43" - } - ], - "signatures": [ - { - "id": 120, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nTo check if the value of " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL, you should use " - }, - { - "kind": "code", - "text": "`.is()`" - }, - { - "kind": "text", - "text": " instead." - } - ] - }, - "typeParameter": [ - { - "id": 121, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 122, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 121, - "name": "ColumnName" - } - }, - { - "id": 123, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 121, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 124, - "name": "eq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 125, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 126, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 356, - "name": "explain", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 195, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L195" - } - ], - "signatures": [ - { - "id": 357, - "name": "explain", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query." - } - ] - }, - "parameters": [ - { - "id": 358, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 360, - "name": "analyze", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L203" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 363, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L206" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 365, - "name": "format", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 208, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L208" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 362, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L205" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 361, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L204" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 364, - "name": "wal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L207" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [360, 363, 365, 362, 361, 364] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 202, - "character": 5, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L202" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - ], - "name": "PostgrestResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 454, - "name": "default.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 453, - "name": "default.explain" - } - }, - { - "id": 301, - "name": "filter", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 441, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L441" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 446, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L446" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 447, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L447" - } - ], - "signatures": [ - { - "id": 302, - "name": "filter", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`opearator`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." - } - ] - }, - "typeParameter": [ - { - "id": 303, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 304, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 303, - "name": "ColumnName" - } - }, - { - "id": 305, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operator to filter with, following PostgREST syntax" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "FilterOperator" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - } - ] - } - }, - { - "id": 306, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with, following PostgREST syntax" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 307, - "name": "filter", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 308, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 309, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 310, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 354, - "name": "geojson", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L169" - } - ], - "signatures": [ - { - "id": 355, - "name": "geojson", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 452, - "name": "default.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 451, - "name": "default.geojson" - } - }, - { - "id": 135, - "name": "gt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L67" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 68, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L68" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 69, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L69" - } - ], - "signatures": [ - { - "id": 136, - "name": "gt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 137, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 138, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 137, - "name": "ColumnName" - } - }, - { - "id": 139, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 137, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 140, - "name": "gt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 141, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 142, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 143, - "name": "gte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 80, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L80" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 81, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L81" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L82" - } - ], - "signatures": [ - { - "id": 144, - "name": "gte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than or equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 145, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 146, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 145, - "name": "ColumnName" - } - }, - { - "id": 147, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 145, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 148, - "name": "gte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 149, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 150, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 175, - "name": "ilike", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L132" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 133, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L133" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 134, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L134" - } - ], - "signatures": [ - { - "id": 176, - "name": "ilike", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ] - }, - "typeParameter": [ - { - "id": 177, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 178, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 177, - "name": "ColumnName" - } - }, - { - "id": 179, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The pattern to match with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 180, - "name": "ilike", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 181, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 182, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 191, - "name": "in", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 167, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L167" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 168, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L168" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 169, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L169" - } - ], - "signatures": [ - { - "id": 192, - "name": "in", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ] - }, - "typeParameter": [ - { - "id": 193, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 194, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 193, - "name": "ColumnName" - } - }, - { - "id": 195, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 193, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 196, - "name": "in", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 197, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 198, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 183, - "name": "is", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L151" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L155" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L156" - } - ], - "signatures": [ - { - "id": 184, - "name": "is", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL by setting " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\n\nFor boolean columns, you can also set " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " and it\nwill behave the same way as " - }, - { - "kind": "code", - "text": "`.eq()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 185, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 186, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 185, - "name": "ColumnName" - } - }, - { - "id": 187, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "Object" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 188, - "name": "is", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 189, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 190, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 167, - "name": "like", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 119, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L119" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 120, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L120" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L121" - } - ], - "signatures": [ - { - "id": 168, - "name": "like", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ] - }, - "typeParameter": [ - { - "id": 169, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 170, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 169, - "name": "ColumnName" - } - }, - { - "id": 171, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The pattern to match with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 172, - "name": "like", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 173, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 174, - "name": "pattern", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 332, - "name": "limit", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L101" - } - ], - "signatures": [ - { - "id": 333, - "name": "limit", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "parameters": [ - { - "id": 334, - "name": "count", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 335, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 336, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 337, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of foreign tables\ninstead of the current table" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 43, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L101" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [337] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 41, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L101" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 430, - "name": "default.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 429, - "name": "default.limit" - } - }, - { - "id": 151, - "name": "lt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L93" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L94" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 95, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L95" - } - ], - "signatures": [ - { - "id": 152, - "name": "lt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 153, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 154, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 153, - "name": "ColumnName" - } - }, - { - "id": 155, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 153, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 156, - "name": "lt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 157, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 158, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 159, - "name": "lte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 106, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L106" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L107" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 108, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L108" - } - ], - "signatures": [ - { - "id": 160, - "name": "lte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than or equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 161, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 162, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 161, - "name": "ColumnName" - } - }, - { - "id": 163, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 161, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 164, - "name": "lte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 165, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 166, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 279, - "name": "match", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 376, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L376" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 377, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L377" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 378, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L378" - } - ], - "signatures": [ - { - "id": 280, - "name": "match", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where each column in " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": " keys is equal to its\nassociated value. Shorthand for multiple " - }, - { - "kind": "code", - "text": "`.eq()`" - }, - { - "kind": "text", - "text": "s." - } - ] - }, - "typeParameter": [ - { - "id": 281, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 282, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The object to filter with, with column names as keys mapped\nto their filter values" - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 281, - "name": "ColumnName" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 281, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 283, - "name": "match", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 284, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 350, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 152, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L152" - } - ], - "signatures": [ - { - "id": 351, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 535, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "PostgrestMaybeSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 448, - "name": "default.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 447, - "name": "default.maybeSingle" - } - }, - { - "id": 127, - "name": "neq", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 54, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L54" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L55" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 56, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L56" - } - ], - "signatures": [ - { - "id": 128, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is not equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 129, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 130, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 129, - "name": "ColumnName" - } - }, - { - "id": 131, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 129, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 132, - "name": "neq", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 133, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 134, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 285, - "name": "not", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 398, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L398" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 403, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L403" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 404, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L404" - } - ], - "signatures": [ - { - "id": 286, - "name": "not", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`opearator`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." - } - ] - }, - "typeParameter": [ - { - "id": 287, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 288, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 287, - "name": "ColumnName" - } - }, - { - "id": 289, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operator to be negated to filter with, following\nPostgREST syntax" - } - ] - }, - "type": { - "type": "reference", - "name": "FilterOperator" - } - }, - { - "id": 290, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with, following PostgREST syntax" - } - ] - }, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 287, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 291, - "name": "not", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 292, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 293, - "name": "operator", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 294, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 295, - "name": "or", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 422, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L422" - } - ], - "signatures": [ - { - "id": 296, - "name": "or", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`filters`" - }, - { - "kind": "text", - "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " - }, - { - "kind": "code", - "text": "`.or()`" - }, - { - "kind": "text", - "text": " filter across multiple tables." - } - ] - }, - "parameters": [ - { - "id": 297, - "name": "filters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filters to use, following PostgREST syntax" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 298, - "name": "foreignTable", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to filter on foreign tables instead of the\ncurrent table" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 299, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 300, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 422, - "character": 42, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L422" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [300] - } - ], - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 422, - "character": 40, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L422" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 316, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L65" - }, - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 69, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L69" - }, - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L73" - } - ], - "signatures": [ - { - "id": 317, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order the query result by " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table." - } - ] - }, - "typeParameter": [ - { - "id": 318, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 319, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to order by" - } - ] - }, - "type": { - "type": "reference", - "id": 318, - "name": "ColumnName" - } - }, - { - "id": 320, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 322, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the result will be in ascending order" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 67, - "character": 16, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 324, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to order a foreign table by foreign\ncolumns" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 67, - "character": 59, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 323, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear first. If " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear last." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 67, - "character": 37, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [322, 324, 323] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 67, - "character": 14, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L67" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 414, - "name": "default.order" - } - }, - { - "id": 325, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 326, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 327, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 328, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 329, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 71, - "character": 16, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 331, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 71, - "character": 59, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 330, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 71, - "character": 37, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [329, 331, 330] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 71, - "character": 14, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L71" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 422, - "name": "default.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 413, - "name": "default.order" - } - }, - { - "id": 255, - "name": "overlaps", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 315, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L315" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 319, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L319" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 320, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L320" - } - ], - "signatures": [ - { - "id": 256, - "name": "overlaps", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for array and range columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " have an element in common." - } - ] - }, - "typeParameter": [ - { - "id": 257, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 258, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The array or range column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 257, - "name": "ColumnName" - } - }, - { - "id": 259, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The array or range value to filter with" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "id": 257, - "name": "ColumnName" - }, - "objectType": { - "type": "reference", - "id": 116, - "name": "Row" - } - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 260, - "name": "overlaps", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 261, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 262, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 338, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L116" - } - ], - "signatures": [ - { - "id": 339, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " inclusively." - } - ] - }, - "parameters": [ - { - "id": 340, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 341, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 342, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 343, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 344, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of foreign tables\ninstead of the current table" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 54, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L116" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [344] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 52, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L116" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 436, - "name": "default.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 435, - "name": "default.range" - } - }, - { - "id": 247, - "name": "rangeAdjacent", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L301" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 302, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L302" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 303, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L303" - } - ], - "signatures": [ - { - "id": 248, - "name": "rangeAdjacent", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is\nmutually exclusive to " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " and there can be no element between the two\nranges." - } - ] - }, - "typeParameter": [ - { - "id": 249, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 250, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 249, - "name": "ColumnName" - } - }, - { - "id": 251, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 252, - "name": "rangeAdjacent", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 253, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 254, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 215, - "name": "rangeGt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 242, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L242" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 243, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L243" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 244, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L244" - } - ], - "signatures": [ - { - "id": 216, - "name": "rangeGt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than any element in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 217, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 218, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 217, - "name": "ColumnName" - } - }, - { - "id": 219, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 220, - "name": "rangeGt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 221, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 222, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 223, - "name": "rangeGte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 257, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L257" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 258, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L258" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 259, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L259" - } - ], - "signatures": [ - { - "id": 224, - "name": "rangeGte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is either contained in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " or greater than any element in\n" - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 225, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 226, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 225, - "name": "ColumnName" - } - }, - { - "id": 227, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 228, - "name": "rangeGte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 229, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 230, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 231, - "name": "rangeLt", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 271, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L271" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 272, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L272" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 273, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L273" - } - ], - "signatures": [ - { - "id": 232, - "name": "rangeLt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than any element in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 233, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 234, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 233, - "name": "ColumnName" - } - }, - { - "id": 235, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 236, - "name": "rangeLt", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 237, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 238, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 239, - "name": "rangeLte", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 286, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L286" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 287, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L287" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 288, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L288" - } - ], - "signatures": [ - { - "id": 240, - "name": "rangeLte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is either contained in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " or less than any element in\n" - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 241, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 242, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 241, - "name": "ColumnName" - } - }, - { - "id": 243, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 244, - "name": "rangeLte", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 245, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 246, - "name": "range", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 368, - "name": "returns", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 369, - "name": "returns", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 370, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 370, - "name": "NewResult" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 466, - "name": "default.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 465, - "name": "default.returns" - } - }, - { - "id": 366, - "name": "rollback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 235, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L235" - } - ], - "signatures": [ - { - "id": 367, - "name": "rollback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ] - }, - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 464, - "name": "default.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 463, - "name": "default.rollback" - } - }, - { - "id": 311, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L24" - } - ], - "signatures": [ - { - "id": 312, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 313, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 314, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 313, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 315, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "id": 313, - "name": "Query" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 314, - "name": "NewResult" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 409, - "name": "default.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 408, - "name": "default.select" - } - }, - { - "id": 348, - "name": "single", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L141" - } - ], - "signatures": [ - { - "id": 349, - "name": "single", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 446, - "name": "default.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 445, - "name": "default.single" - } - }, - { - "id": 263, - "name": "textSearch", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 341, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L341" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 346, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L346" - }, - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 351, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L351" - } - ], - "signatures": [ - { - "id": 264, - "name": "textSearch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for text and tsvector columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the query string in " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 265, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 266, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The text or tsvector column to filter on" - } - ] - }, - "type": { - "type": "reference", - "id": 265, - "name": "ColumnName" - } - }, - { - "id": 267, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The query text to match with" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 268, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 269, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 270, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The text search configuration to use" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 344, - "character": 16, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L344" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 271, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Change how the " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": " text is interpreted" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 344, - "character": 33, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L344" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [270, 271] - } - ], - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 344, - "character": 14, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L344" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 272, - "name": "textSearch", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 273, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 274, - "name": "query", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 275, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 276, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 277, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 349, - "character": 16, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L349" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 278, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 349, - "character": 33, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L349" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [277, 278] - } - ], - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 349, - "character": 14, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L349" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 386, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L48" - } - ], - "signatures": [ - { - "id": 387, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 388, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - }, - { - "id": 389, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 390, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 391, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 50, - "character": 9, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L50" - } - ], - "signatures": [ - { - "id": 392, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 393, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 394, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 395, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 53, - "character": 18, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L53" - } - ], - "signatures": [ - { - "id": 396, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 397, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ] - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 484, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 483, - "name": "default.then" - } - }, - { - "id": 384, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L43" - } - ], - "signatures": [ - { - "id": 385, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ] - }, - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 482, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 481, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [113] - }, - { - "title": "Properties", - "children": [383, 375, 378, 373, 371, 374, 376, 377, 372] - }, - { - "title": "Methods", - "children": [ - 345, 207, 199, 352, 119, 356, 301, 354, 135, 143, 175, 191, 183, 167, 332, 151, 159, - 279, 350, 127, 285, 295, 316, 255, 338, 247, 215, 223, 231, 239, 368, 366, 311, 348, - 263, 386, 384 - ] - } - ], - "sources": [ - { - "fileName": "src/PostgrestFilterBuilder.ts", - "line": 28, - "character": 21, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestFilterBuilder.ts#L28" - } - ], - "typeParameters": [ - { - "id": 398, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 399, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 400, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 115, - "name": "Schema" - }, - { - "type": "reference", - "id": 116, - "name": "Row" - }, - { - "type": "reference", - "id": 117, - "name": "Result" - } - ], - "name": "default" - } - ] - }, - { - "id": 49, - "name": "PostgrestQueryBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 50, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 16, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L16" - } - ], - "signatures": [ - { - "id": 51, - "name": "new PostgrestQueryBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 52, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 53, - "name": "Relation", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "GenericTable" - }, - { - "type": "reference", - "name": "GenericView" - } - ] - } - } - ], - "parameters": [ - { - "id": 54, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - }, - { - "id": 55, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 59, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 25, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L25" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 60, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 18044, - "character": 17 - } - ], - "signatures": [ - { - "id": 61, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 62, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestInfo", - "qualifiedName": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 63, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "name": "RequestInit", - "qualifiedName": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Response", - "qualifiedName": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "qualifiedName": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 57, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 23, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L23" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 58, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 24, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [59, 57, 58] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 22, - "character": 7, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L22" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 49, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "reference", - "id": 53, - "name": "Relation" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 68, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L14" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 18044, - "character": 17 - } - ], - "signatures": [ - { - "id": 70, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 71, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestInfo", - "qualifiedName": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 72, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "name": "RequestInit", - "qualifiedName": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Response", - "qualifiedName": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "qualifiedName": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 65, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 11, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L11" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 66, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 67, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L13" - } - ], - "type": { - "type": "reference", - "name": "AbortSignal", - "qualifiedName": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 64, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 10, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L10" - } - ], - "type": { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - }, - { - "id": 105, - "name": "delete", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 299, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L299" - } - ], - "signatures": [ - { - "id": 106, - "name": "delete", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ] - }, - "parameters": [ - { - "id": 107, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 109, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count deleted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 302, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L302" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [109] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 301, - "character": 5, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L301" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 82, - "name": "insert", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 120, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L120" - } - ], - "signatures": [ - { - "id": 83, - "name": "insert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 84, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 85, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 84, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 84, - "name": "Row" - } - } - ] - } - }, - { - "id": 86, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 87, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 88, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count inserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 125, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L125" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [88] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 124, - "character": 7, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L124" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 73, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L55" - } - ], - "signatures": [ - { - "id": 74, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT query on the table or view." - } - ] - }, - "typeParameter": [ - { - "id": 75, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 76, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "reference", - "id": 75, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 77, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "id": 75, - "name": "Query" - } - }, - { - "id": 78, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 79, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 81, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows in the table or view.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 65, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L65" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 80, - "name": "head", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 64, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L64" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [81, 80] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 63, - "character": 7, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L63" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "reference", - "id": 76, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 98, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 250, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L250" - } - ], - "signatures": [ - { - "id": 99, - "name": "update", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ] - }, - "typeParameter": [ - { - "id": 100, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 101, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to update with" - } - ] - }, - "type": { - "type": "reference", - "id": 100, - "name": "Row" - } - }, - { - "id": 102, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 103, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 104, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count updated rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 255, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L255" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [104] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 254, - "character": 7, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L254" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 89, - "name": "upsert", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L192" - } - ], - "signatures": [ - { - "id": 90, - "name": "upsert", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": " allows you to perform the equivalent of\n" - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": " if a row with the corresponding " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates`" - }, - { - "kind": "text", - "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 91, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 92, - "name": "values", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 91, - "name": "Row" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "id": 91, - "name": "Row" - } - } - ] - } - }, - { - "id": 93, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 94, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 97, - "name": "count", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count upserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 201, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L201" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 96, - "name": "ignoreDuplicates", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", duplicate rows are ignored. If\n" - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", duplicate rows are merged with existing rows." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 200, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L200" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 95, - "name": "onConflict", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns are equal." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 199, - "character": 6, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L199" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [97, 96, 95] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 198, - "character": 7, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L198" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 112, - "typeArguments": [ - { - "type": "reference", - "id": 52, - "name": "Schema" - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "id": 53, - "name": "Relation" - } - }, - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [50] - }, - { - "title": "Properties", - "children": [68, 65, 66, 67, 64] - }, - { - "title": "Methods", - "children": [105, 82, 73, 98, 89] - } - ], - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 6, - "character": 21, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestQueryBuilder.ts#L6" - } - ], - "typeParameters": [ - { - "id": 110, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 111, - "name": "Relation", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "GenericTable" - }, - { - "type": "reference", - "name": "GenericView" - } - ] - } - } - ] - }, - { - "id": 401, - "name": "PostgrestTransformBuilder", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 402, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L18" - } - ], - "signatures": [ - { - "id": 403, - "name": "new PostgrestTransformBuilder", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "typeParameter": [ - { - "id": 404, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 405, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 406, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "parameters": [ - { - "id": 407, - "name": "builder", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 500, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 499, - "name": "default.constructor" - } - }, - { - "id": 480, - "name": "allowEmpty", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "id": 515, - "name": "default.allowEmpty" - } - }, - { - "id": 472, - "name": "body", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 12, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "id": 507, - "name": "default.body" - } - }, - { - "id": 475, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 15, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L15" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 476, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.dom.d.ts", - "line": 18044, - "character": 17 - } - ], - "signatures": [ - { - "id": 477, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 478, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestInfo", - "qualifiedName": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 479, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "name": "RequestInit", - "qualifiedName": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Response", - "qualifiedName": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "qualifiedName": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 510, - "name": "default.fetch" - } - }, - { - "id": 470, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 10, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L10" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 505, - "name": "default.headers" - } - }, - { - "id": 468, - "name": "method", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 8, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L8" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "id": 503, - "name": "default.method" - } - }, - { - "id": 471, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 11, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 506, - "name": "default.schema" - } - }, - { - "id": 473, - "name": "shouldThrowOnError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "id": 508, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 474, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 14, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L14" - } - ], - "type": { - "type": "reference", - "name": "AbortSignal", - "qualifiedName": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 509, - "name": "default.signal" - } - }, - { - "id": 469, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 9, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L9" - } - ], - "type": { - "type": "reference", - "name": "URL", - "qualifiedName": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 504, - "name": "default.url" - } - }, - { - "id": 442, - "name": "abortSignal", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 130, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L130" - } - ], - "signatures": [ - { - "id": 443, - "name": "abortSignal", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ] - }, - "parameters": [ - { - "id": 444, - "name": "signal", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "name": "AbortSignal", - "qualifiedName": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 449, - "name": "csv", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 161, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L161" - } - ], - "signatures": [ - { - "id": 450, - "name": "csv", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - } - ] - }, - { - "id": 453, - "name": "explain", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 195, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L195" - } - ], - "signatures": [ - { - "id": 454, - "name": "explain", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query." - } - ] - }, - "parameters": [ - { - "id": 455, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 456, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 457, - "name": "analyze", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 203, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L203" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 460, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 206, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L206" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 462, - "name": "format", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 208, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L208" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 459, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 205, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L205" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 458, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 204, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L204" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 461, - "name": "wal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 207, - "character": 4, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L207" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [457, 460, 462, 459, 458, 461] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 202, - "character": 5, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L202" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - ], - "name": "PostgrestResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - }, - { - "id": 451, - "name": "geojson", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L169" - } - ], - "signatures": [ - { - "id": 452, - "name": "geojson", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - } - ] - }, - { - "id": 429, - "name": "limit", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L101" - } - ], - "signatures": [ - { - "id": 430, - "name": "limit", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "parameters": [ - { - "id": 431, - "name": "count", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 432, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 433, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 434, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of foreign tables\ninstead of the current table" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 43, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L101" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [434] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 101, - "character": 41, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L101" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 447, - "name": "maybeSingle", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 152, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L152" - } - ], - "signatures": [ - { - "id": 448, - "name": "maybeSingle", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 535, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "PostgrestMaybeSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - } - ] - }, - { - "id": 413, - "name": "order", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L65" - }, - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 69, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L69" - }, - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L73" - } - ], - "signatures": [ - { - "id": 414, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order the query result by " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table." - } - ] - }, - "typeParameter": [ - { - "id": 415, - "name": "ColumnName", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 416, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to order by" - } - ] - }, - "type": { - "type": "reference", - "id": 318, - "name": "ColumnName" - } - }, - { - "id": 417, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 418, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 419, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the result will be in ascending order" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 67, - "character": 16, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 421, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to order a foreign table by foreign\ncolumns" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 67, - "character": 59, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 420, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear first. If " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear last." - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 67, - "character": 37, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [419, 421, 420] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 67, - "character": 14, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L67" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - }, - { - "id": 422, - "name": "order", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 423, - "name": "column", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 424, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 425, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 426, - "name": "ascending", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 71, - "character": 16, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 428, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 71, - "character": 59, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 427, - "name": "nullsFirst", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 71, - "character": 37, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [426, 428, 427] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 71, - "character": 14, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L71" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 435, - "name": "range", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L116" - } - ], - "signatures": [ - { - "id": 436, - "name": "range", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " inclusively." - } - ] - }, - "parameters": [ - { - "id": 437, - "name": "from", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 438, - "name": "to", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 439, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "originalName": "__namedParameters", - "type": { - "type": "reflection", - "declaration": { - "id": 440, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 441, - "name": "foreignTable", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of foreign tables\ninstead of the current table" - } - ] - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 54, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L116" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [441] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 116, - "character": 52, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L116" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 465, - "name": "returns", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 466, - "name": "returns", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 467, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 370, - "name": "NewResult" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 463, - "name": "rollback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 235, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L235" - } - ], - "signatures": [ - { - "id": 464, - "name": "rollback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ] - }, - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 408, - "name": "select", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L24" - } - ], - "signatures": [ - { - "id": 409, - "name": "select", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "typeParameter": [ - { - "id": 410, - "name": "Query", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 411, - "name": "NewResult", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 313, - "name": "Query" - } - ], - "name": "GetResult" - } - } - ], - "parameters": [ - { - "id": 412, - "name": "columns", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "id": 313, - "name": "Query" - } - } - ], - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 314, - "name": "NewResult" - } - ], - "name": "default" - } - } - ] - }, - { - "id": 445, - "name": "single", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L141" - } - ], - "signatures": [ - { - "id": 446, - "name": "single", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ] - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "PostgrestSingleResponse" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - } - ] - }, - { - "id": 483, - "name": "then", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 48, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L48" - } - ], - "signatures": [ - { - "id": 484, - "name": "then", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 485, - "name": "TResult1", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - }, - { - "id": 486, - "name": "TResult2", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 487, - "name": "onfulfilled", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 488, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 50, - "character": 9, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L50" - } - ], - "signatures": [ - { - "id": 489, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 490, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 531, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "PostgrestResponse" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 491, - "name": "onrejected", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 492, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 53, - "character": 18, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L53" - } - ], - "signatures": [ - { - "id": 493, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 494, - "name": "reason", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 388, - "name": "TResult1" - }, - { - "type": "reference", - "id": 389, - "name": "TResult2" - } - ] - } - ], - "name": "PromiseLike", - "qualifiedName": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "id": 519, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 518, - "name": "default.then" - } - }, - { - "id": 481, - "name": "throwOnError", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/PostgrestBuilder.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestBuilder.ts#L43" - } - ], - "signatures": [ - { - "id": 482, - "name": "throwOnError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ] - }, - "type": { - "type": "reference", - "id": 401, - "typeArguments": [ - { - "type": "reference", - "id": 404, - "name": "Schema" - }, - { - "type": "reference", - "id": 405, - "name": "Row" - }, - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - }, - "inheritedFrom": { - "type": "reference", - "id": 517, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 516, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [402] - }, - { - "title": "Properties", - "children": [480, 472, 475, 470, 468, 471, 473, 474, 469] - }, - { - "title": "Methods", - "children": [442, 449, 453, 451, 429, 447, 413, 435, 465, 463, 408, 445, 483, 481] - } - ], - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 10, - "character": 21, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/PostgrestTransformBuilder.ts#L10" - } - ], - "typeParameters": [ - { - "id": 495, - "name": "Schema", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "GenericSchema" - } - }, - { - "id": 496, - "name": "Row", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "qualifiedName": "Record", - "package": "typescript" - } - }, - { - "id": 497, - "name": "Result", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 498, - "typeArguments": [ - { - "type": "reference", - "id": 406, - "name": "Result" - } - ], - "name": "default" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 112, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 537, - "name": "PostgrestError", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error format\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", - "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" - } - ] - }, - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L8" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 538, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 542, - "name": "code", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "details", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 10, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L10" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 541, - "name": "hint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 11, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 539, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L9" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [542, 540, 541, 539] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 8, - "character": 29, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L8" - } - ] - } - } - }, - { - "id": 535, - "name": "PostgrestMaybeSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 45, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L45" - } - ], - "typeParameters": [ - { - "id": 536, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "reference", - "id": 533, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "id": 536, - "name": "T" - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse" - } - }, - { - "id": 531, - "name": "PostgrestResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L35" - } - ], - "typeParameters": [ - { - "id": 532, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 532, - "name": "T" - } - ], - "name": "PostgrestResponseSuccess" - }, - { - "type": "reference", - "name": "PostgrestResponseFailure" - } - ] - } - }, - { - "id": 533, - "name": "PostgrestSingleResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 42, - "character": 12, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/types.ts#L42" - } - ], - "typeParameters": [ - { - "id": 534, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 534, - "name": "T" - } - ], - "name": "PostgrestSingleResponseSuccess" - }, - { - "type": "reference", - "name": "PostgrestResponseFailure" - } - ] - } - } - ], - "groups": [ - { - "title": "Classes", - "children": [498, 1, 112, 49, 401] - }, - { - "title": "Type Aliases", - "children": [537, 535, 531, 533] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/postgrest-js/blob/84f1518/src/index.ts#L1" - } - ] - }, - { - "id": 0, - "name": "@supabase/realtime-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 500, - "name": "REALTIME_LISTEN_TYPES", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 501, - "name": "BROADCAST", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - }, - "defaultValue": "\"broadcast\"" - }, - { - "id": 503, - "name": "POSTGRES_CHANGES", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - }, - "defaultValue": "\"postgres_changes\"" - }, - { - "id": 502, - "name": "PRESENCE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 78, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "presence" - }, - "defaultValue": "\"presence\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [501, 503, 502] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 76, - "character": 12 - } - ] - }, - { - "id": 504, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 505, - "name": "ALL", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 70, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "*" - }, - "defaultValue": "\"*\"" - }, - { - "id": 508, - "name": "DELETE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "DELETE" - }, - "defaultValue": "\"DELETE\"" - }, - { - "id": 506, - "name": "INSERT", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "INSERT" - }, - "defaultValue": "\"INSERT\"" - }, - { - "id": 507, - "name": "UPDATE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - }, - "defaultValue": "\"UPDATE\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [505, 508, 506, 507] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 69, - "character": 12 - } - ] - }, - { - "id": 509, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 511, - "name": "JOIN", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 36, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "join" - }, - "defaultValue": "\"join\"" - }, - { - "id": 512, - "name": "LEAVE", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 37, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "leave" - }, - "defaultValue": "\"leave\"" - }, - { - "id": 510, - "name": "SYNC", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "sync" - }, - "defaultValue": "\"sync\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [511, 512, 510] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 34, - "character": 12 - } - ] - }, - { - "id": 513, - "name": "REALTIME_SUBSCRIBE_STATES", - "kind": 8, - "kindString": "Enumeration", - "flags": {}, - "children": [ - { - "id": 517, - "name": "CHANNEL_ERROR", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 86, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - }, - "defaultValue": "\"CHANNEL_ERROR\"" - }, - { - "id": 516, - "name": "CLOSED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - }, - "defaultValue": "\"CLOSED\"" - }, - { - "id": 514, - "name": "SUBSCRIBED", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - }, - "defaultValue": "\"SUBSCRIBED\"" - }, - { - "id": 515, - "name": "TIMED_OUT", - "kind": 16, - "kindString": "Enumeration Member", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - }, - "defaultValue": "\"TIMED_OUT\"" - } - ], - "groups": [ - { - "title": "Enumeration Members", - "kind": 16, - "children": [517, 516, 514, 515] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 82, - "character": 12 - } - ] - }, - { - "id": 55, - "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": 66, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 111, - "character": 2 - } - ], - "signatures": [ - { - "id": 67, - "name": "new RealtimeChannel", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 68, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 69, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 294, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - }, - { - "id": 70, - "name": "socket", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 306, - "name": "default" - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ] - }, - { - "id": 71, - "name": "bindings", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 72, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 73, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 74, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 75, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 81, - "name": "callback", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 99, - "character": 6 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 77, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 98, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 98, - "character": 14 - } - ], - "indexSignature": { - "id": 79, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 80, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 82, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 100, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 76, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 97, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [81, 77, 82, 76] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 96, - "character": 19 - } - ] - } - } - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 86, - "name": "joinPush", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 106, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 85, - "name": "joinedOnce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 105, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 91, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 294, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - }, - { - "id": 89, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 109, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - }, - { - "id": 88, - "name": "pushBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 108, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 87, - "name": "rejoinTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 107, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 92, - "name": "socket", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 306, - "name": "default" - } - }, - { - "id": 84, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "CHANNEL_STATES" - }, - "defaultValue": "CHANNEL_STATES.closed" - }, - { - "id": 83, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 103, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 90, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 119, - "name": "on", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 315, - "character": 2 - } - ], - "signatures": [ - { - "id": 120, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Listen to messages." - }, - "parameters": [ - { - "id": 121, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 122, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 124, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 317, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [124] - } - ] - } - } - }, - { - "id": 125, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 126, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 127, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 128, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 129, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 131, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 320, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 130, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 319, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [131, 130] - } - ], - "indexSignature": { - "id": 132, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 133, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 134, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 135, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 136, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 137, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 138, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 326, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [138] - } - ] - } - } - }, - { - "id": 139, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 140, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 141, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 142, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 143, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 144, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 145, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 146, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 331, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [146] - } - ] - } - } - }, - { - "id": 147, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 148, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 149, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 150, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 483, - "name": "RealtimePresenceJoinPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 151, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 152, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 153, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 154, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 155, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 336, - "character": 14 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [155] - } - ] - } - } - }, - { - "id": 156, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 157, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 158, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 159, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 489, - "name": "RealtimePresenceLeavePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 160, - "name": "on", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "typeParameter": [ - { - "id": 164, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 162, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 163, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "parameters": [ - { - "id": 165, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 166, - "name": "filter", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 442, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter" - } - }, - { - "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": 449, - "typeArguments": [ - { - "type": "reference", - "id": 164, - "name": "T" - } - ], - "name": "RealtimePostgresChangesPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "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": 442, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "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": 454, - "typeArguments": [ - { - "type": "reference", - "id": 175, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "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": 442, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "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": 464, - "typeArguments": [ - { - "type": "reference", - "id": 186, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "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": 442, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "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": 473, - "typeArguments": [ - { - "type": "reference", - "id": 197, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ] - }, - { - "id": 101, - "name": "presenceState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 284, - "character": 2 - } - ], - "signatures": [ - { - "id": 102, - "name": "presenceState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "id": 495, - "name": "RealtimePresenceState" - } - } - ] - }, - { - "id": 204, - "name": "send", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 367, - "character": 2 - } - ], - "signatures": [ - { - "id": 205, - "name": "send", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 206, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 207, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 208, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 368, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [208] - } - ], - "indexSignature": { - "id": 209, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 210, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 211, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 212, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 213, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 214, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 305, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 93, - "name": "subscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 171, - "character": 2 - } - ], - "signatures": [ - { - "id": 94, - "name": "subscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Subscribe registers your client with the server" - }, - "parameters": [ - { - "id": 95, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 96, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 97, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 98, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "SUBSCRIBED" - }, - { - "type": "literal", - "value": "TIMED_OUT" - }, - { - "type": "literal", - "value": "CLOSED" - }, - { - "type": "literal", - "value": "CHANNEL_ERROR" - } - ] - } - }, - { - "id": 99, - "name": "err", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 100, - "name": "timeout", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ] - }, - { - "id": 103, - "name": "track", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 288, - "character": 8 - } - ], - "signatures": [ - { - "id": 104, - "name": "track", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 105, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 106, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 107, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 108, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 109, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 110, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 111, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 112, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 305, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 221, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 407, - "character": 2 - } - ], - "signatures": [ - { - "id": 222, - "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": 223, - "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": 113, - "name": "untrack", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 302, - "character": 8 - } - ], - "signatures": [ - { - "id": 114, - "name": "untrack", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 115, - "name": "opts", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 116, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 117, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 118, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 305, - "name": "RealtimeChannelSendResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 215, - "name": "updateJoinPayload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 394, - "character": 2 - } - ], - "signatures": [ - { - "id": 216, - "name": "updateJoinPayload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 217, - "name": "payload", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 219, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 220, - "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": [66] - }, - { - "title": "Properties", - "kind": 1024, - "children": [71, 86, 85, 91, 89, 88, 87, 92, 84, 83, 90] - }, - { - "title": "Methods", - "kind": 2048, - "children": [119, 101, 204, 93, 103, 221, 113, 215] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 94, - "character": 21 - } - ] - }, - { - "id": 306, - "name": "RealtimeClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 307, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 88, - "character": 2 - } - ], - "signatures": [ - { - "id": 308, - "name": "new RealtimeClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Socket." - }, - "parameters": [ - { - "id": 309, - "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": 310, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 418, - "name": "RealtimeClientOptions" - } - } - ], - "type": { - "type": "reference", - "id": 306, - "name": "default" - } - } - ] - }, - { - "id": 311, - "name": "accessToken", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 312, - "name": "channels", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 42, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - "defaultValue": "[]" - }, - { - "id": 333, - "name": "conn", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 57, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "qualifiedName": "WebSocket", - "package": "typescript", - "name": "WebSocket" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 331, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 55, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 330, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 54, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 313, - "name": "endPoint", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 342, - "name": "eventsPerSecondLimitMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "100" - }, - { - "id": 314, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 315, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 316, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 317, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "DEFAULT_HEADERS" - }, - { - "id": 324, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 48, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "30000" - }, - { - "id": 325, - "name": "heartbeatTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "qualifiedName": "global.NodeJS.Timer", - "package": "@types/node", - "name": "Timer" - } - ] - }, - "defaultValue": "undefined" - }, - { - "id": 343, - "name": "inThrottle", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 329, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 53, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - }, - "defaultValue": "noop" - }, - { - "id": 318, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 45, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 320, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 321, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 326, - "name": "pendingHeartbeatRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 50, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 332, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 328, - "name": "reconnectTimer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 52, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - } - }, - { - "id": 327, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 334, - "name": "sendBuffer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 58, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - "defaultValue": "[]" - }, - { - "id": 335, - "name": "serializer", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 59, - "character": 2 - } - ], - "type": { - "type": "reference", - "name": "default" - }, - "defaultValue": "..." - }, - { - "id": 336, - "name": "stateChangeCallbacks", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 60, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 337, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 339, - "name": "close", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 340, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 341, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 64, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - }, - { - "id": 338, - "name": "open", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 61, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [339, 340, 341, 338] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 322, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 46, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "DEFAULT_TIMEOUT" - }, - { - "id": 323, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 47, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "defaultValue": "w3cwebsocket" - }, - { - "id": 366, - "name": "channel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 218, - "character": 2 - } - ], - "signatures": [ - { - "id": 367, - "name": "channel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 368, - "name": "topic", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 369, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 294, - "name": "RealtimeChannelOptions" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ] - }, - { - "id": 344, - "name": "connect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 125, - "character": 2 - } - ], - "signatures": [ - { - "id": 345, - "name": "connect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Connects the socket, unless already connected." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 362, - "name": "connectionState", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 198, - "character": 2 - } - ], - "signatures": [ - { - "id": 363, - "name": "connectionState", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the current state of the socket." - }, - "type": { - "type": "reference", - "name": "CONNECTION_STATE" - } - } - ] - }, - { - "id": 346, - "name": "disconnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 147, - "character": 2 - } - ], - "signatures": [ - { - "id": 347, - "name": "disconnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Disconnects the socket." - }, - "parameters": [ - { - "id": 348, - "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": 349, - "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": 350, - "name": "getChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 162, - "character": 2 - } - ], - "signatures": [ - { - "id": 351, - "name": "getChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 55, - "name": "default" - } - } - } - ] - }, - { - "id": 364, - "name": "isConnected", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 214, - "character": 2 - } - ], - "signatures": [ - { - "id": 365, - "name": "isConnected", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns `true` is the connection is open." - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 357, - "name": "log", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 191, - "character": 2 - } - ], - "signatures": [ - { - "id": 358, - "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": 359, - "name": "kind", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "msg", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 361, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 370, - "name": "push", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 236, - "character": 2 - } - ], - "signatures": [ - { - "id": 371, - "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": 372, - "name": "data", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 435, - "name": "RealtimeMessage" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "literal", - "value": "rate limited" - } - ] - } - } - ] - }, - { - "id": 355, - "name": "removeAllChannels", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 177, - "character": 2 - } - ], - "signatures": [ - { - "id": 356, - "name": "removeAllChannels", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "id": 499, - "name": "RealtimeRemoveChannelResponse" - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 352, - "name": "removeChannel", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 166, - "character": 2 - } - ], - "signatures": [ - { - "id": 353, - "name": "removeChannel", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 354, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 499, - "name": "RealtimeRemoveChannelResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 373, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 263, - "character": 2 - } - ], - "signatures": [ - { - "id": 374, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the JWT access token used for channel subscription authorization and Realtime RLS." - }, - "parameters": [ - { - "id": 375, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A JWT string.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [307] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 311, 312, 333, 331, 330, 313, 342, 314, 324, 325, 343, 329, 318, 326, 332, 328, 327, - 334, 335, 336, 322, 323 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [366, 344, 362, 346, 350, 364, 357, 370, 355, 352, 373] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 40, - "character": 21 - } - ] - }, - { - "id": 1, - "name": "RealtimePresence", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 28, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 83, - "character": 2 - } - ], - "signatures": [ - { - "id": 29, - "name": "new RealtimePresence", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Initializes the Presence." - }, - "parameters": [ - { - "id": 30, - "name": "channel", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The RealtimeChannel" - }, - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 31, - "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": 35, - "name": "caller", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 66, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 36, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 37, - "name": "onJoin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 67, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnJoinCallback", - "package": "@types/phoenix", - "name": "PresenceOnJoinCallback" - } - }, - { - "id": 38, - "name": "onLeave", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 68, - "character": 4 - } - ], - "type": { - "type": "reference", - "qualifiedName": "PresenceOnLeaveCallback", - "package": "@types/phoenix", - "name": "PresenceOnLeaveCallback" - } - }, - { - "id": 39, - "name": "onSync", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 69, - "character": 4 - } - ], - "signatures": [ - { - "id": 40, - "name": "onSync", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [37, 38] - }, - { - "title": "Methods", - "kind": 2048, - "children": [39] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 41, - "name": "channel", - "kind": 1024, - "kindString": "Property", - "flags": { - "isPublic": true - }, - "type": { - "type": "reference", - "id": 55, - "name": "default" - } - }, - { - "id": 34, - "name": "joinRef", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 65, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 33, - "name": "pendingDiffs", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "RawPresenceDiff" - } - }, - "defaultValue": "[]" - }, - { - "id": 32, - "name": "state", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 63, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 495, - "name": "RealtimePresenceState" - }, - "defaultValue": "{}" - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [28] - }, - { - "title": "Properties", - "kind": 1024, - "children": [35, 41, 34, 33, 32] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 62, - "character": 21 - } - ] - }, - { - "id": 294, - "name": "RealtimeChannelOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 295, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 296, - "name": "config", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 297, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 298, - "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": "RealtimeChannel.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 299, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 301, - "name": "ack", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 19, - "character": 34 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 300, - "name": "self", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 19, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [301, 300] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 19, - "character": 16 - } - ] - } - } - }, - { - "id": 302, - "name": "presence", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "key option is used to track presence payload across clients" - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 303, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 304, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 23, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [304] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 23, - "character": 15 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [298, 302] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 14, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [296] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 13, - "character": 37 - } - ] - } - } - }, - { - "id": 305, - "name": "RealtimeChannelSendResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 67, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "rate limited" - } - ] - } - }, - { - "id": 418, - "name": "RealtimeClientOptions", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 419, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 425, - "name": "decode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 424, - "name": "encode", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 427, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 428, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 24, - "character": 12 - } - ], - "indexSignature": { - "id": 429, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 430, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 422, - "name": "heartbeatIntervalMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 423, - "name": "logger", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 20, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 431, - "name": "params", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 25, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 432, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 25, - "character": 11 - } - ], - "indexSignature": { - "id": 433, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 434, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 426, - "name": "reconnectAfterMs", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Function", - "package": "typescript", - "name": "Function" - } - }, - { - "id": 421, - "name": "timeout", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 420, - "name": "transport", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "WebSocket", - "package": "typescript", - "name": "WebSocket" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [425, 424, 427, 422, 423, 431, 426, 421, 420] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 16, - "character": 36 - } - ] - } - } - }, - { - "id": 435, - "name": "RealtimeMessage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 28, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 436, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 438, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 441, - "name": "join_ref", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 439, - "name": "payload", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 440, - "name": "ref", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 32, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 437, - "name": "topic", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [438, 441, 439, 440, 437] - } - ], - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 28, - "character": 30 - } - ] - } - } - }, - { - "id": 442, - "name": "RealtimePostgresChangesFilter", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 60, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 448, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 443, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 444, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 448, - "name": "T" - } - }, - { - "id": 447, - "name": "filter", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 64, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 445, - "name": "schema", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 446, - "name": "table", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 63, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [444, 447, 445, 446] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 60, - "character": 62 - } - ] - } - } - }, - { - "id": 449, - "name": "RealtimePostgresChangesPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 55, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 453, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 450, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 55, - "character": 53 - } - ], - "indexSignature": { - "id": 451, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 452, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 454, - "typeArguments": [ - { - "type": "reference", - "id": 453, - "name": "T" - } - ], - "name": "RealtimePostgresInsertPayload" - }, - { - "type": "reference", - "id": 464, - "typeArguments": [ - { - "type": "reference", - "id": 453, - "name": "T" - } - ], - "name": "RealtimePostgresUpdatePayload" - }, - { - "type": "reference", - "id": 473, - "typeArguments": [ - { - "type": "reference", - "id": 453, - "name": "T" - } - ], - "name": "RealtimePostgresDeletePayload" - } - ] - } - }, - { - "id": 473, - "name": "RealtimePostgresDeletePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 48, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 482, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 479, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 48, - "character": 52 - } - ], - "indexSignature": { - "id": 480, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 481, - "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": 474, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 475, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 50, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 508, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "" - ] - ] - } - }, - { - "id": 476, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 51, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 477, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 51, - "character": 9 - } - ] - } - } - }, - { - "id": 478, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 482, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [475, 476, 478] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 49, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 454, - "name": "RealtimePostgresInsertPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 34, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 463, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 460, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 34, - "character": 52 - } - ], - "indexSignature": { - "id": 461, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 462, - "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": 455, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 456, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 36, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 506, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "" - ] - ] - } - }, - { - "id": 457, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 37, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 463, - "name": "T" - } - }, - { - "id": 458, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 38, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 459, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 38, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [456, 457, 458] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 35, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 464, - "name": "RealtimePostgresUpdatePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 41, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 472, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 469, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 41, - "character": 52 - } - ], - "indexSignature": { - "id": 470, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 471, - "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": 465, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 466, - "name": "eventType", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 507, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "" - ] - ] - } - }, - { - "id": 467, - "name": "new", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "reference", - "id": 472, - "name": "T" - } - }, - { - "id": 468, - "name": "old", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 472, - "name": "T" - } - ], - "qualifiedName": "Partial", - "package": "typescript", - "name": "Partial" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [466, 467, 468] - } - ], - "sources": [ - { - "fileName": "RealtimeChannel.ts", - "line": 42, - "character": 39 - } - ] - } - } - ] - } - }, - { - "id": 483, - "name": "RealtimePresenceJoinPayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 20, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 484, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 487, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - }, - { - "id": 485, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 21, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 511, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "" - ] - ] - } - }, - { - "id": 486, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 22, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 488, - "name": "newPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [487, 485, 486, 488] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 20, - "character": 42 - } - ] - } - } - }, - { - "id": 489, - "name": "RealtimePresenceLeavePayload", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 27, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 490, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 493, - "name": "currentPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 30, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - }, - { - "id": 491, - "name": "event", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 28, - "character": 2 - } - ], - "type": { - "type": "template-literal", - "head": "", - "tail": [ - [ - { - "type": "reference", - "id": 512, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "" - ] - ] - } - }, - { - "id": 492, - "name": "key", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 494, - "name": "leftPresences", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [493, 491, 492, 494] - } - ], - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 27, - "character": 43 - } - ] - } - } - }, - { - "id": 495, - "name": "RealtimePresenceState", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 18, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 496, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "RealtimePresence.ts", - "line": 18, - "character": 36 - } - ], - "indexSignature": { - "id": 497, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 498, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "name": "Presence" - } - } - } - } - } - }, - { - "id": 499, - "name": "RealtimeRemoveChannelResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "RealtimeClient.ts", - "line": 36, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - } - ] - } - } - ], - "groups": [ - { - "title": "Enumerations", - "kind": 8, - "children": [500, 504, 509, 513] - }, - { - "title": "Classes", - "kind": 128, - "children": [55, 306, 1] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [294, 305, 418, 435, 442, 449, 473, 454, 464, 483, 489, 495, 499] - } - ], - "sources": [ - { - "fileName": "index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 0, - "name": "@supabase/storage-js", - "kind": 1, - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1, - "name": "index", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 390, - "name": "StorageApiError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 391, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 17, - "character": 2 - } - ], - "signatures": [ - { - "id": 392, - "name": "new StorageApiError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 393, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 394, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 390, - "name": "StorageApiError" - }, - "overwrites": { - "type": "reference", - "id": 387, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 386, - "name": "StorageError.constructor" - } - }, - { - "id": 395, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 396, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 23, - "character": 2 - } - ], - "signatures": [ - { - "id": 397, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 398, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 400, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 26, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 399, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 401, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 27, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [400, 399, 401] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [391] - }, - { - "title": "Properties", - "kind": 1024, - "children": [395] - }, - { - "title": "Methods", - "kind": 2048, - "children": [396] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 385, - "name": "StorageError" - } - ] - }, - { - "id": 258, - "name": "StorageClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 259, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 6, - "character": 2 - } - ], - "signatures": [ - { - "id": 260, - "name": "new StorageClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 261, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 262, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 263, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 264, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 265, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 266, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 267, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 268, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 269, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 270, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 258, - "name": "StorageClient" - }, - "overwrites": { - "type": "reference", - "id": 5, - "name": "default.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 4, - "name": "default.constructor" - } - }, - { - "id": 301, - "name": "createBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 79, - "character": 8 - } - ], - "signatures": [ - { - "id": 302, - "name": "createBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id\n" - }, - "parameters": [ - { - "id": 303, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are creating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 304, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 305, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 306, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 81, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [306] - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 307, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 308, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 84, - "character": 8 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 349, - "name": "Bucket" - }, - { - "type": "literal", - "value": "name" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 309, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 85, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [308, 309] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 310, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 311, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 88, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 312, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 89, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [311, 312] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 44, - "name": "default.createBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 43, - "name": "default.createBucket" - } - }, - { - "id": 338, - "name": "deleteBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 185, - "character": 8 - } - ], - "signatures": [ - { - "id": 339, - "name": "deleteBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." - }, - "parameters": [ - { - "id": 340, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 341, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 342, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 343, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 344, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [344] - } - ] - } - } - }, - { - "id": 345, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 190, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [342, 345] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 346, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 347, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 193, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 348, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 194, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [347, 348] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 81, - "name": "default.deleteBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 80, - "name": "default.deleteBucket" - } - }, - { - "id": 327, - "name": "emptyBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 150, - "character": 8 - } - ], - "signatures": [ - { - "id": 328, - "name": "emptyBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes all objects inside a single bucket." - }, - "parameters": [ - { - "id": 329, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 330, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 331, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 154, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 332, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 333, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 154, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [333] - } - ] - } - } - }, - { - "id": 334, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 155, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [331, 334] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 335, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 336, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 158, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 337, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 159, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [336, 337] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 70, - "name": "default.emptyBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 69, - "name": "default.emptyBucket" - } - }, - { - "id": 271, - "name": "from", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 15, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "from", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Perform file operation in a bucket." - }, - "parameters": [ - { - "id": 273, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The bucket id to operate on.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 92, - "name": "default" - } - } - ] - }, - { - "id": 292, - "name": "getBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 48, - "character": 8 - } - ], - "signatures": [ - { - "id": 293, - "name": "getBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." - }, - "parameters": [ - { - "id": 294, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 295, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 296, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - }, - { - "id": 297, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [296, 297] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 298, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 299, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 56, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 300, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 57, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [299, 300] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 35, - "name": "default.getBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 34, - "name": "default.getBucket" - } - }, - { - "id": 284, - "name": "listBuckets", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 21, - "character": 8 - } - ], - "signatures": [ - { - "id": 285, - "name": "listBuckets", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 286, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 287, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 23, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - } - }, - { - "id": 288, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 24, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [287, 288] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 289, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 290, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 291, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [290, 291] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 27, - "name": "default.listBuckets" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 26, - "name": "default.listBuckets" - } - }, - { - "id": 313, - "name": "updateBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 115, - "character": 8 - } - ], - "signatures": [ - { - "id": 314, - "name": "updateBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates a Storage bucket" - }, - "parameters": [ - { - "id": 315, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are updating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 316, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 317, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 318, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [318] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 320, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 322, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [322] - } - ] - } - } - }, - { - "id": 323, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [320, 323] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 324, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 325, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 124, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 326, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 125, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [325, 326] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - }, - "inheritedFrom": { - "type": "reference", - "id": 56, - "name": "default.updateBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 55, - "name": "default.updateBucket" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [259] - }, - { - "title": "Methods", - "kind": 2048, - "children": [301, 338, 327, 271, 292, 284, 313] - } - ], - "sources": [ - { - "fileName": "src/StorageClient.ts", - "line": 5, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 3, - "name": "default" - } - ] - }, - { - "id": 385, - "name": "StorageError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 386, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 2 - } - ], - "signatures": [ - { - "id": 387, - "name": "new StorageError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 388, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [386] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 1, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 390, - "name": "StorageApiError" - }, - { - "type": "reference", - "id": 403, - "name": "StorageUnknownError" - } - ] - }, - { - "id": 403, - "name": "StorageUnknownError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 404, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 35, - "character": 2 - } - ], - "signatures": [ - { - "id": 405, - "name": "new StorageUnknownError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 406, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "originalError", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 403, - "name": "StorageUnknownError" - }, - "overwrites": { - "type": "reference", - "id": 387, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 386, - "name": "StorageError.constructor" - } - }, - { - "id": 408, - "name": "originalError", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [404] - }, - { - "title": "Properties", - "kind": 1024, - "children": [408] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 32, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 385, - "name": "StorageError" - } - ] - }, - { - "id": 349, - "name": "Bucket", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 353, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 5, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 350, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 2, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 351, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 3, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 352, - "name": "owner", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 4, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 355, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 7, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 354, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 6, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [353, 350, 351, 352, 355, 354] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 1, - "character": 17 - } - ] - }, - { - "id": 378, - "name": "FetchParameters", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 379, - "name": "signal", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Pass in an AbortController's signal to cancel the request." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 68, - "character": 2 - } - ], - "type": { - "type": "reference", - "qualifiedName": "AbortSignal", - "package": "typescript", - "name": "AbortSignal" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [379] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 17 - } - ] - }, - { - "id": 356, - "name": "FileObject", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 358, - "name": "bucket_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 12, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 365, - "name": "buckets", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 19, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - }, - { - "id": 362, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 16, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 14, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 363, - "name": "last_accessed_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 17, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 364, - "name": "metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 357, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 11, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 359, - "name": "owner", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 13, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 361, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [358, 365, 362, 360, 363, 364, 357, 359, 361] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 10, - "character": 17 - } - ] - }, - { - "id": 369, - "name": "FileOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 370, - "name": "cacheControl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=` header. Defaults to 3600 seconds." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 31, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 371, - "name": "contentType", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 35, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 372, - "name": "upsert", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [370, 371, 372] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 27, - "character": 17 - } - ] - }, - { - "id": 380, - "name": "Metadata", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 381, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [381] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 17 - } - ] - }, - { - "id": 373, - "name": "SearchOptions", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 374, - "name": "limit", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": " The number of files you want to be returned." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 46, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 375, - "name": "offset", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The starting position." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 51, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 377, - "name": "search", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The search string to filter files by." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 376, - "name": "sortBy", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The column to sort by. Can be any column inside a FileObject." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 366, - "name": "SortBy" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [374, 375, 377, 376] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 42, - "character": 17 - } - ] - }, - { - "id": 366, - "name": "SortBy", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 367, - "name": "column", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 23, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 368, - "name": "order", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 24, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [367, 368] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 22, - "character": 17 - } - ] - }, - { - "id": 382, - "name": "isStorageError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 10, - "character": 16 - } - ], - "signatures": [ - { - "id": 383, - "name": "isStorageError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 384, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [390, 258, 385, 403] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [349, 378, 356, 369, 380, 373, 366] - }, - { - "title": "Functions", - "kind": 64, - "children": [382] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 2, - "name": "packages/StorageBucketApi", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 3, - "name": "default", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 4, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 12, - "character": 2 - } - ], - "signatures": [ - { - "id": 5, - "name": "new default", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 6, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 7, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 8, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 9, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 10, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 11, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 13, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 14, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 15, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 3, - "name": "default" - } - } - ] - }, - { - "id": 43, - "name": "createBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 79, - "character": 8 - } - ], - "signatures": [ - { - "id": 44, - "name": "createBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new Storage bucket", - "returns": "newly created bucket id\n" - }, - "parameters": [ - { - "id": 45, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are creating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 47, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 48, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 81, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [48] - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 49, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 50, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 84, - "character": 8 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 349, - "name": "Bucket" - }, - { - "type": "literal", - "value": "name" - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - }, - { - "id": 51, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 85, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [50, 51] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 52, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 53, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 88, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 54, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 89, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [53, 54] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 80, - "name": "deleteBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 185, - "character": 8 - } - ], - "signatures": [ - { - "id": 81, - "name": "deleteBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket." - }, - "parameters": [ - { - "id": 82, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to delete.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 84, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 86, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 189, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [86] - } - ] - } - } - }, - { - "id": 87, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 190, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [84, 87] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 88, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 89, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 193, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 90, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 194, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [89, 90] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 69, - "name": "emptyBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 150, - "character": 8 - } - ], - "signatures": [ - { - "id": 70, - "name": "emptyBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes all objects inside a single bucket." - }, - "parameters": [ - { - "id": 71, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to empty.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 72, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 73, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 154, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 74, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 75, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 154, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [75] - } - ] - } - } - }, - { - "id": 76, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 155, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [73, 76] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 77, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 78, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 158, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 79, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 159, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [78, 79] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 34, - "name": "getBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 48, - "character": 8 - } - ], - "signatures": [ - { - "id": 35, - "name": "getBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of an existing Storage bucket." - }, - "parameters": [ - { - "id": 36, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The unique identifier of the bucket you would like to retrieve.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 38, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - }, - { - "id": 39, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [38, 39] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 40, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 41, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 56, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 42, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 57, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [41, 42] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 26, - "name": "listBuckets", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 21, - "character": 8 - } - ], - "signatures": [ - { - "id": 27, - "name": "listBuckets", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the details of all Storage buckets within an existing project." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 28, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 29, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 23, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 349, - "name": "Bucket" - } - } - }, - { - "id": 30, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 24, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [29, 30] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 31, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 32, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 33, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [32, 33] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 55, - "name": "updateBucket", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 115, - "character": 8 - } - ], - "signatures": [ - { - "id": 56, - "name": "updateBucket", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates a Storage bucket" - }, - "parameters": [ - { - "id": 57, - "name": "id", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A unique identifier for the bucket you are updating." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 58, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 59, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 60, - "name": "public", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 117, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [60] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 61, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 62, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 63, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 64, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 120, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [64] - } - ] - } - } - }, - { - "id": 65, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 121, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [62, 65] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 66, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 67, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 124, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 68, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 125, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [67, 68] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [4] - }, - { - "title": "Methods", - "kind": 2048, - "children": [43, 80, 69, 34, 26, 55] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 7, - "character": 21 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 258, - "name": "StorageClient" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [3] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageBucketApi.ts", - "line": 1, - "character": 0 - } - ] - }, - { - "id": 91, - "name": "packages/StorageFileApi", - "kind": 2, - "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 92, - "name": "default", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 93, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 27, - "character": 2 - } - ], - "signatures": [ - { - "id": 94, - "name": "new default", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 95, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 96, - "name": "headers", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 97, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 98, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 99, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - }, - "defaultValue": "{}" - }, - { - "id": 100, - "name": "bucketId", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 101, - "name": "fetch", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 102, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 103, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 104, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - } - }, - { - "id": 105, - "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" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 92, - "name": "default" - } - } - ] - }, - { - "id": 169, - "name": "copy", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 226, - "character": 8 - } - ], - "signatures": [ - { - "id": 170, - "name": "copy", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Copies an existing file to a new path in the same bucket." - }, - "parameters": [ - { - "id": 171, - "name": "fromPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 172, - "name": "toPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-copy.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 173, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 174, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 175, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 176, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 231, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [176] - } - ] - } - } - }, - { - "id": 177, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 232, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [174, 177] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 178, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 179, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 235, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 180, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 236, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [179, 180] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 181, - "name": "createSignedUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 263, - "character": 8 - } - ], - "signatures": [ - { - "id": 182, - "name": "createSignedUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." - }, - "parameters": [ - { - "id": 183, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 184, - "name": "expiresIn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 185, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 187, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 266, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [187] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 188, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 189, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 269, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 191, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 269, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [191] - } - ] - } - } - }, - { - "id": 192, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 270, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "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/packages/StorageFileApi.ts", - "line": 273, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 195, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 274, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [194, 195] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 196, - "name": "createSignedUrls", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 307, - "character": 8 - } - ], - "signatures": [ - { - "id": 197, - "name": "createSignedUrls", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." - }, - "parameters": [ - { - "id": 198, - "name": "paths", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`." - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 199, - "name": "expiresIn", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 200, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 202, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 310, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [202] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 203, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 204, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 313, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 206, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 313, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 207, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 313, - "character": 38 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 208, - "name": "signedUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 313, - "character": 59 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [206, 207, 208] - } - ] - } - } - } - }, - { - "id": 209, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 314, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [204, 209] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 210, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 211, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 317, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 212, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 318, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [211, 212] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 213, - "name": "download", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 355, - "character": 8 - } - ], - "signatures": [ - { - "id": 214, - "name": "download", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Downloads a file." - }, - "parameters": [ - { - "id": 215, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 216, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 217, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 359, - "character": 8 - } - ], - "type": { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - } - }, - { - "id": 218, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 360, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [217, 218] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 219, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 220, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 363, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 221, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 364, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [220, 221] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 222, - "name": "getPublicUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 391, - "character": 2 - } - ], - "signatures": [ - { - "id": 223, - "name": "getPublicUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Retrieves the URL for an asset in a public bucket.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." - }, - "parameters": [ - { - "id": 224, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 226, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 227, - "name": "download", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.\n" - }, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 393, - "character": 16 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [227] - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 228, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 229, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 394, - "character": 7 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 230, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 231, - "name": "publicUrl", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 394, - "character": 15 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [231] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [229] - } - ] - } - } - } - ] - }, - { - "id": 241, - "name": "list", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 506, - "character": 8 - } - ], - "signatures": [ - { - "id": 242, - "name": "list", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Lists all the files within a bucket." - }, - "parameters": [ - { - "id": 243, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The folder path.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 244, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 373, - "name": "SearchOptions" - } - }, - { - "id": 245, - "name": "parameters", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 378, - "name": "FetchParameters" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 246, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 247, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 512, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 356, - "name": "FileObject" - } - } - }, - { - "id": 248, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 513, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [247, 248] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 249, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 250, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 516, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 251, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 517, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [250, 251] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 157, - "name": "move", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 190, - "character": 8 - } - ], - "signatures": [ - { - "id": 158, - "name": "move", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Moves an existing file to a new path in the same bucket." - }, - "parameters": [ - { - "id": 159, - "name": "fromPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The original file path, including the current file name. For example `folder/image.png`." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 160, - "name": "toPath", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The new file path, including the new file name. For example `folder/image-new.png`.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 162, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 195, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 163, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 164, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 195, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [164] - } - ] - } - } - }, - { - "id": 165, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 196, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [162, 165] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 166, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 167, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 199, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 168, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 200, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [167, 168] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 232, - "name": "remove", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 410, - "character": 8 - } - ], - "signatures": [ - { - "id": 233, - "name": "remove", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Deletes files within the same bucket" - }, - "parameters": [ - { - "id": 234, - "name": "paths", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n" - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 235, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 236, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 414, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 356, - "name": "FileObject" - } - } - }, - { - "id": 237, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 415, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [236, 237] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 238, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 239, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 418, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 240, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 419, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [239, 240] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 144, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 157, - "character": 8 - } - ], - "signatures": [ - { - "id": 145, - "name": "update", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Replaces an existing file at the specified path with a new one." - }, - "parameters": [ - { - "id": 146, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 147, - "name": "fileBody", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" - }, - { - "type": "reference", - "qualifiedName": "ArrayBufferView", - "package": "typescript", - "name": "ArrayBufferView" - }, - { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - }, - { - "type": "reference", - "qualifiedName": "Buffer", - "package": "@types/node", - "name": "Buffer" - }, - { - "type": "reference", - "qualifiedName": "File", - "package": "typescript", - "name": "File" - }, - { - "type": "reference", - "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" - }, - { - "type": "reference", - "qualifiedName": "NodeJS.ReadableStream", - "package": "@types/node", - "name": "ReadableStream" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - ], - "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" - }, - { - "type": "reference", - "qualifiedName": "URLSearchParams", - "package": "typescript", - "name": "URLSearchParams" - } - ] - } - }, - { - "id": 148, - "name": "fileOptions", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 369, - "name": "FileOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 149, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 150, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 173, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 151, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 152, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 173, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [152] - } - ] - } - } - }, - { - "id": 153, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 174, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [150, 153] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 154, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 155, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 177, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 156, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 178, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [155, 156] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 131, - "name": "upload", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 124, - "character": 8 - } - ], - "signatures": [ - { - "id": 132, - "name": "upload", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Uploads a file to an existing bucket." - }, - "parameters": [ - { - "id": 133, - "name": "path", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 134, - "name": "fileBody", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The body of the file to be stored in the bucket.\n" - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "qualifiedName": "ArrayBuffer", - "package": "typescript", - "name": "ArrayBuffer" - }, - { - "type": "reference", - "qualifiedName": "ArrayBufferView", - "package": "typescript", - "name": "ArrayBufferView" - }, - { - "type": "reference", - "qualifiedName": "Blob", - "package": "typescript", - "name": "Blob" - }, - { - "type": "reference", - "qualifiedName": "Buffer", - "package": "@types/node", - "name": "Buffer" - }, - { - "type": "reference", - "qualifiedName": "File", - "package": "typescript", - "name": "File" - }, - { - "type": "reference", - "qualifiedName": "FormData", - "package": "typescript", - "name": "FormData" - }, - { - "type": "reference", - "qualifiedName": "NodeJS.ReadableStream", - "package": "@types/node", - "name": "ReadableStream" - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Uint8Array", - "package": "typescript", - "name": "Uint8Array" - } - ], - "qualifiedName": "ReadableStream", - "package": "typescript", - "name": "ReadableStream" - }, - { - "type": "reference", - "qualifiedName": "URLSearchParams", - "package": "typescript", - "name": "URLSearchParams" - } - ] - } - }, - { - "id": 135, - "name": "fileOptions", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "id": 369, - "name": "FileOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 137, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 140, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 139, - "name": "path", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 140, - "character": 16 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [139] - } - ] - } - } - }, - { - "id": 140, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 141, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [137, 140] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 142, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 144, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 143, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 145, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 385, - "name": "StorageError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [142, 143] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [93] - }, - { - "title": "Methods", - "kind": 2048, - "children": [169, 181, 196, 213, 222, 241, 157, 232, 144, 131] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 21, - "character": 21 - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [92] - } - ], - "sources": [ - { - "fileName": "src/packages/StorageFileApi.ts", - "line": 1, - "character": 0 - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "kind": 2, - "children": [1, 2, 91] - } - ] - }, - { - "id": 0, - "name": "@supabase/functions-js", - "kind": 1, - "kindString": "Project", - "flags": {}, - "originalName": "", - "children": [ - { - "id": 1, - "name": "FunctionsClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 16, - "character": 2 - } - ], - "signatures": [ - { - "id": 3, - "name": "new FunctionsClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 4, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 6, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 8, - "name": "customFetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 23, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 10, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 11, - "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": 12, - "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": 7, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 22, - "character": 6 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [8, 7] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "FunctionsClient" - } - } - ] - }, - { - "id": 15, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 17, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 18, - "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": 19, - "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": 14, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 13, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" - } - }, - { - "id": 13, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 12, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 23, - "name": "invoke", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 43, - "character": 8 - } - ], - "signatures": [ - { - "id": 24, - "name": "invoke", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Invokes a function" - }, - "typeParameter": [ - { - "id": 25, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - } - ], - "parameters": [ - { - "id": 26, - "name": "functionName", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "the name of the function to invoke\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 27, - "name": "invokeOptions", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "name": "FunctionInvokeOptions" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 50, - "typeArguments": [ - { - "type": "reference", - "id": 25, - "name": "T" - } - ], - "name": "FunctionsResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 20, - "name": "setAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 35, - "character": 2 - } - ], - "signatures": [ - { - "id": 21, - "name": "setAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates the authorization header" - }, - "parameters": [ - { - "id": 22, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "the new jwt token sent in the authorisation header\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [2] - }, - { - "title": "Properties", - "kind": 1024, - "children": [15, 14, 13] - }, - { - "title": "Methods", - "kind": 2048, - "children": [23, 20] - } - ], - "sources": [ - { - "fileName": "src/FunctionsClient.ts", - "line": 11, - "character": 13 - } - ] - }, - { - "id": 28, - "name": "FunctionsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 29, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 19, - "character": 2 - } - ], - "signatures": [ - { - "id": 30, - "name": "new FunctionsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 31, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'FunctionsError'" - }, - { - "id": 33, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "id": 28, - "name": "FunctionsError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - }, - { - "id": 34, - "name": "context", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [29] - }, - { - "title": "Properties", - "kind": 1024, - "children": [34] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 17, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 35, - "name": "FunctionsFetchError" - }, - { - "type": "reference", - "id": 40, - "name": "FunctionsHttpError" - }, - { - "type": "reference", - "id": 45, - "name": "FunctionsRelayError" - } - ] - }, - { - "id": 35, - "name": "FunctionsFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 36, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 27, - "character": 2 - } - ], - "signatures": [ - { - "id": 37, - "name": "new FunctionsFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 38, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "id": 35, - "name": "FunctionsFetchError" - }, - "overwrites": { - "type": "reference", - "id": 30, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 29, - "name": "FunctionsError.constructor" - } - }, - { - "id": 39, - "name": "context", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "id": 34, - "name": "FunctionsError.context" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [36] - }, - { - "title": "Properties", - "kind": 1024, - "children": [39] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 26, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 28, - "name": "FunctionsError" - } - ] - }, - { - "id": 40, - "name": "FunctionsHttpError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 41, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 39, - "character": 2 - } - ], - "signatures": [ - { - "id": 42, - "name": "new FunctionsHttpError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 43, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "id": 40, - "name": "FunctionsHttpError" - }, - "overwrites": { - "type": "reference", - "id": 30, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 29, - "name": "FunctionsError.constructor" - } - }, - { - "id": 44, - "name": "context", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "id": 34, - "name": "FunctionsError.context" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [41] - }, - { - "title": "Properties", - "kind": 1024, - "children": [44] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 38, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 28, - "name": "FunctionsError" - } - ] - }, - { - "id": 45, - "name": "FunctionsRelayError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 46, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 33, - "character": 2 - } - ], - "signatures": [ - { - "id": 47, - "name": "new FunctionsRelayError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 48, - "name": "context", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "id": 45, - "name": "FunctionsRelayError" - }, - "overwrites": { - "type": "reference", - "id": 30, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 29, - "name": "FunctionsError.constructor" - } - }, - { - "id": 49, - "name": "context", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 18, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "id": 34, - "name": "FunctionsError.context" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [46] - }, - { - "title": "Properties", - "kind": 1024, - "children": [49] - } - ], - "sources": [ - { - "fileName": "src/types.ts", - "line": 32, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 28, - "name": "FunctionsError" - } - ] - }, - { - "id": 50, - "name": "FunctionsResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/types.ts", - "line": 15, - "character": 12 - } - ], - "typeParameter": [ - { - "id": 51, - "name": "T", - "kind": 131072, - "kindString": "Type parameter", - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 51, - "name": "T" - } - ], - "name": "FunctionsResponseSuccess" - }, - { - "type": "reference", - "name": "FunctionsResponseFailure" - } - ] - } - } - ], - "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [1, 28, 35, 40, 45] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [50] - } - ], - "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } - ] - } - ] -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/functions.json b/apps/docs/spec/enrichments/tsdoc_v2/functions.json deleted file mode 100644 index 284bd1f55e5..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/functions.json +++ /dev/null @@ -1,3825 +0,0 @@ -{ - "id": 0, - "name": "@supabase/functions-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 93, - "name": "FunctionRegion", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 94, - "name": "Any", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L96" - } - ], - "type": { - "type": "literal", - "value": "any" - } - }, - { - "id": 95, - "name": "ApNortheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 97, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L97" - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-1" - } - }, - { - "id": 96, - "name": "ApNortheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 98, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L98" - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-2" - } - }, - { - "id": 97, - "name": "ApSouth1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 99, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L99" - } - ], - "type": { - "type": "literal", - "value": "ap-south-1" - } - }, - { - "id": 98, - "name": "ApSoutheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 100, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L100" - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-1" - } - }, - { - "id": 99, - "name": "ApSoutheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 101, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L101" - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-2" - } - }, - { - "id": 100, - "name": "CaCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 102, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L102" - } - ], - "type": { - "type": "literal", - "value": "ca-central-1" - } - }, - { - "id": 101, - "name": "EuCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 103, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L103" - } - ], - "type": { - "type": "literal", - "value": "eu-central-1" - } - }, - { - "id": 102, - "name": "EuWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 104, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L104" - } - ], - "type": { - "type": "literal", - "value": "eu-west-1" - } - }, - { - "id": 103, - "name": "EuWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 105, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L105" - } - ], - "type": { - "type": "literal", - "value": "eu-west-2" - } - }, - { - "id": 104, - "name": "EuWest3", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 106, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L106" - } - ], - "type": { - "type": "literal", - "value": "eu-west-3" - } - }, - { - "id": 105, - "name": "SaEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L107" - } - ], - "type": { - "type": "literal", - "value": "sa-east-1" - } - }, - { - "id": 106, - "name": "UsEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 108, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L108" - } - ], - "type": { - "type": "literal", - "value": "us-east-1" - } - }, - { - "id": 107, - "name": "UsWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L109" - } - ], - "type": { - "type": "literal", - "value": "us-west-1" - } - }, - { - "id": 108, - "name": "UsWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 110, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L110" - } - ], - "type": { - "type": "literal", - "value": "us-west-2" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 95, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L95" - } - ] - }, - { - "id": 1, - "name": "FunctionsClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for invoking Supabase Edge Functions." - } - ] - }, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44" - } - ], - "signatures": [ - { - "id": 3, - "name": "FunctionsClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Functions client bound to an Edge Functions URL." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.functions.invoke('hello-world')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsClient, FunctionRegion } from '@supabase/functions-js'\n\nconst functions = new FunctionsClient('https://xyzcompany.supabase.co/functions/v1', {\n headers: { apikey: 'your-publishable-key' },\n region: FunctionRegion.UsEast1,\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44" - } - ], - "parameters": [ - { - "id": 4, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 6, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 8, - "name": "customFetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 52, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L52" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 10, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 11, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 12, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 13, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 14, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 15, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 7, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 51, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L51" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 16, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 53, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L53" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - }, - "defaultValue": "FunctionRegion.Any" - } - ], - "groups": [ - { - "title": "Properties", - "children": [8, 7, 16] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 50, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L50" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "FunctionsClient", - "package": "@supabase/functions-js" - } - } - ] - }, - { - "id": 20, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 19, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L19" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 22, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 23, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 24, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 25, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 26, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 27, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 18, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 17, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L17" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 19, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 18, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L18" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 17, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 31, - "name": "invoke", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 202, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202" - } - ], - "signatures": [ - { - "id": 32, - "name": "invoke", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Invokes a function" - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Ada' },\n})\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires an Authorization header.\n- Invoke params generally match the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) spec.\n- When you pass in a body to your function, we automatically attach the Content-Type header for " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`String`" - }, - { - "kind": "text", - "text": ". If it doesn't match any of these types we assume the payload is " - }, - { - "kind": "code", - "text": "`json`" - }, - { - "kind": "text", - "text": ", serialize it and attach the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header as " - }, - { - "kind": "code", - "text": "`application/json`" - }, - { - "kind": "text", - "text": ". You can override this behavior by passing in a " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header of your own.\n- Responses are automatically parsed as " - }, - { - "kind": "code", - "text": "`json`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`blob`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`form-data`" - }, - { - "kind": "text", - "text": " depending on the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header sent by your function. Responses are parsed as " - }, - { - "kind": "code", - "text": "`text`" - }, - { - "kind": "text", - "text": " by default." - } - ] - }, - { - "tag": "@example", - "name": "Basic invocation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n body: { foo: 'bar' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Error handling\nA " - }, - { - "kind": "code", - "text": "`FunctionsHttpError`" - }, - { - "kind": "text", - "text": " error is returned if your function throws an error, " - }, - { - "kind": "code", - "text": "`FunctionsRelayError`" - }, - { - "kind": "text", - "text": " if the Supabase Relay has an error processing your function and " - }, - { - "kind": "code", - "text": "`FunctionsFetchError`" - }, - { - "kind": "text", - "text": " if there is a network error in calling your function. Log the full error object so fields like " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`context`" - }, - { - "kind": "text", - "text": ", and any structured body aren't hidden." - } - ] - }, - { - "tag": "@example", - "name": "Error handling", - "content": [ - { - "kind": "code", - "text": "```js\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \"@supabase/supabase-js\";\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n\nif (error instanceof FunctionsHttpError) {\n const errorMessage = await error.context.json()\n console.error('Function returned an error', errorMessage)\n} else if (error instanceof FunctionsRelayError) {\n console.error('Relay error:', error)\n} else if (error instanceof FunctionsFetchError) {\n console.error('Fetch error:', error)\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Passing custom headers\nYou can pass custom headers to your function. Note: supabase-js automatically passes the " - }, - { - "kind": "code", - "text": "`Authorization`" - }, - { - "kind": "text", - "text": " header with the signed in user's JWT." - } - ] - }, - { - "tag": "@example", - "name": "Passing custom headers", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Calling with DELETE HTTP verb\nYou can also set the HTTP verb to " - }, - { - "kind": "code", - "text": "`DELETE`" - }, - { - "kind": "text", - "text": " when calling your Edge Function." - } - ] - }, - { - "tag": "@example", - "name": "Calling with DELETE HTTP verb", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' },\n method: 'DELETE'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Invoking a Function in the UsEast1 region\nHere are the available regions:\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.Any`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApNortheast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApNortheast2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSouth1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSoutheast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSoutheast2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.CaCentral1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuCentral1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest3`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.SaEast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsEast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsWest1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsWest2`" - } - ] - }, - { - "tag": "@example", - "name": "Invoking a Function in the UsEast1 region", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient, FunctionRegion } from '@supabase/supabase-js'\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n body: { foo: 'bar' },\n region: FunctionRegion.UsEast1\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Calling with GET HTTP verb\nYou can also set the HTTP verb to " - }, - { - "kind": "code", - "text": "`GET`" - }, - { - "kind": "text", - "text": " when calling your Edge Function." - } - ] - }, - { - "tag": "@example", - "name": "Calling with GET HTTP verb", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n method: 'GET'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone client invoke", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Ada' },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 202, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202" - } - ], - "typeParameters": [ - { - "id": 33, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - } - ], - "parameters": [ - { - "id": 34, - "name": "functionName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Function to invoke." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 35, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for invoking the Function." - } - ] - }, - "type": { - "type": "reference", - "target": 36, - "name": "FunctionInvokeOptions", - "package": "@supabase/functions-js" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 109, - "typeArguments": [ - { - "type": "reference", - "target": 33, - "name": "T", - "package": "@supabase/functions-js", - "refersToTypeParameter": true - } - ], - "name": "FunctionsResponse", - "package": "@supabase/functions-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 28, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73" - } - ], - "signatures": [ - { - "id": 29, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the authorization header" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@example", - "name": "Setting the authorization header", - "content": [ - { - "kind": "code", - "text": "```ts\nfunctions.setAuth(session.access_token)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73" - } - ], - "parameters": [ - { - "id": 30, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the new jwt token sent in the authorisation header" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [20, 18, 19, 17] - }, - { - "title": "Methods", - "children": [31, 28] - } - ], - "categories": [ - { - "title": "Edge Functions", - "children": [2, 31, 28] - }, - { - "title": "Other", - "children": [20, 18, 19, 17] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 15, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L15" - } - ] - }, - { - "id": 47, - "name": "FunctionsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error for Supabase Edge Function invocations." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsError } from '@supabase/functions-js'\n\nthrow new FunctionsError('Unexpected error invoking function', 'FunctionsError', {\n requestId: 'abc123',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 48, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32" - } - ], - "signatures": [ - { - "id": 49, - "name": "FunctionsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32" - } - ], - "parameters": [ - { - "id": 50, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 51, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'FunctionsError'" - }, - { - "id": 52, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 53, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 54, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 55, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 59, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 58, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 57, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [59, 58, 57] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [48] - }, - { - "title": "Properties", - "children": [53] - }, - { - "title": "Methods", - "children": [54] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 30, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L30" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 60, - "name": "FunctionsFetchError" - }, - { - "type": "reference", - "target": 71, - "name": "FunctionsHttpError" - }, - { - "type": "reference", - "target": 82, - "name": "FunctionsRelayError" - } - ] - }, - { - "id": 60, - "name": "FunctionsFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the network request to an Edge Function fails." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsFetchError } from '@supabase/functions-js'\n\nthrow new FunctionsFetchError({ requestId: 'abc123' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 61, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58" - } - ], - "signatures": [ - { - "id": 62, - "name": "FunctionsFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58" - } - ], - "parameters": [ - { - "id": 63, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 60, - "name": "FunctionsFetchError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 64, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 65, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 66, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 70, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 69, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 68, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [70, 69, 68] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [61] - }, - { - "title": "Properties", - "children": [64] - }, - { - "title": "Methods", - "children": [65] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 57, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L57" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 71, - "name": "FunctionsHttpError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Edge Function returns a non-2xx status code." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsHttpError } from '@supabase/functions-js'\n\nthrow new FunctionsHttpError({ status: 500 })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 72, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90" - } - ], - "signatures": [ - { - "id": 73, - "name": "FunctionsHttpError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90" - } - ], - "parameters": [ - { - "id": 74, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 71, - "name": "FunctionsHttpError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 75, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 76, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 77, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 81, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 80, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 79, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [81, 80, 79] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [72] - }, - { - "title": "Properties", - "children": [75] - }, - { - "title": "Methods", - "children": [76] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 89, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L89" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 82, - "name": "FunctionsRelayError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Supabase relay cannot reach the Edge Function." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsRelayError } from '@supabase/functions-js'\n\nthrow new FunctionsRelayError({ region: 'us-east-1' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 83, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74" - } - ], - "signatures": [ - { - "id": 84, - "name": "FunctionsRelayError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74" - } - ], - "parameters": [ - { - "id": 85, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 82, - "name": "FunctionsRelayError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 86, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 87, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 88, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 89, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 92, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 91, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 90, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [92, 91, 90] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [83] - }, - { - "title": "Properties", - "children": [86] - }, - { - "title": "Methods", - "children": [87] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 73, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L73" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 36, - "name": "FunctionInvokeOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 113, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 44, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L129" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 38, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Object representing the headers to send with the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "indexSignatures": [ - { - "id": 40, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "parameters": [ - { - "id": 41, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 42, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP verb of the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L121" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 43, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Region to invoke the function in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L125" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 45, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L140" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 46, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timeout for the request in milliseconds.\nIf the function takes longer than this, the request will be aborted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 145, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L145" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [44, 38, 42, 43, 45, 46] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 113, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113" - } - ] - } - } - }, - { - "id": 109, - "name": "FunctionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L16" - } - ], - "typeParameters": [ - { - "id": 110, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 110, - "name": "T", - "package": "@supabase/functions-js", - "refersToTypeParameter": true - } - ], - "name": "FunctionsResponseSuccess", - "package": "@supabase/functions-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponseFailure" - }, - "name": "FunctionsResponseFailure", - "package": "@supabase/functions-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [93] - }, - { - "title": "Classes", - "children": [1, 47, 60, 71, 82] - }, - { - "title": "Type Aliases", - "children": [36, 109] - } - ], - "packageName": "@supabase/functions-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Functions JS SDK

    \n\n

    JavaScript SDK to interact with Supabase Edge Functions.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/functions-js)](https://www.npmjs.com/package/@supabase/functions-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/functions-js)](https://pkg.pr.new/~/supabase/functions-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Quick Start\n\n### Installation\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/functions-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Usage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { FunctionsClient } from '@supabase/functions-js'\n\nconst functionsUrl = 'https://.supabase.co/functions/v1'\nconst publishableKey = ''\n\nconst functions = new FunctionsClient(functionsUrl, {\n headers: {\n Authorization: `Bearer ${publishableKey}`,\n },\n})\n\n// Invoke a function\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Functions' },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build functions-js\n\n# Build with watch mode for development\npnpm nx build functions-js --watch\n\n# Individual build targets\npnpm nx build:main functions-js # CommonJS build (dist/main/)\npnpm nx build:module functions-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx clean functions-js # Clean build artifacts\npnpm nx typecheck functions-js # TypeScript type checking\npnpm nx docs functions-js # Generate documentation\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\n### Testing\n\n**Docker Required** for relay tests. The functions-js tests use testcontainers to spin up a Deno relay server for testing Edge Function invocations.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run all tests (from monorepo root)\npnpm nx test functions-js\n\n# Run tests with coverage report\npnpm nx test functions-js --coverage\n\n# Run tests in watch mode during development\npnpm nx test functions-js --watch\n\n# CI test command (runs with coverage)\npnpm nx test:ci functions-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Requirements\n\n- **Node.js 20+** - Required for testcontainers\n- **Docker** - Must be installed and running for relay tests\n- No Supabase instance needed - Tests use mocked services and testcontainers\n\n#### What Gets Tested\n\n- **Function invocation** - Testing the " - }, - { - "kind": "code", - "text": "`invoke()`" - }, - { - "kind": "text", - "text": " method with various options\n- **Relay functionality** - Using a containerized Deno relay to test real Edge Function scenarios\n- **Error handling** - Ensuring proper error responses and retries\n- **Request/response models** - Validating headers, body, and response formats\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "2": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.__constructor" - }, - "3": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "4": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "url" - }, - "5": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__1" - }, - "6": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type" - }, - "7": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.headers" - }, - "8": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.customFetch" - }, - "9": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "10": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "11": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "12": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "13": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "14": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "15": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "16": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.region" - }, - "17": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.url" - }, - "18": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.headers" - }, - "19": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.region" - }, - "20": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.fetch" - }, - "21": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "22": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "23": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "24": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "25": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "26": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "27": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "28": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.setAuth" - }, - "29": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.setAuth" - }, - "30": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "token" - }, - "31": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.invoke" - }, - "32": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.invoke" - }, - "33": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "T" - }, - "34": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "functionName" - }, - "35": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "options" - }, - "36": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionInvokeOptions" - }, - "37": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "38": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.headers" - }, - "39": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "40": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.__index" - }, - "42": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.method" - }, - "43": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.region" - }, - "44": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.body" - }, - "45": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.signal" - }, - "46": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.timeout" - }, - "47": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError" - }, - "48": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.__constructor" - }, - "49": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError" - }, - "50": { - "sourceFileName": "src/types.ts", - "qualifiedName": "message" - }, - "51": { - "sourceFileName": "src/types.ts", - "qualifiedName": "name" - }, - "52": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "53": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "54": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "55": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "56": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "57": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "58": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "59": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "60": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "61": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError.__constructor" - }, - "62": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "63": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "64": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "65": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "66": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "67": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "69": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "70": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "71": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "72": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError.__constructor" - }, - "73": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "74": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "75": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "76": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "77": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "78": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "79": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "80": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "81": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "82": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "83": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError.__constructor" - }, - "84": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "85": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "86": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "87": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "88": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "89": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "90": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "91": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "92": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "93": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion" - }, - "94": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.Any" - }, - "95": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast1" - }, - "96": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast2" - }, - "97": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSouth1" - }, - "98": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast1" - }, - "99": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast2" - }, - "100": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.CaCentral1" - }, - "101": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuCentral1" - }, - "102": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest1" - }, - "103": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest2" - }, - "104": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest3" - }, - "105": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.SaEast1" - }, - "106": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsEast1" - }, - "107": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsWest1" - }, - "108": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsWest2" - }, - "109": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponse" - }, - "110": { - "sourceFileName": "src/types.ts", - "qualifiedName": "T" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json deleted file mode 100644 index 284bd1f55e5..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json +++ /dev/null @@ -1,3825 +0,0 @@ -{ - "id": 0, - "name": "@supabase/functions-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 93, - "name": "FunctionRegion", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 94, - "name": "Any", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L96" - } - ], - "type": { - "type": "literal", - "value": "any" - } - }, - { - "id": 95, - "name": "ApNortheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 97, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L97" - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-1" - } - }, - { - "id": 96, - "name": "ApNortheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 98, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L98" - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-2" - } - }, - { - "id": 97, - "name": "ApSouth1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 99, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L99" - } - ], - "type": { - "type": "literal", - "value": "ap-south-1" - } - }, - { - "id": 98, - "name": "ApSoutheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 100, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L100" - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-1" - } - }, - { - "id": 99, - "name": "ApSoutheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 101, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L101" - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-2" - } - }, - { - "id": 100, - "name": "CaCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 102, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L102" - } - ], - "type": { - "type": "literal", - "value": "ca-central-1" - } - }, - { - "id": 101, - "name": "EuCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 103, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L103" - } - ], - "type": { - "type": "literal", - "value": "eu-central-1" - } - }, - { - "id": 102, - "name": "EuWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 104, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L104" - } - ], - "type": { - "type": "literal", - "value": "eu-west-1" - } - }, - { - "id": 103, - "name": "EuWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 105, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L105" - } - ], - "type": { - "type": "literal", - "value": "eu-west-2" - } - }, - { - "id": 104, - "name": "EuWest3", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 106, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L106" - } - ], - "type": { - "type": "literal", - "value": "eu-west-3" - } - }, - { - "id": 105, - "name": "SaEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L107" - } - ], - "type": { - "type": "literal", - "value": "sa-east-1" - } - }, - { - "id": 106, - "name": "UsEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 108, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L108" - } - ], - "type": { - "type": "literal", - "value": "us-east-1" - } - }, - { - "id": 107, - "name": "UsWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L109" - } - ], - "type": { - "type": "literal", - "value": "us-west-1" - } - }, - { - "id": 108, - "name": "UsWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 110, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L110" - } - ], - "type": { - "type": "literal", - "value": "us-west-2" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 95, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L95" - } - ] - }, - { - "id": 1, - "name": "FunctionsClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for invoking Supabase Edge Functions." - } - ] - }, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44" - } - ], - "signatures": [ - { - "id": 3, - "name": "FunctionsClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Functions client bound to an Edge Functions URL." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.functions.invoke('hello-world')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsClient, FunctionRegion } from '@supabase/functions-js'\n\nconst functions = new FunctionsClient('https://xyzcompany.supabase.co/functions/v1', {\n headers: { apikey: 'your-publishable-key' },\n region: FunctionRegion.UsEast1,\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L44" - } - ], - "parameters": [ - { - "id": 4, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 6, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 8, - "name": "customFetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 52, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L52" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 9, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 10, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 11, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 12, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 13, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 14, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 15, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 7, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 51, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L51" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 16, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 53, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L53" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - }, - "defaultValue": "FunctionRegion.Any" - } - ], - "groups": [ - { - "title": "Properties", - "children": [8, 7, 16] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 50, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L50" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "FunctionsClient", - "package": "@supabase/functions-js" - } - } - ] - }, - { - "id": 20, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 19, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L19" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 22, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 23, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 24, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 25, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 26, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 27, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 18, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 17, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L17" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 19, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 18, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L18" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 17, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L16" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 31, - "name": "invoke", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 202, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202" - } - ], - "signatures": [ - { - "id": 32, - "name": "invoke", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Invokes a function" - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Ada' },\n})\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires an Authorization header.\n- Invoke params generally match the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) spec.\n- When you pass in a body to your function, we automatically attach the Content-Type header for " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`String`" - }, - { - "kind": "text", - "text": ". If it doesn't match any of these types we assume the payload is " - }, - { - "kind": "code", - "text": "`json`" - }, - { - "kind": "text", - "text": ", serialize it and attach the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header as " - }, - { - "kind": "code", - "text": "`application/json`" - }, - { - "kind": "text", - "text": ". You can override this behavior by passing in a " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header of your own.\n- Responses are automatically parsed as " - }, - { - "kind": "code", - "text": "`json`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`blob`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`form-data`" - }, - { - "kind": "text", - "text": " depending on the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header sent by your function. Responses are parsed as " - }, - { - "kind": "code", - "text": "`text`" - }, - { - "kind": "text", - "text": " by default." - } - ] - }, - { - "tag": "@example", - "name": "Basic invocation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n body: { foo: 'bar' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Error handling\nA " - }, - { - "kind": "code", - "text": "`FunctionsHttpError`" - }, - { - "kind": "text", - "text": " error is returned if your function throws an error, " - }, - { - "kind": "code", - "text": "`FunctionsRelayError`" - }, - { - "kind": "text", - "text": " if the Supabase Relay has an error processing your function and " - }, - { - "kind": "code", - "text": "`FunctionsFetchError`" - }, - { - "kind": "text", - "text": " if there is a network error in calling your function. Log the full error object so fields like " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`context`" - }, - { - "kind": "text", - "text": ", and any structured body aren't hidden." - } - ] - }, - { - "tag": "@example", - "name": "Error handling", - "content": [ - { - "kind": "code", - "text": "```js\nimport { FunctionsHttpError, FunctionsRelayError, FunctionsFetchError } from \"@supabase/supabase-js\";\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n\nif (error instanceof FunctionsHttpError) {\n const errorMessage = await error.context.json()\n console.error('Function returned an error', errorMessage)\n} else if (error instanceof FunctionsRelayError) {\n console.error('Relay error:', error)\n} else if (error instanceof FunctionsFetchError) {\n console.error('Fetch error:', error)\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Passing custom headers\nYou can pass custom headers to your function. Note: supabase-js automatically passes the " - }, - { - "kind": "code", - "text": "`Authorization`" - }, - { - "kind": "text", - "text": " header with the signed in user's JWT." - } - ] - }, - { - "tag": "@example", - "name": "Passing custom headers", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Calling with DELETE HTTP verb\nYou can also set the HTTP verb to " - }, - { - "kind": "code", - "text": "`DELETE`" - }, - { - "kind": "text", - "text": " when calling your Edge Function." - } - ] - }, - { - "tag": "@example", - "name": "Calling with DELETE HTTP verb", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n body: { foo: 'bar' },\n method: 'DELETE'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Invoking a Function in the UsEast1 region\nHere are the available regions:\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.Any`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApNortheast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApNortheast2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSouth1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSoutheast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.ApSoutheast2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.CaCentral1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuCentral1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest2`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.EuWest3`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.SaEast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsEast1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsWest1`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`FunctionRegion.UsWest2`" - } - ] - }, - { - "tag": "@example", - "name": "Invoking a Function in the UsEast1 region", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient, FunctionRegion } from '@supabase/supabase-js'\n\nconst { data, error } = await supabase.functions.invoke('hello', {\n body: { foo: 'bar' },\n region: FunctionRegion.UsEast1\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Calling with GET HTTP verb\nYou can also set the HTTP verb to " - }, - { - "kind": "code", - "text": "`GET`" - }, - { - "kind": "text", - "text": " when calling your Edge Function." - } - ] - }, - { - "tag": "@example", - "name": "Calling with GET HTTP verb", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.functions.invoke('hello', {\n headers: {\n \"my-custom-header\": 'my-custom-header-value'\n },\n method: 'GET'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone client invoke", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Ada' },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 202, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L202" - } - ], - "typeParameters": [ - { - "id": 33, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - } - ], - "parameters": [ - { - "id": 34, - "name": "functionName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Function to invoke." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 35, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for invoking the Function." - } - ] - }, - "type": { - "type": "reference", - "target": 36, - "name": "FunctionInvokeOptions", - "package": "@supabase/functions-js" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 109, - "typeArguments": [ - { - "type": "reference", - "target": 33, - "name": "T", - "package": "@supabase/functions-js", - "refersToTypeParameter": true - } - ], - "name": "FunctionsResponse", - "package": "@supabase/functions-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 28, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73" - } - ], - "signatures": [ - { - "id": 29, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the authorization header" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - }, - { - "tag": "@example", - "name": "Setting the authorization header", - "content": [ - { - "kind": "code", - "text": "```ts\nfunctions.setAuth(session.access_token)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L73" - } - ], - "parameters": [ - { - "id": 30, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the new jwt token sent in the authorisation header" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [20, 18, 19, 17] - }, - { - "title": "Methods", - "children": [31, 28] - } - ], - "categories": [ - { - "title": "Edge Functions", - "children": [2, 31, 28] - }, - { - "title": "Other", - "children": [20, 18, 19, 17] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/FunctionsClient.ts", - "line": 15, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/FunctionsClient.ts#L15" - } - ] - }, - { - "id": 47, - "name": "FunctionsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error for Supabase Edge Function invocations." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsError } from '@supabase/functions-js'\n\nthrow new FunctionsError('Unexpected error invoking function', 'FunctionsError', {\n requestId: 'abc123',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 48, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32" - } - ], - "signatures": [ - { - "id": 49, - "name": "FunctionsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L32" - } - ], - "parameters": [ - { - "id": 50, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 51, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'FunctionsError'" - }, - { - "id": 52, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 53, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 54, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 55, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 59, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 58, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 57, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [59, 58, 57] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [48] - }, - { - "title": "Properties", - "children": [53] - }, - { - "title": "Methods", - "children": [54] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 30, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L30" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 60, - "name": "FunctionsFetchError" - }, - { - "type": "reference", - "target": 71, - "name": "FunctionsHttpError" - }, - { - "type": "reference", - "target": 82, - "name": "FunctionsRelayError" - } - ] - }, - { - "id": 60, - "name": "FunctionsFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the network request to an Edge Function fails." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsFetchError } from '@supabase/functions-js'\n\nthrow new FunctionsFetchError({ requestId: 'abc123' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 61, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58" - } - ], - "signatures": [ - { - "id": 62, - "name": "FunctionsFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L58" - } - ], - "parameters": [ - { - "id": 63, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 60, - "name": "FunctionsFetchError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 64, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 65, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 66, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 70, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 69, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 68, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [70, 69, 68] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [61] - }, - { - "title": "Properties", - "children": [64] - }, - { - "title": "Methods", - "children": [65] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 57, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L57" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 71, - "name": "FunctionsHttpError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Edge Function returns a non-2xx status code." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsHttpError } from '@supabase/functions-js'\n\nthrow new FunctionsHttpError({ status: 500 })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 72, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90" - } - ], - "signatures": [ - { - "id": 73, - "name": "FunctionsHttpError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L90" - } - ], - "parameters": [ - { - "id": 74, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 71, - "name": "FunctionsHttpError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 75, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 76, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 77, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 81, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 80, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 79, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [81, 80, 79] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [72] - }, - { - "title": "Properties", - "children": [75] - }, - { - "title": "Methods", - "children": [76] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 89, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L89" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 82, - "name": "FunctionsRelayError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Supabase relay cannot reach the Edge Function." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsRelayError } from '@supabase/functions-js'\n\nthrow new FunctionsRelayError({ region: 'us-east-1' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 83, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74" - } - ], - "signatures": [ - { - "id": 84, - "name": "FunctionsRelayError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L74" - } - ], - "parameters": [ - { - "id": 85, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 82, - "name": "FunctionsRelayError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 49, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 48, - "name": "FunctionsError.constructor" - } - }, - { - "id": 86, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 53, - "name": "FunctionsError.context" - } - }, - { - "id": 87, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "signatures": [ - { - "id": 88, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 89, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 92, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 91, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 90, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [92, 91, 90] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L38" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 55, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 54, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [83] - }, - { - "title": "Properties", - "children": [86] - }, - { - "title": "Methods", - "children": [87] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 73, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L73" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 47, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 36, - "name": "FunctionInvokeOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 113, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 37, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 44, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L129" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 38, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Object representing the headers to send with the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "indexSignatures": [ - { - "id": 40, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L117" - } - ], - "parameters": [ - { - "id": 41, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 42, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP verb of the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L121" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 43, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Region to invoke the function in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L125" - } - ], - "type": { - "type": "reference", - "target": 93, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 45, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L140" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 46, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timeout for the request in milliseconds.\nIf the function takes longer than this, the request will be aborted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 145, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L145" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [44, 38, 42, 43, 45, 46] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 113, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L113" - } - ] - } - } - }, - { - "id": 109, - "name": "FunctionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/src/types.ts", - "line": 16, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/functions-js/src/types.ts#L16" - } - ], - "typeParameters": [ - { - "id": 110, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 110, - "name": "T", - "package": "@supabase/functions-js", - "refersToTypeParameter": true - } - ], - "name": "FunctionsResponseSuccess", - "package": "@supabase/functions-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponseFailure" - }, - "name": "FunctionsResponseFailure", - "package": "@supabase/functions-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [93] - }, - { - "title": "Classes", - "children": [1, 47, 60, 71, 82] - }, - { - "title": "Type Aliases", - "children": [36, 109] - } - ], - "packageName": "@supabase/functions-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Functions JS SDK

    \n\n

    JavaScript SDK to interact with Supabase Edge Functions.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/functions-js)](https://www.npmjs.com/package/@supabase/functions-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/functions-js)](https://pkg.pr.new/~/supabase/functions-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Quick Start\n\n### Installation\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/functions-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Usage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { FunctionsClient } from '@supabase/functions-js'\n\nconst functionsUrl = 'https://.supabase.co/functions/v1'\nconst publishableKey = ''\n\nconst functions = new FunctionsClient(functionsUrl, {\n headers: {\n Authorization: `Bearer ${publishableKey}`,\n },\n})\n\n// Invoke a function\nconst { data, error } = await functions.invoke('hello-world', {\n body: { name: 'Functions' },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build functions-js\n\n# Build with watch mode for development\npnpm nx build functions-js --watch\n\n# Individual build targets\npnpm nx build:main functions-js # CommonJS build (dist/main/)\npnpm nx build:module functions-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx clean functions-js # Clean build artifacts\npnpm nx typecheck functions-js # TypeScript type checking\npnpm nx docs functions-js # Generate documentation\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\n### Testing\n\n**Docker Required** for relay tests. The functions-js tests use testcontainers to spin up a Deno relay server for testing Edge Function invocations.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run all tests (from monorepo root)\npnpm nx test functions-js\n\n# Run tests with coverage report\npnpm nx test functions-js --coverage\n\n# Run tests in watch mode during development\npnpm nx test functions-js --watch\n\n# CI test command (runs with coverage)\npnpm nx test:ci functions-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Requirements\n\n- **Node.js 20+** - Required for testcontainers\n- **Docker** - Must be installed and running for relay tests\n- No Supabase instance needed - Tests use mocked services and testcontainers\n\n#### What Gets Tested\n\n- **Function invocation** - Testing the " - }, - { - "kind": "code", - "text": "`invoke()`" - }, - { - "kind": "text", - "text": " method with various options\n- **Relay functionality** - Using a containerized Deno relay to test real Edge Function scenarios\n- **Error handling** - Ensuring proper error responses and retries\n- **Request/response models** - Validating headers, body, and response formats\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "2": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.__constructor" - }, - "3": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "4": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "url" - }, - "5": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__1" - }, - "6": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type" - }, - "7": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.headers" - }, - "8": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.customFetch" - }, - "9": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "10": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "11": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "12": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "13": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "14": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "15": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "16": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "__type.region" - }, - "17": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.url" - }, - "18": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.headers" - }, - "19": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.region" - }, - "20": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.fetch" - }, - "21": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "22": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "23": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "24": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "25": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "26": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "27": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "28": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.setAuth" - }, - "29": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.setAuth" - }, - "30": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "token" - }, - "31": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.invoke" - }, - "32": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient.invoke" - }, - "33": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "T" - }, - "34": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "functionName" - }, - "35": { - "sourceFileName": "src/FunctionsClient.ts", - "qualifiedName": "options" - }, - "36": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionInvokeOptions" - }, - "37": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "38": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.headers" - }, - "39": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "40": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.__index" - }, - "42": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.method" - }, - "43": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.region" - }, - "44": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.body" - }, - "45": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.signal" - }, - "46": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.timeout" - }, - "47": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError" - }, - "48": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.__constructor" - }, - "49": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError" - }, - "50": { - "sourceFileName": "src/types.ts", - "qualifiedName": "message" - }, - "51": { - "sourceFileName": "src/types.ts", - "qualifiedName": "name" - }, - "52": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "53": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "54": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "55": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "56": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "57": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "58": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "59": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "60": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "61": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError.__constructor" - }, - "62": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "63": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "64": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "65": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "66": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "67": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "69": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "70": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "71": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "72": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError.__constructor" - }, - "73": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "74": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "75": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "76": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "77": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "78": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "79": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "80": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "81": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "82": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "83": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError.__constructor" - }, - "84": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "85": { - "sourceFileName": "src/types.ts", - "qualifiedName": "context" - }, - "86": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "87": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "88": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "89": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type" - }, - "90": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.name" - }, - "91": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.message" - }, - "92": { - "sourceFileName": "src/types.ts", - "qualifiedName": "__type.context" - }, - "93": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion" - }, - "94": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.Any" - }, - "95": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast1" - }, - "96": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast2" - }, - "97": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSouth1" - }, - "98": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast1" - }, - "99": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast2" - }, - "100": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.CaCentral1" - }, - "101": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuCentral1" - }, - "102": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest1" - }, - "103": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest2" - }, - "104": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.EuWest3" - }, - "105": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.SaEast1" - }, - "106": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsEast1" - }, - "107": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsWest1" - }, - "108": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionRegion.UsWest2" - }, - "109": { - "sourceFileName": "src/types.ts", - "qualifiedName": "FunctionsResponse" - }, - "110": { - "sourceFileName": "src/types.ts", - "qualifiedName": "T" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json b/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json deleted file mode 100644 index 50e553a359d..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/gotrue.json +++ /dev/null @@ -1,52557 +0,0 @@ -{ - "id": 0, - "name": "@supabase/auth-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1744, - "name": "AuthApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error returned directly from the GoTrue REST API." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthApiError } from '@supabase/auth-js'\n\nthrow new AuthApiError('Invalid credentials', 400, 'invalid_credentials')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1745, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L67" - } - ], - "signatures": [ - { - "id": 1746, - "name": "AuthApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L67" - } - ], - "parameters": [ - { - "id": 1747, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1748, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1749, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 1744, - "name": "AuthApiError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1751, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1750, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L65" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1754, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1755, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1756, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1760, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1761, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1758, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1757, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1759, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1760, 1758, 1757, 1759] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1745] - }, - { - "title": "Properties", - "children": [1751, 1750] - }, - { - "title": "Methods", - "children": [1754] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 64, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L64" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1726, - "name": "AuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error thrown by Supabase Auth helpers." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthError } from '@supabase/auth-js'\n\nthrow new AuthError('Unexpected auth error', 500, 'unexpected')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1727, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L28" - } - ], - "signatures": [ - { - "id": 1728, - "name": "AuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L28" - } - ], - "parameters": [ - { - "id": 1729, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1730, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1731, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 1732, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1733, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1734, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1736, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1737, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1738, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1742, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1743, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1740, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1739, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1741, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1742, 1740, 1739, 1741] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1727] - }, - { - "title": "Properties", - "children": [1732, 1734] - }, - { - "title": "Methods", - "children": [1736] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 14, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L14" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1744, - "name": "AuthApiError" - }, - { - "type": "reference", - "target": 1762, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1849, - "name": "AuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when implicit grant redirects contain an error." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthImplicitGrantRedirectError } from '@supabase/auth-js'\n\nthrow new AuthImplicitGrantRedirectError('OAuth redirect failed', {\n error: 'access_denied',\n code: 'oauth_error',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1850, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "signatures": [ - { - "id": 1851, - "name": "AuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "parameters": [ - { - "id": 1852, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1853, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1854, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1856, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1855, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1856, 1855] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1875, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1876, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1857, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1858, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1860, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1859, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1860, 1859] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1873, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1874, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1861, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ], - "signatures": [ - { - "id": 1862, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1867, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 200, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L200" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1868, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1869, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1870, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1872, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1871, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1872, 1871] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ] - } - } - ] - } - }, - { - "id": 1865, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 198, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L198" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1864, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 197, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L197" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1866, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 199, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L199" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1867, 1869, 1865, 1864, 1866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1850] - }, - { - "title": "Properties", - "children": [1875, 1857, 1873, 1874] - }, - { - "title": "Methods", - "children": [1861] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 189, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L189" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1832, - "name": "AuthInvalidCredentialsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when email/password credentials are invalid." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidCredentialsError } from '@supabase/auth-js'\n\nthrow new AuthInvalidCredentialsError('Email or password is incorrect')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1833, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L171" - } - ], - "signatures": [ - { - "id": 1834, - "name": "AuthInvalidCredentialsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L171" - } - ], - "parameters": [ - { - "id": 1835, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1832, - "name": "AuthInvalidCredentialsError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1838, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1839, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1836, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1837, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1841, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1842, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1847, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1848, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1845, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1844, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1846, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1847, 1845, 1844, 1846] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1833] - }, - { - "title": "Properties", - "children": [1838, 1836, 1837] - }, - { - "title": "Methods", - "children": [1841] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 170, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L170" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1979, - "name": "AuthInvalidJwtError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a JWT cannot be verified or parsed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidJwtError } from '@supabase/auth-js'\n\nthrow new AuthInvalidJwtError('Token signature is invalid')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1980, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L388" - } - ], - "signatures": [ - { - "id": 1981, - "name": "AuthInvalidJwtError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L388" - } - ], - "parameters": [ - { - "id": 1982, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1979, - "name": "AuthInvalidJwtError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1985, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1986, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1983, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1984, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1988, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1989, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1990, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1994, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1995, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1992, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1991, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1993, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1994, 1992, 1991, 1993] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1980] - }, - { - "title": "Properties", - "children": [1985, 1983, 1984] - }, - { - "title": "Methods", - "children": [1988] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 387, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L387" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1816, - "name": "AuthInvalidTokenResponseError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the token response is malformed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidTokenResponseError } from '@supabase/auth-js'\n\nthrow new AuthInvalidTokenResponseError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1817, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L155" - } - ], - "signatures": [ - { - "id": 1818, - "name": "AuthInvalidTokenResponseError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L155" - } - ], - "type": { - "type": "reference", - "target": 1816, - "name": "AuthInvalidTokenResponseError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1821, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1822, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1819, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1820, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1824, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1825, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1826, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1830, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1831, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1828, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1827, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1829, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1830, 1828, 1827, 1829] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1817] - }, - { - "title": "Properties", - "children": [1821, 1819, 1820] - }, - { - "title": "Methods", - "children": [1824] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 154, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L154" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the PKCE code verifier is not found in storage.\nThis typically happens when the auth flow was initiated in a different\nbrowser, device, or the storage was cleared." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCECodeVerifierMissingError } from '@supabase/auth-js'\n\nthrow new AuthPKCECodeVerifierMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1908, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L261" - } - ], - "signatures": [ - { - "id": 1909, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L261" - } - ], - "type": { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1912, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1913, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1910, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1911, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1915, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1916, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1917, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1921, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1919, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1918, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1920, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1921, 1919, 1918, 1920] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1908] - }, - { - "title": "Properties", - "children": [1912, 1910, 1911] - }, - { - "title": "Methods", - "children": [1915] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 260, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L260" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1878, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown during PKCE code exchanges." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'\n\nthrow new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1879, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "signatures": [ - { - "id": 1880, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "parameters": [ - { - "id": 1881, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1882, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1883, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1885, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1884, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1885, 1884] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": 1878, - "name": "AuthPKCEGrantCodeExchangeError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1904, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1905, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1886, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1887, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1889, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1888, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1889, 1888] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1902, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1903, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1890, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ], - "signatures": [ - { - "id": 1891, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1892, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1896, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 238, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L238" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1897, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1898, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1899, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1901, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1900, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1901, 1900] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ] - } - } - ] - } - }, - { - "id": 1894, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 236, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L236" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1893, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L235" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1895, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 237, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L237" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1896, 1898, 1894, 1893, 1895] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1879] - }, - { - "title": "Properties", - "children": [1904, 1886, 1902, 1903] - }, - { - "title": "Methods", - "children": [1890] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 226, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L226" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1941, - "name": "AuthRefreshDiscardedError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returned when the server rotated a refresh token successfully but the\nclient chose not to persist the rotated tokens because the local session\nchanged mid-flight. Usually means a concurrent " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " cleared storage\nbetween when the refresh started and when it came back.\n\nSet on the " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " field of the refresh result so callers can tell \"we\ngot rotated tokens but threw them away\" apart from \"the refresh failed.\"\nThe rotated session on the server will be picked up on the next refresh\nvia GoTrue's parent-of-active path." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { isAuthRefreshDiscardedError } from '@supabase/auth-js'\n\nif (isAuthRefreshDiscardedError(error)) {\n // Concurrent signOut/sign-in raced our refresh. Treat as a no-op.\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1942, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L321" - } - ], - "signatures": [ - { - "id": 1943, - "name": "AuthRefreshDiscardedError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L321" - } - ], - "parameters": [ - { - "id": 1944, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'Refresh result discarded: session state changed mid-flight (e.g., concurrent signOut)'" - } - ], - "type": { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1947, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1948, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1945, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1946, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1950, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1951, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1952, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1956, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1957, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1954, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1953, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1955, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1956, 1954, 1953, 1955] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1942] - }, - { - "title": "Properties", - "children": [1947, 1945, 1946] - }, - { - "title": "Methods", - "children": [1950] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 320, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L320" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1923, - "name": "AuthRetryableFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a transient fetch issue occurs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthRetryableFetchError } from '@supabase/auth-js'\n\nthrow new AuthRetryableFetchError('Service temporarily unavailable', 503)\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1924, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 291, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L291" - } - ], - "signatures": [ - { - "id": 1925, - "name": "AuthRetryableFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 291, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L291" - } - ], - "parameters": [ - { - "id": 1926, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1927, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1930, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1931, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1928, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1929, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1933, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1934, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1935, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1939, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1940, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1937, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1936, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1938, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1939, 1937, 1936, 1938] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1924] - }, - { - "title": "Properties", - "children": [1930, 1928, 1929] - }, - { - "title": "Methods", - "children": [1933] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 290, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L290" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1800, - "name": "AuthSessionMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when an operation requires a session but none is present." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthSessionMissingError } from '@supabase/auth-js'\n\nthrow new AuthSessionMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1801, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 135, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L135" - } - ], - "signatures": [ - { - "id": 1802, - "name": "AuthSessionMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 135, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L135" - } - ], - "type": { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1805, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1806, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1803, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1804, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1808, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1809, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1810, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1814, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1815, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1812, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1811, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1813, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1814, 1812, 1811, 1813] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1801] - }, - { - "title": "Properties", - "children": [1805, 1803, 1804] - }, - { - "title": "Methods", - "children": [1808] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 134, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L134" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1762, - "name": "AuthUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps non-standard errors so callers can inspect the root cause." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthUnknownError } from '@supabase/auth-js'\n\ntry {\n await someAuthCall()\n} catch (err) {\n throw new AuthUnknownError('Auth failed', err)\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1763, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L96" - } - ], - "signatures": [ - { - "id": 1764, - "name": "AuthUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L96" - } - ], - "parameters": [ - { - "id": 1765, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1766, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 1762, - "name": "AuthUnknownError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1768, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1767, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L94" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1770, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1772, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1773, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1774, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1778, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1776, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1775, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1777, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1778, 1776, 1775, 1777] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1763] - }, - { - "title": "Properties", - "children": [1768, 1767, 1770] - }, - { - "title": "Methods", - "children": [1772] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 93, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L93" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1958, - "name": "AuthWeakPasswordError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a supplied password is considered weak." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthWeakPasswordError } from '@supabase/auth-js'\n\nthrow new AuthWeakPasswordError('Password too short', 400, ['min_length'])\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1959, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 353, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L353" - } - ], - "signatures": [ - { - "id": 1960, - "name": "AuthWeakPasswordError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 353, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L353" - } - ], - "parameters": [ - { - "id": 1961, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1962, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1963, - "name": "reasons", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1976, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1977, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1974, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1964, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reasons why the password is deemed weak." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L351" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 1975, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1965, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ], - "signatures": [ - { - "id": 1966, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1967, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1971, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 363, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L363" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1972, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1969, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 361, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L361" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1968, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 360, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L360" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1973, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 364, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L364" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 1970, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 362, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L362" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1971, 1969, 1968, 1973, 1970] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1959] - }, - { - "title": "Properties", - "children": [1976, 1974, 1964, 1975] - }, - { - "title": "Methods", - "children": [1965] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 347, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L347" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1780, - "name": "CustomAuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Flexible error class used to create named auth errors at runtime." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { CustomAuthError } from '@supabase/auth-js'\n\nthrow new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1781, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L117" - } - ], - "signatures": [ - { - "id": 1782, - "name": "CustomAuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L117" - } - ], - "parameters": [ - { - "id": 1783, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1784, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1785, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1786, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1789, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1787, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "AuthError.name" - } - }, - { - "id": 1788, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1792, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1793, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1798, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1799, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1796, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1795, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1797, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1798, 1796, 1795, 1797] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1781] - }, - { - "title": "Properties", - "children": [1789, 1787, 1788] - }, - { - "title": "Methods", - "children": [1792] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 113, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L113" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "target": 1816, - "name": "AuthInvalidTokenResponseError" - }, - { - "type": "reference", - "target": 1832, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "target": 1878, - "name": "AuthPKCEGrantCodeExchangeError" - }, - { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError" - }, - { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError" - }, - { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError" - }, - { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError" - }, - { - "type": "reference", - "target": 1979, - "name": "AuthInvalidJwtError" - } - ] - }, - { - "id": 1, - "name": "GoTrueAdminApi", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 92, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L92" - } - ], - "signatures": [ - { - "id": 3, - "name": "GoTrueAdminApi", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an admin API client that can be used to manage users and OAuth clients." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\nconst { data, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueAdminApi } from '@supabase/auth-js'\n\nconst admin = new GoTrueAdminApi({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { Authorization: `Bearer ${process.env.SUPABASE_SECRET_KEY}` },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 92, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L92" - } - ], - "parameters": [ - { - "id": 4, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 19, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 103, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L103" - } - ], - "type": { - "type": "reference", - "target": 781, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 11, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 102, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L102" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 13, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 14, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 15, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 16, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 17, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 18, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 7, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 99, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L99" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 8, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 99, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L99" - } - ], - "indexSignatures": [ - { - "id": 9, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L100" - } - ], - "parameters": [ - { - "id": 10, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 6, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 98, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L98" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - } - ], - "groups": [ - { - "title": "Properties", - "children": [19, 11, 7, 6] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 97, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L97" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 22, - "name": "customProviders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L55" - } - ], - "type": { - "type": "reference", - "target": 1526, - "name": "GoTrueAdminCustomProvidersApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 20, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all MFA administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 46, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L46" - } - ], - "type": { - "type": "reference", - "target": 1279, - "name": "GoTrueAdminMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 21, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 52, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L52" - } - ], - "type": { - "type": "reference", - "target": 1411, - "name": "GoTrueAdminOAuthApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 23, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all passkey administration methods.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L62" - } - ], - "type": { - "type": "reference", - "target": 1695, - "name": "GoTrueAdminPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 55, - "name": "createUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 485, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L485" - } - ], - "signatures": [ - { - "id": 56, - "name": "createUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To confirm the user's email address or phone number, set " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " to true. Both arguments default to false.\n- " - }, - { - "kind": "code", - "text": "`createUser()`" - }, - { - "kind": "text", - "text": " will not send a confirmation email to the user. You can use [" - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " param to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "With custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n password: 'password',\n user_metadata: { name: 'Yoda' }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With custom user metadata\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n email_confirm: true\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n phone: '1234567890',\n phone_confirm: true\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 485, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L485" - } - ], - "parameters": [ - { - "id": 57, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 933, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 79, - "name": "deleteUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 839, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L839" - } - ], - "signatures": [ - { - "id": 80, - "name": "deleteUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a user. Requires a " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`deleteUser()`" - }, - { - "kind": "text", - "text": " method requires the user's ID, which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Removes a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.deleteUser(\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Removes a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {}\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 839, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L839" - } - ], - "parameters": [ - { - "id": 81, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user id you want to remove." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 82, - "name": "shouldSoftDelete", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 52, - "name": "generateLink", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 375, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L375" - } - ], - "signatures": [ - { - "id": 53, - "name": "generateLink", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates email links and OTPs to be sent via a custom email provider." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The following types can be passed into " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": ": " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_current`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_new`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " only generates the email link for " - }, - { - "kind": "code", - "text": "`email_change_email`" - }, - { - "kind": "text", - "text": " if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " handles the creation of the user for " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Generate a signup link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'signup',\n email: 'email@example.com',\n password: 'secret'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Generate a signup link\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"properties\": {\n \"action_link\": \"\",\n \"email_otp\": \"999999\",\n \"hashed_token\": \"\",\n \"verification_type\": \"signup\"\n },\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"email@example.com\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"email@example.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate an invite link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'invite',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a magic link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'magiclink',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a recovery link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'recovery',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate links to change current email address", - "content": [ - { - "kind": "code", - "text": "```js\n// generate an email change link to be sent to the current email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_current',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n\n// generate an email change link to be sent to the new email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_new',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 375, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L375" - } - ], - "parameters": [ - { - "id": 54, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1147, - "name": "GenerateLinkParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1148, - "name": "GenerateLinkResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 72, - "name": "getUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 628, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L628" - } - ], - "signatures": [ - { - "id": 73, - "name": "getUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get user by id." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Fetches the user object from the database based on the user's id.\n- The " - }, - { - "kind": "code", - "text": "`getUserById()`" - }, - { - "kind": "text", - "text": " method requires the user's id which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Fetch the user object using the access_token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.getUserById(1)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Fetch the user object using the access_token jwt\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 628, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L628" - } - ], - "parameters": [ - { - "id": 74, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 45, - "name": "inviteUserByEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 232, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L232" - } - ], - "signatures": [ - { - "id": 46, - "name": "inviteUserByEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends an invite link to an email address." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Sends an invite link to the user's email address.\n- The " - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": " method is typically used by administrators to invite users to join the application.\n- Note that PKCE is not supported when using " - }, - { - "kind": "code", - "text": "`inviteUserByEmail`" - }, - { - "kind": "text", - "text": ". This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow." - } - ] - }, - { - "tag": "@example", - "name": "Invite a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Invite a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"invited_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 232, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L232" - } - ], - "parameters": [ - { - "id": 47, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options to be included when inviting." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 49, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 50, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store additional metadata about the user. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.user_metadata`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 236, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L236" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 51, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 239, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [50, 51] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 234, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L234" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 58, - "name": "listUsers", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 526, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L526" - } - ], - "signatures": [ - { - "id": 59, - "name": "listUsers", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Defaults to return 50 users per page." - } - ] - }, - { - "tag": "@example", - "name": "Get a page of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Paginated list of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\n page: 1,\n perPage: 1000\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 526, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L526" - } - ], - "parameters": [ - { - "id": 60, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object which supports " - }, - { - "kind": "code", - "text": "`page`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`perPage`" - }, - { - "kind": "text", - "text": " as numbers, to alter the paginated results." - } - ] - }, - "type": { - "type": "reference", - "target": 1300, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 61, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 62, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 63, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 65, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 64, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [65, 64] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ] - } - }, - { - "type": "reference", - "target": 1293, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 66, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [62, 66] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 68, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 70, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [70] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ] - } - } - }, - { - "id": 71, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [68, 71] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 38, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 142, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L142" - } - ], - "signatures": [ - { - "id": 39, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a logged-in session." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 142, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L142" - } - ], - "parameters": [ - { - "id": 40, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A valid, logged-in JWT." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 41, - "name": "scope", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logout sope." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 42, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 43, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 44, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [43, 44] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 75, - "name": "updateUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 789, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L789" - } - ], - "signatures": [ - { - "id": 76, - "name": "updateUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the user data. Changes are applied directly without confirmation flows." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "**Important:** This is a server-side operation and does **not** trigger client-side\n" - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " listeners. The admin API has no connection to client state.\n\nTo sync changes to the client after calling this method:\n1. On the client, call " - }, - { - "kind": "code", - "text": "`supabase.auth.refreshSession()`" - }, - { - "kind": "text", - "text": " to fetch the updated user data\n2. This will trigger the " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event and notify all listeners" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\n// Server-side (Edge Function)\nconst { data, error } = await supabase.auth.admin.updateUserById(\n userId,\n { user_metadata: { preferences: { theme: 'dark' } } }\n)\n\n// Client-side (to sync the changes)\nconst { data, error } = await supabase.auth.refreshSession()\n// onAuthStateChange listeners will now be notified with updated user\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.refreshSession", - "target": 410 - }, - { - "kind": "text", - "text": " for syncing admin changes to the client" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.updateUser", - "target": 386 - }, - { - "kind": "text", - "text": " for client-side user updates (triggers listeners automatically)" - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '11111111-1111-1111-1111-111111111111',\n { email: 'new@email.com' }\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updates a user's email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"new@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { password: 'new_password' }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { user_metadata: { hello: 'world' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's app_metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { app_metadata: { plan: 'trial' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's email address", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { email_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { phone_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Ban a user for 100 years", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { ban_duration: '876000h' }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 789, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L789" - } - ], - "parameters": [ - { - "id": 77, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "reference", - "target": 933, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [22, 20, 21, 23] - }, - { - "title": "Methods", - "children": [55, 79, 52, 72, 45, 58, 38, 75] - } - ], - "categories": [ - { - "title": "Auth", - "children": [55, 79, 52, 72, 45, 58, 38, 75] - }, - { - "title": "Other", - "children": [2, 22, 20, 21, 23] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 44, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L44" - } - ] - }, - { - "id": 136, - "name": "GoTrueClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 138, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L366" - } - ], - "signatures": [ - { - "id": 139, - "name": "GoTrueClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueClient } from '@supabase/auth-js'\n\nconst auth = new GoTrueClient({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { apikey: 'your-publishable-key' },\n storageKey: 'supabase-auth',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L366" - } - ], - "parameters": [ - { - "id": 140, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 748, - "name": "GoTrueClientOptions", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": 136, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 142, - "name": "admin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L234" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - }, - { - "id": 143, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the MFA methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L238" - } - ], - "type": { - "type": "reference", - "target": 1208, - "name": "GoTrueMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 144, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the OAuth 2.1 authorization server methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\nUsed to implement the authorization code flow on the consent page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 244, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L244" - } - ], - "type": { - "type": "reference", - "target": 1575, - "name": "AuthOAuthServerApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 145, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for passkey methods.\nIncludes lower-level two-step registration/authentication and passkey management.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 251, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L251" - } - ], - "type": { - "type": "reference", - "target": 1675, - "name": "AuthPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 579, - "name": "dispose", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5189, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5189" - } - ], - "signatures": [ - { - "id": 580, - "name": "dispose", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tears down the client's background work: stops the auto-refresh interval,\nremoves the " - }, - { - "kind": "code", - "text": "`visibilitychange`" - }, - { - "kind": "text", - "text": " listener, closes the cross-tab\n" - }, - { - "kind": "code", - "text": "`BroadcastChannel`" - }, - { - "kind": "text", - "text": ", and clears registered " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " subscribers.\n\nCall this from cleanup hooks when the client is being replaced before\nits JS realm is destroyed. React Strict Mode and HMR are the common\ncases. Any in-flight " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " calls continue to completion and may still\nwrite to storage; dispose doesn't abort them or erase storage.\n\nLifecycle caveat: because in-flight refreshes are not aborted, a\ndisposed instance can still persist a rotated session to storage after\n" - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " returns. A subsequent " - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " against the same\n" - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " will pick up that session on its next read. If you need\nstrict isolation between client lifecycles, await any pending auth\noperation before calling " - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " (or change the " - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " for\nthe replacement client).\n\nSafe to call repeatedly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup on React unmount", - "content": [ - { - "kind": "code", - "text": "```ts\nuseEffect(() => {\n const client = createClient(...)\n return () => { client.auth.dispose() }\n}, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5189, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5189" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 242, - "name": "exchangeCodeForSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1453, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1453" - } - ], - "signatures": [ - { - "id": 243, - "name": "exchangeCodeForSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Used when " - }, - { - "kind": "code", - "text": "`flowType`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`pkce`" - }, - { - "kind": "text", - "text": " in client options." - } - ] - }, - { - "tag": "@example", - "name": "Exchange Auth Code", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Exchange Auth Code\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n session: {\n access_token: '',\n token_type: 'bearer',\n expires_in: 3600,\n expires_at: 1700000000,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com'\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n \"provider\": \"email\",\n \"providers\": [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n provider_token: '',\n provider_refresh_token: ''\n },\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n redirectType: null\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1453, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1453" - } - ], - "parameters": [ - { - "id": 244, - "name": "authCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 662, - "name": "getClaims", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6145" - } - ], - "signatures": [ - { - "id": 663, - "name": "getClaims", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" - }, - { - "kind": "code", - "text": "`/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": ") to verify the JWT." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\n- A network request is sent to your project's JWT signing key discovery endpoint " - }, - { - "kind": "code", - "text": "`https://project-id.supabase.co/auth/v1/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": ", which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook)." - } - ] - }, - { - "tag": "@example", - "name": "Get JWT claims, header and signature", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getClaims()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get JWT claims, header and signature\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"claims\": {\n \"aal\": \"aal1\",\n \"amr\": [{\n \"method\": \"email\",\n \"timestamp\": 1715766000\n }],\n \"app_metadata\": {},\n \"aud\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"exp\": 1715769600,\n \"iat\": 1715766000,\n \"is_anonymous\": false,\n \"iss\": \"https://project-id.supabase.co/auth/v1\",\n \"phone\": \"+13334445555\",\n \"role\": \"authenticated\",\n \"session_id\": \"11111111-1111-1111-1111-111111111111\",\n \"sub\": \"11111111-1111-1111-1111-111111111111\",\n \"user_metadata\": {}\n },\n \"header\": {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"signature\": [/** Uint8Array */],\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6145" - } - ], - "parameters": [ - { - "id": 664, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getSession" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Various additional options that allow you to customize the\n behavior of this method." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 666, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 668, - "name": "allowExpired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " the " - }, - { - "kind": "code", - "text": "`exp`" - }, - { - "kind": "text", - "text": " claim will not be validated against the current time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6154, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6154" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 669, - "name": "jwks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 670, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 671, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1349, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [671] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ] - } - } - }, - { - "id": 667, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Please use options.jwks instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6151, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6151" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1349, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [668, 669, 667] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6147, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6147" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 673, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 674, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 675, - "name": "claims", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": 1329, - "name": "JwtPayload", - "package": "@supabase/auth-js" - } - }, - { - "id": 676, - "name": "header", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": 1313, - "name": "JwtHeader", - "package": "@supabase/auth-js" - } - }, - { - "id": 677, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [675, 676, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ] - } - } - }, - { - "id": 678, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6162, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6162" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [673, 678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6160" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 679, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 680, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 681, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [680, 681] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 682, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 683, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 684, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [683, 684] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 317, - "name": "getSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2719, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2719" - } - ], - "signatures": [ - { - "id": 318, - "name": "getSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser()" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " instead.\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\n- The session contains an access token (signed JWT), a refresh token and the user object.\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\n- When using in a browser, or you've called " - }, - { - "kind": "code", - "text": "`startAutoRefresh()`" - }, - { - "kind": "text", - "text": " in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or your own JWT verification library to securely establish the user's identity and access. You can also use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch the user object directly from the Auth server for this purpose.\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed." - } - ] - }, - { - "tag": "@example", - "name": "Get the session data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getSession()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the session data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2719, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2719" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 320, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2820, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2820" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 322, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2821, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2821" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [322] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2820, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2820" - } - ] - } - } - }, - { - "id": 323, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2823, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2823" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [320, 323] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2819, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2819" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 324, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 325, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2826, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2826" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 326, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 327, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2827, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2827" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [327] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2826, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2826" - } - ] - } - } - }, - { - "id": 328, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2829, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2829" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [325, 328] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2825, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2825" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 330, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2832, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2832" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 332, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2833, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2833" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [332] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2832, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2832" - } - ] - } - } - }, - { - "id": 333, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2835, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2835" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [330, 333] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2831, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2831" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 380, - "name": "getUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3042, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3042" - } - ], - "signatures": [ - { - "id": 381, - "name": "getUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method fetches the user object from the database instead of local session.\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\n- Should always be used when checking for user authorization on the server. On the client, you can instead use " - }, - { - "kind": "code", - "text": "`getSession().session.user`" - }, - { - "kind": "text", - "text": " for faster results. " - }, - { - "kind": "code", - "text": "`getSession`" - }, - { - "kind": "text", - "text": " is insecure on the server." - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with the current existing session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the logged in user with the current existing session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with a custom access token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3042, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3042" - } - ], - "parameters": [ - { - "id": 382, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 499, - "name": "getUserIdentities", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4337" - } - ], - "signatures": [ - { - "id": 500, - "name": "getUserIdentities", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets all the identities linked to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`getUserIdentities()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Returns a list of identities linked to the user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getUserIdentities()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Returns a list of identities linked to the user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"2024-01-01T00:00:00Z\",\n \"user_id\": \"2024-01-01T00:00:00Z\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ]\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4337" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 501, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 502, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4339, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4339" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 503, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 504, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4340, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4340" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [504] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4339, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4339" - } - ] - } - } - }, - { - "id": 505, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4342, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4342" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [502, 505] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4338, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4338" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 506, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 507, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 508, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [507, 508] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 226, - "name": "initialize", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L544" - } - ], - "signatures": [ - { - "id": 227, - "name": "initialize", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L544" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1289, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 213, - "name": "isThrowOnErrorEnabled", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 506, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L506" - } - ], - "signatures": [ - { - "id": 214, - "name": "isThrowOnErrorEnabled", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns whether error throwing mode is enabled for this client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 506, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L506" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 509, - "name": "linkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`linkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- If the candidate identity is already linked to the existing user or another user, " - }, - { - "kind": "code", - "text": "`linkIdentity()`" - }, - { - "kind": "text", - "text": " will fail.\n- If " - }, - { - "kind": "code", - "text": "`linkIdentity`" - }, - { - "kind": "text", - "text": " is run in the browser, the user is automatically redirected to the returned URL. On the server, you should handle the redirect." - } - ] - }, - { - "tag": "@example", - "name": "Link an identity to a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.linkIdentity({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Link an identity to a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4362, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4362" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4367, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4367" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4396, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4396" - } - ], - "signatures": [ - { - "id": 510, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4362, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4362" - } - ], - "parameters": [ - { - "id": 511, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 995, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 834, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 512, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an OIDC identity to an existing user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4367, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4367" - } - ], - "parameters": [ - { - "id": 513, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1007, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 461, - "name": "onAuthStateChange", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Subscribes to important events occurring on the user's session.\n- Use on the frontend/client. It is less useful on the server.\n- Events are emitted across tabs to keep your application's UI up-to-date. Some events can fire very frequently, based on the number of tabs open. Use a quick and efficient callback function, and defer or debounce as many operations as you can to be performed outside of the callback.\n- Callbacks can be " - }, - { - "kind": "code", - "text": "`async`" - }, - { - "kind": "text", - "text": " and can safely call other Supabase auth methods (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", etc.) from inside the callback.\n- Keep callbacks quick. Events are awaited in order, so a slow callback delays subsequent events to subscribers in this tab.\n- Emitted events:\n - " - }, - { - "kind": "code", - "text": "`INITIAL_SESSION`" - }, - { - "kind": "text", - "text": "\n - Emitted right after the Supabase client is constructed and the initial session from storage is loaded.\n - " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": "\n - Emitted each time a user session is confirmed or re-established, including on user sign in and when refocusing a tab.\n - Avoid making assumptions as to when this event is fired, this may occur even when the user is already signed in. Instead, check the user object attached to the event to see if a new user has signed in and update your application's UI.\n - This event can fire very frequently depending on the number of tabs open in your application.\n - " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": "\n - Emitted when the user signs out. This can be after:\n - A call to " - }, - { - "kind": "code", - "text": "`supabase.auth.signOut()`" - }, - { - "kind": "text", - "text": ".\n - After the user's session has expired for any reason:\n - User has signed out on another device.\n - The session has reached its timebox limit or inactivity timeout.\n - User has signed in on another device with single session per user enabled.\n - Check the [User Sessions](/docs/guides/auth/sessions) docs for more information.\n - Use this to clean up any local storage your application has associated with the user.\n - " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": "\n - Emitted each time a new access and refresh token are fetched for the signed in user.\n - It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application.\n - Avoid frequent calls to " - }, - { - "kind": "code", - "text": "`supabase.auth.getSession()`" - }, - { - "kind": "text", - "text": " for the same purpose.\n - There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event.\n - The frequency of this event is related to the JWT expiry limit configured on your project.\n - " - }, - { - "kind": "code", - "text": "`USER_UPDATED`" - }, - { - "kind": "text", - "text": "\n - Emitted each time the " - }, - { - "kind": "code", - "text": "`supabase.auth.updateUser()`" - }, - { - "kind": "text", - "text": " method finishes successfully. Listen to it to update your application's UI based on new profile information.\n - " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": "\n - Emitted instead of the " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event when the user lands on a page that includes a password recovery link in the URL.\n - Use it to show a UI to the user where they can [reset their password](/docs/guides/auth/passwords#resetting-a-users-password-forgot-password)." - } - ] - }, - { - "tag": "@example", - "name": "Listen to auth changes", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase.auth.onAuthStateChange((event, session) => {\n console.log(event, session)\n\n if (event === 'INITIAL_SESSION') {\n // handle initial session\n } else if (event === 'SIGNED_IN') {\n // handle sign in event\n } else if (event === 'SIGNED_OUT') {\n // handle sign out event\n } else if (event === 'PASSWORD_RECOVERY') {\n // handle password recovery event\n } else if (event === 'TOKEN_REFRESHED') {\n // handle token refreshed event\n } else if (event === 'USER_UPDATED') {\n // handle user updated event\n }\n})\n\n// call unsubscribe to remove the callback\ndata.subscription.unsubscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to sign out\nMake sure you clear out any local data, such as local and session storage, after the client library has detected the user's sign out." - } - ] - }, - { - "tag": "@example", - "name": "Listen to sign out", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'SIGNED_OUT') {\n console.log('SIGNED_OUT', session)\n\n // clear local and session storage\n [\n window.localStorage,\n window.sessionStorage,\n ].forEach((storage) => {\n Object.entries(storage)\n .forEach(([key]) => {\n storage.removeItem(key)\n })\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Store OAuth provider tokens on sign in\nWhen using [OAuth (Social Login)](/docs/guides/auth/social-login) you sometimes wish to get access to the provider's access token and refresh token, in order to call provider APIs in the name of the user.\n\nFor example, if you are using [Sign in with Google](/docs/guides/auth/social-login/auth-google) you may want to use the provider token to call Google APIs on behalf of the user. Supabase Auth does not keep track of the provider access and refresh token, but does return them for you once, immediately after sign in. You can use the " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " method to listen for the presence of the provider tokens and store them in local storage. You can further send them to your server's APIs for use on the backend.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Store OAuth provider tokens on sign in", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Use React Context for the User's session\nInstead of relying on " - }, - { - "kind": "code", - "text": "`supabase.auth.getSession()`" - }, - { - "kind": "text", - "text": " within your React components, you can use a [React Context](https://react.dev/reference/react/createContext) to store the latest session information from the " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback and access it that way." - } - ] - }, - { - "tag": "@example", - "name": "Use React Context for the User's session", - "content": [ - { - "kind": "code", - "text": "```js\nconst SessionContext = React.createContext(null)\n\nfunction main() {\n const [session, setSession] = React.useState(null)\n\n React.useEffect(() => {\n const {data: { subscription }} = supabase.auth.onAuthStateChange(\n (event, session) => {\n if (event === 'SIGNED_OUT') {\n setSession(null)\n } else if (session) {\n setSession(session)\n }\n })\n\n return () => {\n subscription.unsubscribe()\n }\n }, [])\n\n return (\n \n \n \n )\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to password recovery events", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'PASSWORD_RECOVERY') {\n console.log('PASSWORD_RECOVERY', session)\n // show screen to update user's password\n showPasswordResetScreen(true)\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to sign in", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'SIGNED_IN') console.log('SIGNED_IN', session)\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to token refresh", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'TOKEN_REFRESHED') console.log('TOKEN_REFRESHED', session)\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to user updates", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'USER_UPDATED') console.log('USER_UPDATED', session)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4128" - } - ], - "signatures": [ - { - "id": 462, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens.\nSafe to use without an async function as callback." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "parameters": [ - { - "id": 463, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 464, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "signatures": [ - { - "id": 465, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "parameters": [ - { - "id": 466, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 467, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 469, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 471, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ], - "type": { - "type": "reference", - "target": 947, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [471] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [469] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 90, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ] - } - } - }, - { - "id": 472, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens. Common reentry\npatterns (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", reading the session from inside a\nhandler) complete normally. One hazard remains: calling " - }, - { - "kind": "code", - "text": "`refreshSession`" - }, - { - "kind": "text", - "text": "\n(or anything that routes through " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": ") from inside a\n" - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " handler. " - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " resolves only after\n" - }, - { - "kind": "code", - "text": "`_notifyAllSubscribers`" - }, - { - "kind": "text", - "text": " returns, so the inner refresh dedupes onto the\nouter's unresolved promise and the two wait on each other." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Async callbacks can deadlock when they trigger a nested\nrefresh from a " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event. Prefer the sync overload, or move\nrefresh-triggering work outside the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "parameters": [ - { - "id": 473, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 474, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "signatures": [ - { - "id": 475, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "parameters": [ - { - "id": 476, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 477, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 478, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 479, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 481, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ], - "type": { - "type": "reference", - "target": 947, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [481] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [479] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 99, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ] - } - } - } - ] - }, - { - "id": 310, - "name": "reauthenticate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2497" - } - ], - "signatures": [ - { - "id": 311, - "name": "reauthenticate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used together with " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " when a user's password needs to be updated.\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\n- After receiving the OTP, include it as the " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " in your " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " call to finalize the password change." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Send reauthentication nonce\nSends a reauthentication nonce to the user's email or phone number." - } - ] - }, - { - "tag": "@example", - "name": "Send reauthentication nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.reauthenticate()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2497" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 410, - "name": "refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "signatures": [ - { - "id": 411, - "name": "refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method will refresh and return a new session whether the current one is expired or not." - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using the current session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession()\nconst { session, user } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Refresh session using the current session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using a refresh token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\nconst { session, user } = data\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "parameters": [ - { - "id": 412, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session. If passed in, it must contain a refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 414, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 688, - "name": "registerPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6325, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6325" - } - ], - "signatures": [ - { - "id": 689, - "name": "registerPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Register a passkey for the current authenticated user. Handles the full WebAuthn ceremony:\n1. Fetches registration challenge from server\n2. Prompts user via navigator.credentials.create()\n3. Verifies credential with server\n\nRequires an active session. Requires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6325, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6325" - } - ], - "parameters": [ - { - "id": 690, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1633, - "name": "RegisterPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 314, - "name": "resend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2593, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2593" - } - ], - "signatures": [ - { - "id": 315, - "name": "resend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Resends a signup confirmation, email change or phone change email to the user.\n- Passwordless sign-ins can be resent by calling the " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " method again.\n- Password recovery emails can be resent by calling the " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " method again.\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " again to resend the OTP).\n- You can specify a redirect url when you resend an email link using the " - }, - { - "kind": "code", - "text": "`emailRedirectTo`" - }, - { - "kind": "text", - "text": " option." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend an email signup confirmation\nResends the email signup confirmation to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend an email signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'signup',\n email: 'email@example.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend a phone signup confirmation\nResends the phone signup confirmation email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend a phone signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'sms',\n phone: '1234567890'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend email change email\nResends the email change email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend email change email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'email_change',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend phone change OTP\nResends the phone change OTP to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend phone change OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'phone_change',\n phone: '1234567890'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2593, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2593" - } - ], - "parameters": [ - { - "id": 316, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1093, - "name": "ResendParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 820, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 485, - "name": "resetPasswordForEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4253, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4253" - } - ], - "signatures": [ - { - "id": 486, - "name": "resetPasswordForEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a password reset request to an email address. This method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\n- The " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " only sends a password reset link to the user's email.\nTo update the user's password, see [" - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-updateuser).\n- A " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": " event will be emitted when the password recovery link is clicked.\nYou can use [" - }, - { - "kind": "code", - "text": "`onAuthStateChange()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\n- When the user clicks the reset link in the email they are redirected back to your application.\nYou can configure the URL that the user is redirected to with the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter.\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- After the user has been redirected successfully, prompt them for a new password and call " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": ":\n" - }, - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: new_password\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\n redirectTo: 'https://example.com/update-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Reset password\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {}\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password (React)", - "content": [ - { - "kind": "code", - "text": "```js\n/**\n * Step 1: Send the user an email to get a password reset token.\n * This email contains a link which sends the user back to your application.\n */\nconst { data, error } = await supabase.auth\n .resetPasswordForEmail('user@email.com')\n\n/**\n * Step 2: Once the user is redirected back to your application,\n * ask the user to reset their password.\n */\n useEffect(() => {\n supabase.auth.onAuthStateChange(async (event, session) => {\n if (event == \"PASSWORD_RECOVERY\") {\n const newPassword = prompt(\"What would you like your new password to be?\");\n const { data, error } = await supabase.auth\n .updateUser({ password: newPassword })\n\n if (data) alert(\"Password updated successfully!\")\n if (error) alert(\"There was an error updating your password.\")\n }\n })\n }, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4253, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4253" - } - ], - "parameters": [ - { - "id": 487, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 488, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 489, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 491, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4257, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4257" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 490, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to send the user to after they click the password reset link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4256, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4256" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [491, 490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4255, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4255" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 492, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 493, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4261, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4261" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 494, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 495, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4262, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4262" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [493, 495] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4260, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4260" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 496, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 497, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 498, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [497, 498] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 398, - "name": "setSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ], - "signatures": [ - { - "id": 399, - "name": "setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method sets the session using an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`refresh_token`" - }, - { - "kind": "text", - "text": ".\n- If successful, a " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event is emitted." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Set the session\nSets the session data from an access_token and refresh_token, then returns an auth response or error." - } - ] - }, - { - "tag": "@example", - "name": "Set the session", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.setSession({\n access_token,\n refresh_token\n })\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set the session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"11111111-1111-1111-1111-111111111111\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"2024-01-01T00:00:00Z\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"token_type\": \"bearer\",\n \"expires_in\": 3500,\n \"expires_at\": 1700000000\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ], - "parameters": [ - { - "id": 400, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session that minimally contains an access token and refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 401, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 402, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3421, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3421" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 403, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3422, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3422" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [402, 403] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 230, - "name": "signInAnonymously", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 722, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L722" - } - ], - "signatures": [ - { - "id": 231, - "name": "signInAnonymously", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new anonymous user." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A session where the is_anonymous claim in the access token JWT set to true" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Returns an anonymous user\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the " - }, - { - "kind": "code", - "text": "`options`" - }, - { - "kind": "text", - "text": " param." - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n captchaToken\n }\n});\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create an anonymous user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user with custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n data\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 722, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L722" - } - ], - "parameters": [ - { - "id": 232, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 957, - "name": "SignInAnonymouslyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 298, - "name": "signInWithIdToken", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2030, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2030" - } - ], - "signatures": [ - { - "id": 299, - "name": "signInWithIdToken", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use an ID token to sign in.\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API." - } - ] - }, - { - "tag": "@example", - "name": "Sign In using ID Token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithIdToken({\n provider: 'google',\n token: 'your-id-token'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign In using ID Token\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2030, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2030" - } - ], - "parameters": [ - { - "id": 300, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1007, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 239, - "name": "signInWithOAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1274" - } - ], - "signatures": [ - { - "id": 240, - "name": "signInWithOAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider with redirect\n- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter. This parameter defaults to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider with redirect", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n redirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with scopes and access provider tokens\nIf you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the " - }, - { - "kind": "code", - "text": "`scopes`" - }, - { - "kind": "text", - "text": " option takes in **a space-separated list** of scopes.\n\nBecause OAuth sign-in often includes redirects, you should register an " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback immediately after you create the Supabase client. This callback will listen for the presence of " - }, - { - "kind": "code", - "text": "`provider_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`provider_refresh_token`" - }, - { - "kind": "text", - "text": " properties on the " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with scopes and access provider tokens", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n\n// Call this on your Sign in with GitHub button to initiate OAuth\n// with GitHub with the requested elevated scopes.\nawait supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n scopes: 'repo gist notifications'\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1274" - } - ], - "parameters": [ - { - "id": 241, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 995, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 834, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 301, - "name": "signInWithOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2143" - } - ], - "signatures": [ - { - "id": 302, - "name": "signInWithOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " 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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email or phone number.\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\n- If the user doesn't exist, " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " will signup the user instead. To restrict this behavior, you can set " - }, - { - "kind": "code", - "text": "`shouldCreateUser`" - }, - { - "kind": "text", - "text": " in " - }, - { - "kind": "code", - "text": "`SignInWithPasswordlessCredentials.options`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ".\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\n- If you're using phone, you can configure whether you want the user to receive a OTP.\n- The magic link's destination URL is determined by the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": ".\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with email\nThe user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n email: 'example@email.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": null,\n \"session\": null\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with SMS OTP\nThe user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with SMS OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with WhatsApp OTP\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with WhatsApp OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n options: {\n channel:'whatsapp',\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2143" - } - ], - "parameters": [ - { - "id": 303, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 976, - "name": "SignInWithPasswordlessCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 820, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 685, - "name": "signInWithPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6267" - } - ], - "signatures": [ - { - "id": 686, - "name": "signInWithPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with a passkey. Handles the full WebAuthn ceremony:\n1. Fetches authentication challenge from server\n2. Prompts user via navigator.credentials.get()\n3. Verifies credential with server and creates session\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6267" - } - ], - "parameters": [ - { - "id": 687, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1627, - "name": "SignInWithPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 236, - "name": "signInWithPassword", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1135" - } - ], - "signatures": [ - { - "id": 237, - "name": "signInWithPassword", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user with an email and password or phone and password.\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\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email and password or a phone number and password." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email and password\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with phone and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n phone: '+13334445555',\n password: 'some-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nLog the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so fields like " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " aren't hidden. The " - }, - { - "kind": "code", - "text": "`error.code`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`'invalid_credentials'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'email_not_confirmed'`" - }, - { - "kind": "text", - "text": ") is often more useful for branching than " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": ", and the full object surfaces both." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\nif (error) {\n console.error(error)\n return\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1135" - } - ], - "parameters": [ - { - "id": 238, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 971, - "name": "SignInWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 829, - "name": "AuthTokenResponsePassword", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 307, - "name": "signInWithSSO", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2434, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2434" - } - ], - "signatures": [ - { - "id": 308, - "name": "signInWithSSO", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\n- If you've associated an email domain to the identity provider, you can use the " - }, - { - "kind": "code", - "text": "`domain`" - }, - { - "kind": "text", - "text": " property to start a sign-in flow.\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the " - }, - { - "kind": "code", - "text": "`providerId`" - }, - { - "kind": "text", - "text": " property. For example:\n - Mapping specific user email addresses with an identity provider.\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email domain", - "content": [ - { - "kind": "code", - "text": "```js\n // You can extract the user's email domain and use it to trigger the\n // authentication flow with the correct identity provider.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n domain: 'company.com'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with provider UUID", - "content": [ - { - "kind": "code", - "text": "```js\n // Useful when you need to map a user's sign in request according\n // to different rules that can't use email domains.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2434, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2434" - } - ], - "parameters": [ - { - "id": 309, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1107, - "name": "SignInWithSSO", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 847, - "name": "SSOResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 245, - "name": "signInWithWeb3", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1554, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1554" - } - ], - "signatures": [ - { - "id": 246, - "name": "signInWithWeb3", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." - } - ], - "blockTags": [ - { - "tag": "@reference", - "content": [ - { - "kind": "text", - "text": "https://eips.ethereum.org/EIPS/eip-4361" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana or Ethereum (Window API)", - "content": [ - { - "kind": "code", - "text": "```js\n // uses window.ethereum for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n\n // uses window.solana for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Ethereum (Message and Signature)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n message: '',\n signature: '',\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Brave)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet: window.braveSolana\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Wallet Adapter)", - "content": [ - { - "kind": "code", - "text": "```jsx\n function SignInButton() {\n const wallet = useWallet()\n\n return (\n <>\n {wallet.connected ? (\n {\n supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet,\n })\n }}\n >\n Sign in with Solana\n \n ) : (\n \n )}\n \n )\n}\n\nfunction App() {\n const endpoint = clusterApiUrl('devnet')\n const wallets = useMemo(() => [], [])\n\n return (\n \n \n \n \n \n \n \n )\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1554, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1554" - } - ], - "parameters": [ - { - "id": 247, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1068, - "name": "Web3Credentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 248, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 249, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 250, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 251, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 252, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [251, 252] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ] - } - } - }, - { - "id": 253, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1557, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1557" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [249, 253] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1555, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1555" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 254, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 255, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 256, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 257, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 258, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [257, 258] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ] - } - } - }, - { - "id": 259, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [255, 259] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 451, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "signatures": [ - { - "id": 452, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inside a browser context, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " - }, - { - "kind": "code", - "text": "`\"SIGNED_OUT\"`" - }, - { - "kind": "text", - "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " - }, - { - "kind": "code", - "text": "`auth.api.signOut(JWT: string)`" - }, - { - "kind": "text", - "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " - }, - { - "kind": "code", - "text": "`others`" - }, - { - "kind": "text", - "text": " scope, no " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event is fired!\n\n**Warning:** the default " - }, - { - "kind": "code", - "text": "`scope`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`'global'`" - }, - { - "kind": "text", - "text": ". This signs the user out of\n**every device they are currently signed in on**, not just the current\ntab/session. If you only want to sign the user out of the current session\n(the behavior most other auth libraries default to), pass\n" - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " explicitly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " uses the **global** scope, which signs out the user\n on every device they are signed in on (not just the current one). Pass\n " - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " to only sign out the current session. This is\n usually what apps want on a \"Sign out\" button, especially when users\n sign in from multiple devices and do not expect signing out of one to\n terminate the others.\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires." - } - ] - }, - { - "tag": "@example", - "name": "Sign out of every device (global – default)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out only the current session (recommended for most apps)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out of all other sessions, keep the current one", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "parameters": [ - { - "id": 453, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1304, - "name": "SignOut", - "package": "@supabase/auth-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 455, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [455] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 65, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 233, - "name": "signUp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 932, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L932" - } - ], - "signatures": [ - { - "id": 234, - "name": "signUp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A logged-in session if the server has \"autoconfirm\" ON" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A user if the server has \"autoconfirm\" OFF" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\n- **Confirm email** determines if users need to confirm their email address after signing up.\n - If **Confirm email** is enabled, a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " is returned but " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " is null.\n - If **Confirm email** is disabled, both a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " and a " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " are returned.\n- When the user confirms their email address, they are redirected to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your " - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": " or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\n- If signUp() is called for an existing confirmed user:\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, " - }, - { - "kind": "code", - "text": "`User already registered`" - }, - { - "kind": "text", - "text": " is returned.\n- To fetch the currently logged-in user, refer to [" - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-getuser)." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with an email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign up with an email and password\n" - }, - { - "kind": "code", - "text": "```json\n// Some fields may be null if \"confirm email\" is enabled.\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (SMS)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'sms'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a phone number and password (whatsapp)\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (whatsapp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'whatsapp'\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with additional user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n data: {\n first_name: 'John',\n age: 27,\n }\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a redirect URL\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a redirect URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 932, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L932" - } - ], - "parameters": [ - { - "id": 235, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 963, - "name": "SignUpWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 575, - "name": "startAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5119, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5119" - } - ], - "signatures": [ - { - "id": 576, - "name": "startAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClientOptions#autoRefreshToken", - "target": 764 - }, - { - "kind": "text", - "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "#stopAutoRefresh" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- To give this hint to the application, you should be calling this method when the app is in focus and calling " - }, - { - "kind": "code", - "text": "`supabase.auth.stopAutoRefresh()`" - }, - { - "kind": "text", - "text": " when it's out of focus." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5119, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5119" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 577, - "name": "stopAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5154, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5154" - } - ], - "signatures": [ - { - "id": 578, - "name": "stopAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#startAutoRefresh" - }, - { - "kind": "text", - "text": " for more details." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5154, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5154" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 520, - "name": "unlinkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4516, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4516" - } - ], - "signatures": [ - { - "id": 521, - "name": "unlinkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`unlinkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- The user must have at least 2 identities in order to unlink an identity.\n- The identity to be unlinked must belong to the user." - } - ] - }, - { - "tag": "@example", - "name": "Unlink an identity", - "content": [ - { - "kind": "code", - "text": "```js\n// retrieve all identities linked to a user\nconst identities = await supabase.auth.getUserIdentities()\n\n// find the google identity\nconst googleIdentity = identities.find(\n identity => identity.provider === 'google'\n)\n\n// unlink the google identity\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4516, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4516" - } - ], - "parameters": [ - { - "id": 522, - "name": "identity", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 524, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4518, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4518" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 525, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 526, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4519, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4519" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [524, 526] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4517, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4517" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 528, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 529, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [528, 529] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 386, - "name": "updateUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3224, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3224" - } - ], - "signatures": [ - { - "id": 387, - "name": "updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates user data for a logged in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, email updates sends a confirmation link to both the user's current and new email.\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers)." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\nSends a \"Confirm Email Change\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email)." - } - ] - }, - { - "tag": "@example", - "name": "Update the email for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n email: 'new@email.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"new_email\": \"new@email.com\",\n \"email_change_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the phone number for an authenticated user\nSends a one-time password (OTP) to the new phone number." - } - ] - }, - { - "tag": "@example", - "name": "Update the phone number for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n phone: '123456789'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update the password for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's metadata\nUpdates the user's custom metadata.\n\n**Note**: The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column in your Supabase database. When calling " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": ", the data will be available as " - }, - { - "kind": "code", - "text": "`user.user_metadata`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n data: { hello: 'world' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's password with a nonce\nIf **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's password with a nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password',\n nonce: '123456'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3224, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3224" - } - ], - "parameters": [ - { - "id": 388, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 926, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 389, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 391, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3227, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [391] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3226, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3226" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 304, - "name": "verifyOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2334" - } - ], - "signatures": [ - { - "id": 305, - "name": "verifyOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " method takes in different verification types.\n- If a phone number is used, the type can either be:\n 1. " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new phone number during a phone number update process.\n- If an email address is used, the type can be one of the following (note: " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": " types are deprecated):\n 1. " - }, - { - "kind": "code", - "text": "`email`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent for account recovery, typically after a password reset request.\n 3. " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent as part of an invitation to join a project or organization.\n 4. " - }, - { - "kind": "code", - "text": "`email_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new email address during an email update process.\n- The verification type used should be determined based on the corresponding auth method called before " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " to sign up / sign-in a user.\n- The " - }, - { - "kind": "code", - "text": "`TokenHash`" - }, - { - "kind": "text", - "text": " is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details." - } - ] - }, - { - "tag": "@example", - "name": "Verify Signup One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify Signup One-Time Password (OTP)\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify SMS One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify Email Auth (Token Hash)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2334" - } - ], - "parameters": [ - { - "id": 306, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1069, - "name": "VerifyOtpParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [138] - }, - { - "title": "Properties", - "children": [142, 143, 144, 145] - }, - { - "title": "Methods", - "children": [ - 579, 242, 662, 317, 380, 499, 226, 213, 509, 461, 310, 410, 688, 314, 485, 398, 230, - 298, 239, 301, 685, 236, 307, 245, 451, 233, 575, 577, 520, 386, 304 - ] - } - ], - "categories": [ - { - "title": "Auth", - "children": [ - 579, 242, 662, 317, 380, 499, 226, 509, 461, 310, 410, 688, 314, 485, 398, 230, 298, - 239, 301, 685, 236, 307, 245, 451, 233, 575, 577, 520, 386, 304 - ] - }, - { - "title": "Other", - "children": [138, 142, 143, 144, 145, 213] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 225, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L225" - } - ] - }, - { - "id": 720, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client doesn't call " - }, - { - "kind": "code", - "text": "`navigator.locks`" - }, - { - "kind": "text", - "text": ", so this error\nnever originates from " - }, - { - "kind": "code", - "text": "`supabase.auth.*`" - }, - { - "kind": "text", - "text": " calls. Direct callers of\n" - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " still receive it on acquire timeout." - } - ] - } - ] - }, - "children": [ - { - "id": 721, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L39" - } - ], - "signatures": [ - { - "id": 722, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L39" - } - ], - "parameters": [ - { - "id": 723, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 720, - "name": "NavigatorLockAcquireTimeoutError", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - }, - { - "id": 724, - "name": "isAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true, - "isReadonly": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L37" - } - ], - "type": { - "type": "literal", - "value": true - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.isAcquireTimeout" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [721] - }, - { - "title": "Properties", - "children": [724] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 49, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L49" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError" - }, - "name": "LockAcquireTimeoutError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 933, - "name": "AdminUserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 935, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's application specific metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.app_metadata`" - }, - { - "kind": "text", - "text": " column.\n\nOnly a service role can modify.\n\nThe " - }, - { - "kind": "code", - "text": "`app_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 544, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L544" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 938, - "name": "ban_duration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L570" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 946, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.current_password" - } - }, - { - "id": 944, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 495, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L495" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.email" - } - }, - { - "id": 936, - "name": "email_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's email as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L551" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 941, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " for the user.\n\nAllows you to overwrite the default " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " set for the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 595, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L595" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 942, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.nonce" - } - }, - { - "id": 945, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 505, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L505" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.password" - } - }, - { - "id": 940, - "name": "password_hash", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`password_hash`" - }, - { - "kind": "text", - "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 588, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L588" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 943, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L500" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.phone" - } - }, - { - "id": 937, - "name": "phone_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's phone as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 558, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L558" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 939, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " - }, - { - "kind": "code", - "text": "`authenticated`" - }, - { - "kind": "text", - "text": " by default. You should only modify the " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " is not recommended as it grants the user admin privileges." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 579, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L579" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 934, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\n\nThe " - }, - { - "kind": "code", - "text": "`user_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 534, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L534" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [935, 938, 946, 944, 936, 941, 942, 945, 940, 943, 937, 939, 934] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 523, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L523" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 926, - "name": "UserAttributes", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "data" - } - ], - "name": "Omit", - "package": "typescript" - } - ] - }, - { - "id": 864, - "name": "AMREntry", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An authentication method reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time.\n\nNote: Custom access token hooks can return AMR claims as either:\n- An array of AMREntry objects (detailed format with timestamps)\n- An array of strings (RFC-8176 compliant format)" - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 1262 - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "children": [ - { - "id": 865, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication method name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 369, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L369" - } - ], - "type": { - "type": "reference", - "target": 862, - "name": "AMRMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 866, - "name": "timestamp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 375, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L375" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [865, 866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 367, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L367" - } - ] - }, - { - "id": 1575, - "name": "AuthOAuthServerApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth 2.1 authorization server user-facing methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThese methods are used to implement the consent page." - } - ] - }, - "children": [ - { - "id": 1579, - "name": "approveAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2633, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2633" - } - ], - "signatures": [ - { - "id": 1580, - "name": "approveAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Approves an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter approval, the user's consent is stored and an authorization code is generated.\nThe response contains a complete redirect URL with the authorization code and state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with authorization code" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2633, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2633" - } - ], - "parameters": [ - { - "id": 1581, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to approve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1582, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1583, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1584, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2635, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2635" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1584] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2635, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2635" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1566, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1585, - "name": "denyAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2653" - } - ], - "signatures": [ - { - "id": 1586, - "name": "denyAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Denies an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter denial, the response contains a redirect URL with an OAuth error\n(access_denied) to inform the OAuth client that the user rejected the request." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with error information" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2653" - } - ], - "parameters": [ - { - "id": 1587, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to deny" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1588, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1589, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1590, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2655, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2655" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1590] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2655, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2655" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1566, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1576, - "name": "getAuthorizationDetails", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2616" - } - ], - "signatures": [ - { - "id": 1577, - "name": "getAuthorizationDetails", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves details about an OAuth authorization request.\nUsed to display consent information to the user.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis method returns one of two response types:\n- " - }, - { - "kind": "code", - "text": "`OAuthAuthorizationDetails`" - }, - { - "kind": "text", - "text": ": User needs to consent - show consent page with client info\n- " - }, - { - "kind": "code", - "text": "`OAuthRedirect`" - }, - { - "kind": "text", - "text": ": User already consented - redirect immediately to the OAuth client\n\nUse type narrowing to distinguish between the responses:\n" - }, - { - "kind": "code", - "text": "```typescript\nif ('authorization_id' in data) {\n // Show consent page\n} else {\n // Redirect to data.redirect_url\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Authorization details or redirect URL depending on consent status" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2616" - } - ], - "parameters": [ - { - "id": 1578, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID from the authorization request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "AuthOAuthAuthorizationDetailsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1591, - "name": "listGrants", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2667" - } - ], - "signatures": [ - { - "id": 1592, - "name": "listGrants", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth grants that the authenticated user has authorized.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Response with array of OAuth grants with client information and granted scopes" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2667" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1572, - "name": "AuthOAuthGrantsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1593, - "name": "revokeGrant", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "signatures": [ - { - "id": 1594, - "name": "revokeGrant", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revokes a user's OAuth grant for a specific client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\nand invalidates associated refresh tokens." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Empty response on successful revocation" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "parameters": [ - { - "id": 1595, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revocation options" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1597, - "name": "clientId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client identifier (UUID) to revoke access for" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1597] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1573, - "name": "AuthOAuthRevokeGrantResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1579, 1585, 1576, 1591, 1593] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1579, 1585, 1576, 1591, 1593] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2591, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2591" - } - ] - }, - { - "id": 1675, - "name": "AuthPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lower-level two-step API and management methods for passkeys.\nAccess via " - }, - { - "kind": "code", - "text": "`supabase.auth.passkey`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "children": [ - { - "id": 1692, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2883, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2883" - } - ], - "signatures": [ - { - "id": 1693, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a passkey for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2883, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2883" - } - ], - "parameters": [ - { - "id": 1694, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1655, - "name": "PasskeyDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1667, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1687, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2867, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2867" - } - ], - "signatures": [ - { - "id": 1688, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2867, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2867" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1665, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1681, - "name": "startAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2845, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2845" - } - ], - "signatures": [ - { - "id": 1682, - "name": "startAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey authentication ceremony. Fetches an authentication\nchallenge and credential request options from the server. Used as the\nfirst step of a two-step sign-in flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.get()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2845, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2845" - } - ], - "parameters": [ - { - "id": 1683, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1642, - "name": "StartPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1660, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1676, - "name": "startRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2822, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2822" - } - ], - "signatures": [ - { - "id": 1677, - "name": "startRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey registration ceremony. Fetches a registration challenge\nand credential creation options from the server. Used as the first step of\na two-step registration flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.create()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2822, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2822" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1658, - "name": "AuthPasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1689, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2875, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2875" - } - ], - "signatures": [ - { - "id": 1690, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a passkey's friendly name." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2875, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2875" - } - ], - "parameters": [ - { - "id": 1691, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1651, - "name": "PasskeyUpdateParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1666, - "name": "AuthPasskeyUpdateResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1684, - "name": "verifyAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2856, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2856" - } - ], - "signatures": [ - { - "id": 1685, - "name": "verifyAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey authentication credential against a previously issued\nchallenge. Used as the second step of a two-step sign-in flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2856, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2856" - } - ], - "parameters": [ - { - "id": 1686, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1647, - "name": "VerifyPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1678, - "name": "verifyRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2831, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2831" - } - ], - "signatures": [ - { - "id": 1679, - "name": "verifyRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey registration credential against a previously issued\nchallenge. Used as the second step of a two-step registration flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2831, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2831" - } - ], - "parameters": [ - { - "id": 1680, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1638, - "name": "VerifyPasskeyRegistrationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1692, 1687, 1681, 1676, 1689, 1684, 1678] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1692, 1687, 1681, 1676, 1689, 1684, 1678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2811, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2811" - } - ] - }, - { - "id": 1144, - "name": "GenerateLinkOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1145, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 954, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L954" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1146, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 956, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L956" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1145, 1146] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 948, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L948" - } - ] - }, - { - "id": 1526, - "name": "GoTrueAdminCustomProvidersApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "children": [ - { - "id": 1530, - "name": "createProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2425" - } - ], - "signatures": [ - { - "id": 1531, - "name": "createProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new custom OIDC/OAuth provider.\n\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\nfrom the issuer's well-known endpoint (or the provided " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": ") at creation time.\nThis may return a validation error (" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\nin the document does not match the expected issuer.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2425" - } - ], - "parameters": [ - { - "id": 1532, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1471, - "name": "CreateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1540, - "name": "deleteProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "signatures": [ - { - "id": 1541, - "name": "deleteProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a custom provider.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "parameters": [ - { - "id": 1542, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1543, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1544, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1545, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 60, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1544, 1545] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1533, - "name": "getProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2435" - } - ], - "signatures": [ - { - "id": 1534, - "name": "getProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific custom provider by identifier.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2435" - } - ], - "parameters": [ - { - "id": 1535, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1527, - "name": "listProviders", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2409" - } - ], - "signatures": [ - { - "id": 1528, - "name": "listProviders", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all custom providers with optional type filter.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2409" - } - ], - "parameters": [ - { - "id": 1529, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1511, - "name": "ListCustomProvidersParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1515, - "name": "CustomProviderListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1536, - "name": "updateProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2450" - } - ], - "signatures": [ - { - "id": 1537, - "name": "updateProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing custom provider.\n\nWhen " - }, - { - "kind": "code", - "text": "`issuer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": " is changed on an OIDC provider, the server re-fetches and\nvalidates the discovery document before persisting. This may return a validation error\n(" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery document is unreachable, invalid, or\nthe issuer does not match.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2450" - } - ], - "parameters": [ - { - "id": 1538, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1539, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1492, - "name": "UpdateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1530, 1540, 1533, 1527, 1536] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1530, 1540, 1533, 1527, 1536] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2400, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2400" - } - ] - }, - { - "id": 1279, - "name": "GoTrueAdminMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication administration API." - } - ], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "children": [ - { - "id": 1283, - "name": "deleteFactor", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1795, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1795" - } - ], - "signatures": [ - { - "id": 1284, - "name": "deleteFactor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#unenroll", - "target": 1254 - } - ] - }, - { - "tag": "@expermental", - "content": [] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Delete a factor for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a factor for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1795, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1795" - } - ], - "parameters": [ - { - "id": 1285, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1269, - "name": "AuthMFAAdminDeleteFactorParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1266, - "name": "AuthMFAAdminDeleteFactorResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1280, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1764, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1764" - } - ], - "signatures": [ - { - "id": 1281, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all factors associated to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "List all factors for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "List all factors for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n factors: Factor[\n {\n id: '',\n friendly_name: 'Auth App Factor',\n factor_type: 'totp',\n status: 'verified',\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z'\n }\n ]\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1764, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1764" - } - ], - "parameters": [ - { - "id": 1282, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1276, - "name": "AuthMFAAdminListFactorsParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1273, - "name": "AuthMFAAdminListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1283, 1280] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1283, 1280] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1732, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1732" - } - ] - }, - { - "id": 1411, - "name": "GoTrueAdminOAuthApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "children": [ - { - "id": 1415, - "name": "createClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2155" - } - ], - "signatures": [ - { - "id": 1416, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2155" - } - ], - "parameters": [ - { - "id": 1417, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1381, - "name": "CreateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1425, - "name": "deleteClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "signatures": [ - { - "id": 1426, - "name": "deleteClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "parameters": [ - { - "id": 1427, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1428, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1429, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1430, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1429, 1430] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1418, - "name": "getClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2166" - } - ], - "signatures": [ - { - "id": 1419, - "name": "getClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2166" - } - ], - "parameters": [ - { - "id": 1420, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1412, - "name": "listClients", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2144" - } - ], - "signatures": [ - { - "id": 1413, - "name": "listClients", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth clients with optional pagination.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2144" - } - ], - "parameters": [ - { - "id": 1414, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1300, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1399, - "name": "OAuthClientListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1431, - "name": "regenerateClientSecret", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2199" - } - ], - "signatures": [ - { - "id": 1432, - "name": "regenerateClientSecret", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Regenerates the secret for an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2199" - } - ], - "parameters": [ - { - "id": 1433, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1421, - "name": "updateClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2177" - } - ], - "signatures": [ - { - "id": 1422, - "name": "updateClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2177" - } - ], - "parameters": [ - { - "id": 1423, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1424, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1390, - "name": "UpdateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1415, 1425, 1418, 1412, 1431, 1421] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1415, 1425, 1418, 1412, 1431, 1421] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2134, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2134" - } - ] - }, - { - "id": 1695, - "name": "GoTrueAdminPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1699, - "name": "deletePasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2905" - } - ], - "signatures": [ - { - "id": 1700, - "name": "deletePasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a specific passkey for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2905" - } - ], - "parameters": [ - { - "id": 1701, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1671, - "name": "AuthPasskeyAdminDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1667, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1696, - "name": "listPasskeys", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2895" - } - ], - "signatures": [ - { - "id": 1697, - "name": "listPasskeys", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2895" - } - ], - "parameters": [ - { - "id": 1698, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1668, - "name": "AuthPasskeyAdminListParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1665, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1699, 1696] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1699, 1696] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2886, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2886" - } - ] - }, - { - "id": 1208, - "name": "GoTrueMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication API." - } - ] - }, - "children": [ - { - "id": 1265, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1690" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "WebAuthnApi" - }, - "name": "WebAuthnApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1218, - "name": "challenge", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1423" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1424" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1425" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1426" - } - ], - "signatures": [ - { - "id": 1219, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- A phone factor sends a code to the user upon challenge. The channel defaults to " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " unless otherwise specified." - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor (WhatsApp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n channel: 'whatsapp',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor (WhatsApp)\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1423" - } - ], - "parameters": [ - { - "id": 1220, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1221, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1222, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1223, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1222, 1223] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1224, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1225, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1226, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1225, 1226] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1227, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1424" - } - ], - "parameters": [ - { - "id": 1228, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1175, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1229, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1230, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1231, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1230, 1231] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1232, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1233, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1234, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1233, 1234] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1235, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1425" - } - ], - "parameters": [ - { - "id": 1236, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1176, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1237, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1238, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1239, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1238, 1239] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1240, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1241, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1242, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1241, 1242] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1243, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1426" - } - ], - "parameters": [ - { - "id": 1244, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1177, - "name": "MFAChallengeParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1196, - "name": "AuthMFAChallengeResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1257, - "name": "challengeAndVerify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1618" - } - ], - "signatures": [ - { - "id": 1258, - "name": "challengeAndVerify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Intended for use with only TOTP factors.\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking " - }, - { - "kind": "code", - "text": "`challengeAndVerify()`" - }, - { - "kind": "text", - "text": ".\n- Executes [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge) and [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify) in a single step." - } - ] - }, - { - "tag": "@example", - "name": "Create and verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create and verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1618" - } - ], - "parameters": [ - { - "id": 1259, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1209, - "name": "enroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1349, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1349" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1350" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1351" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1352" - } - ], - "signatures": [ - { - "id": 1210, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " as the " - }, - { - "kind": "code", - "text": "`factorType`" - }, - { - "kind": "text", - "text": " and use the returned " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " to create a challenge.\n- To create a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge).\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- To create and verify a TOTP challenge in a single step, see [" - }, - { - "kind": "code", - "text": "`mfa.challengeAndVerify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challengeandverify).\n- To generate a QR code for the " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " secret in Next.js, you can do the following:\n" - }, - { - "kind": "code", - "text": "```html\n{data.totp.uri}\n```" - }, - { - "kind": "text", - "text": "\n- The " - }, - { - "kind": "code", - "text": "`challenge`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`verify`" - }, - { - "kind": "text", - "text": " steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge." - } - ] - }, - { - "tag": "@example", - "name": "Enroll a time-based, one-time password (TOTP) factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'totp',\n friendlyName: 'your_friendly_name'\n})\n\n// Use the id to create a challenge.\n// The challenge can be verified by entering the code generated from the authenticator app.\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a time-based, one-time password (TOTP) factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp'\n totp: {\n qr_code: '',\n secret: '',\n uri: '',\n }\n friendly_name?: 'Important app'\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Enroll a Phone Factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'phone',\n friendlyName: 'your_friendly_name',\n phone: '+12345678',\n})\n\n// Use the id to create a challenge and send an SMS with a code to the user.\nconst { id, type, friendly_name, phone } = data\n\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a Phone Factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n friendly_name?: 'Important app',\n phone: '+5787123456'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1349, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1349" - } - ], - "parameters": [ - { - "id": 1211, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1307, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1212, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1350" - } - ], - "parameters": [ - { - "id": 1213, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1308, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1214, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1351" - } - ], - "parameters": [ - { - "id": 1215, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1216, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1352" - } - ], - "parameters": [ - { - "id": 1217, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1160, - "name": "MFAEnrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1187, - "name": "AuthMFAEnrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1262, - "name": "getAuthenticatorAssuranceLevel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1685, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1685" - } - ], - "signatures": [ - { - "id": 1263, - "name": "getAuthenticatorAssuranceLevel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " (or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\nand rarely uses the network. When a JWT is provided (useful in server-side\nenvironments like Edge Functions where no session is stored), this method\nwill make a network request to validate the user and fetch their MFA factors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\n- In Supabase, having an AAL of " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\n- If the user has a verified factor, the " - }, - { - "kind": "code", - "text": "`nextLevel`" - }, - { - "kind": "text", - "text": " field will return " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": ", else, it will return " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": ".\n- An optional " - }, - { - "kind": "code", - "text": "`jwt`" - }, - { - "kind": "text", - "text": " parameter can be passed to check the AAL level of a specific JWT instead of the current session." - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details of a session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the AAL details of a session\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n currentLevel: 'aal1',\n nextLevel: 'aal2',\n currentAuthenticationMethods: [\n {\n method: 'password',\n timestamp: 1700000000\n }\n ]\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details for a specific JWT", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1685, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1685" - } - ], - "parameters": [ - { - "id": 1264, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1203, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1260, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1631, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1631" - } - ], - "signatures": [ - { - "id": 1261, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the list of MFA factors enabled for this user." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 1209 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 1262 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient#getUser", - "target": 380 - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1631, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1631" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1197, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - } - } - ], - "name": "AuthMFAListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1254, - "name": "unenroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1536" - } - ], - "signatures": [ - { - "id": 1255, - "name": "unenroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unenroll removes a MFA factor.\nA user has to have an " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " authenticator level in order to unenroll a " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " factor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@example", - "name": "Unenroll a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.unenroll({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Unenroll a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: ''\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1536" - } - ], - "parameters": [ - { - "id": 1256, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1161, - "name": "MFAUnenrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1188, - "name": "AuthMFAUnenrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1245, - "name": "verify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1507" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1508, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1508" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1509, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1509" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1510, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1510" - } - ], - "signatures": [ - { - "id": 1246, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first." - } - ] - }, - { - "tag": "@example", - "name": "Verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.verify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1507" - } - ], - "parameters": [ - { - "id": 1247, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1164, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1248, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1508, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1508" - } - ], - "parameters": [ - { - "id": 1249, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1165, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1250, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1509, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1509" - } - ], - "parameters": [ - { - "id": 1251, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1170, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1252, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1510, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1510" - } - ], - "parameters": [ - { - "id": 1253, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1172, - "name": "MFAVerifyParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [1265] - }, - { - "title": "Methods", - "children": [1218, 1257, 1209, 1262, 1260, 1254, 1245] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1218, 1257, 1209, 1262, 1260, 1254, 1245] - }, - { - "title": "Other", - "children": [1265] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1267, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1267" - } - ] - }, - { - "id": 1349, - "name": "JWK", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1353, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1993, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1993" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1352, - "name": "key_ops", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1992, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1992" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1354, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1994, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1994" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1350, - "name": "kty", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1991, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1991" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1351, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1353, 1352, 1354, 1350] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1990, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1990" - } - ], - "indexSignatures": [ - { - "id": 1355, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1995, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1995" - } - ], - "parameters": [ - { - "id": 1356, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1329, - "name": "JwtPayload", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWT Payload containing claims for Supabase authentication tokens.\n\nRequired claims (iss, aud, exp, iat, sub, role, aal, session_id) are inherited from RequiredClaims.\nAll other claims are optional as they can be customized via Custom Access Token Hooks." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://supabase.com/docs/guides/auth/jwt-fields" - } - ] - } - ] - }, - "children": [ - { - "id": 1345, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1952, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1952" - } - ], - "type": { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aal" - } - }, - { - "id": 1337, - "name": "amr", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication Method References.\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1981, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1981" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 864, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - } - ] - } - }, - { - "id": 1335, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1973, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1973" - } - ], - "type": { - "type": "reference", - "target": 891, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 1341, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1948, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1948" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aud" - } - }, - { - "id": 1330, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1966, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1966" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1342, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1949, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1949" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.exp" - } - }, - { - "id": 1343, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1950, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1950" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iat" - } - }, - { - "id": 1332, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1968, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1968" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1339, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1946, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1946" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iss" - } - }, - { - "id": 1333, - "name": "jti", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1971" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1334, - "name": "nbf", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1972, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1972" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1331, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1967" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1338, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1984, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1984" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1344, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1951, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1951" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.role" - } - }, - { - "id": 1346, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1953, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1953" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.session_id" - } - }, - { - "id": 1340, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1947" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.sub" - } - }, - { - "id": 1336, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1974, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1974" - } - ], - "type": { - "type": "reference", - "target": 896, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1345, 1337, 1335, 1341, 1330, 1342, 1343, 1332, 1339, 1333, 1334, 1331, 1338, 1344, - 1346, 1340, 1336 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1964, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1964" - } - ], - "indexSignatures": [ - { - "id": 1347, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1987, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1987" - } - ], - "parameters": [ - { - "id": 1348, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1319, - "name": "RequiredClaims", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 853, - "name": "Session", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 856, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 317, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L317" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 859, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 329, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L329" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 858, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 325, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L325" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 855, - "name": "provider_refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 313, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L313" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 854, - "name": "provider_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 857, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A one-time used refresh token that never expires." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L321" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 860, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 330, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L330" - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 861, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When using a separate user storage, accessing properties of this object will throw an error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 335, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L335" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [856, 859, 858, 855, 854, 857, 860, 861] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 304, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L304" - } - ] - }, - { - "id": 947, - "name": "Subscription", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 949, - "name": "callback", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to call every time there is an event. eg: (eventName) => {}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 950, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "signatures": [ - { - "id": 951, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "parameters": [ - { - "id": 952, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 953, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 948, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for this subscription, set by the client.\nThis is an internal identifier used for managing callbacks and should not be\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 604, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L604" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 954, - "name": "unsubscribe", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Call this to remove the listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 955, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "signatures": [ - { - "id": 956, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [949, 948, 954] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 598, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L598" - } - ] - }, - { - "id": 899, - "name": "User", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 910, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 464, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L464" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 901, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 455, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L455" - } - ], - "type": { - "type": "reference", - "target": 891, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 903, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 457, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L457" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 925, - "name": "banned_until", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 479, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L479" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 904, - "name": "confirmation_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L458" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 914, - "name": "confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L468" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 913, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 467, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L467" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 924, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 911, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L465" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 906, - "name": "email_change_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 460, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L460" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 915, - "name": "email_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L469" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 923, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 477, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - { - "type": "literal", - "value": "unverified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - ] - } - } - }, - { - "id": 900, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 454, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L454" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 920, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 474, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L474" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 909, - "name": "invited_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L463" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 921, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 475, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L475" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 922, - "name": "is_sso_user", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 476, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L476" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 917, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 471, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L471" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 907, - "name": "new_email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L461" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 908, - "name": "new_phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L462" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 912, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 466, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L466" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "phone_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L470" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 905, - "name": "recovery_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 459, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L459" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 918, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L472" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 919, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L473" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 902, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L456" - } - ], - "type": { - "type": "reference", - "target": 896, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 910, 901, 903, 925, 904, 914, 913, 924, 911, 906, 915, 923, 900, 920, 909, 921, 922, - 917, 907, 908, 912, 916, 905, 918, 919, 902 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 453, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L453" - } - ] - }, - { - "id": 891, - "name": "UserAppMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 892, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The first provider that the user used to sign up with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 441, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L441" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 893, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all providers that the user has linked to their account." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 445, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L445" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [892, 893] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 437, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L437" - } - ], - "indexSignatures": [ - { - "id": 894, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 446, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L446" - } - ], - "parameters": [ - { - "id": 895, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 926, - "name": "UserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 927, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 932, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 520, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L520" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 928, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 495, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L495" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 931, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 930, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 505, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L505" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 929, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L500" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [927, 932, 928, 931, 930, 929] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 482, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L482" - } - ] - }, - { - "id": 867, - "name": "UserIdentity", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 876, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 386, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L386" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 868, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 379, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L379" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 870, - "name": "identity_data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 381, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L381" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 381, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L381" - } - ], - "indexSignatures": [ - { - "id": 872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 382, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L382" - } - ], - "parameters": [ - { - "id": 873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 874, - "name": "identity_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 384, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L384" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 877, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 387, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L387" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 875, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 385, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 878, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L388" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 869, - "name": "user_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 380, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [876, 868, 870, 874, 877, 875, 878, 869] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 378, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L378" - } - ] - }, - { - "id": 896, - "name": "UserMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 449, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L449" - } - ], - "indexSignatures": [ - { - "id": 897, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L450" - } - ], - "parameters": [ - { - "id": 898, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1078, - "name": "VerifyEmailOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1079, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 825, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L825" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1082, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 830, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L830" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1083, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1085, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 838, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L838" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1084, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 832, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L832" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1085, 1084] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 830, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L830" - } - ] - } - } - }, - { - "id": 1080, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 827, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L827" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1081, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 829, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L829" - } - ], - "type": { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1079, 1082, 1080, 1081] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 823, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L823" - } - ] - }, - { - "id": 1070, - "name": "VerifyMobileOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1074, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 811, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L811" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1075, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1077, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 820, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L820" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1076, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 813, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L813" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1077, 1076] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 811, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L811" - } - ] - } - } - }, - { - "id": 1071, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 806, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L806" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1072, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 808, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L808" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1073, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 810, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L810" - } - ], - "type": { - "type": "reference", - "target": 1089, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1074, 1071, 1072, 1073] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 804, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L804" - } - ] - }, - { - "id": 1086, - "name": "VerifyTokenHashParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1087, - "name": "token_hash", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token hash used in an email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 844, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L844" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1088, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 847, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L847" - } - ], - "type": { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1087, 1088] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 842, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L842" - } - ] - }, - { - "id": 862, - "name": "AMRMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 353, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L353" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMRMethods" - }, - "name": "AMRMethods", - "package": "@supabase/auth-js", - "preferValues": true - } - } - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 353, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L353" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 738, - "name": "AuthChangeEvent", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 54, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L54" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "reference", - "target": 737, - "name": "AuthChangeEventMFA", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 737, - "name": "AuthChangeEventMFA", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 52, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L52" - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 1201, - "name": "AuthenticatorAssuranceLevels", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1237, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1237" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1202, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1237, - "character": 71, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1237" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 993, - "name": "AuthFlowType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 685, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L685" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 994, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 685, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L685" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1269, - "name": "AuthMFAAdminDeleteFactorParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1703, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1703" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1270, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1271, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the MFA factor to delete." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1272, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user whose factor is being deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1708" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1271, 1272] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1703, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1703" - } - ] - } - } - }, - { - "id": 1266, - "name": "AuthMFAAdminDeleteFactorResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1696, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1696" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1267, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1268, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1698, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1698" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1268] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1696, - "character": 61, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1696" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1276, - "name": "AuthMFAAdminListFactorsParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1722, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1277, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1278, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1724, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1724" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1278] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1722, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1722" - } - ] - } - } - }, - { - "id": 1273, - "name": "AuthMFAAdminListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1714, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1714" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1274, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1275, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All factors attached to the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1716, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1716" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1275] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1714, - "character": 60, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1714" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1192, - "name": "AuthMFAChallengePhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1168, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1168" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponseFields" - }, - "name": "AuthMFAChallengePhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1196, - "name": "AuthMFAChallengeResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1219, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1219" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1191, - "name": "AuthMFAChallengeTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1192, - "name": "AuthMFAChallengePhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1193, - "name": "AuthMFAChallengeWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1191, - "name": "AuthMFAChallengeTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1160, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1160" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponseFields" - }, - "name": "AuthMFAChallengeTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1193, - "name": "AuthMFAChallengeWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn MFA challenge.\nContains credential creation or request options from the server." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Credential Creation", - "target": "https://w3c.github.io/webauthn/#sctn-credential-creation" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1189, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1189" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1194, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable version of WebAuthn challenge response.\nUsed for server communication with base64url-encoded binary fields." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1209, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1209" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFieldsJSON" - }, - "name": "AuthMFAChallengeWebauthnResponseFieldsJSON", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1195, - "name": "AuthMFAChallengeWebauthnServerResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server response type for WebAuthn MFA challenge.\nContains JSON-formatted WebAuthn options ready for browser API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1216, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1216" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1194, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1922, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1922" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponseFields" - }, - "name": "AuthMFAEnrollPhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1187, - "name": "AuthMFAEnrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1135, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1135" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1913, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1913" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponseFields" - }, - "name": "AuthMFAEnrollTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn factor enrollment.\nReturns the enrolled factor ID and metadata." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1935, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1935" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnFields" - }, - "name": "AuthMFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1203, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1239, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1239" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1204, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1207, - "name": "currentAuthenticationMethods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario.\n\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1260, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1260" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 864, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1205, - "name": "currentLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Current AAL level of the session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1241, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1241" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1206, - "name": "nextLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#challenge", - "target": 1218 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1249" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1207, 1205, 1206] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1239, - "character": 74, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1239" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1197, - "name": "AuthMFAListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "response of ListFactors, which should contain all the types of factors that are available, this ensures we always include all" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1225, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1225" - } - ], - "typeParameters": [ - { - "id": 1200, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - }, - "default": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1198, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1199, - "name": "all", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All available factors (verified and unverified)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1229, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1229" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1199] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1227, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1227" - } - ] - } - }, - { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "reference", - "target": 1200, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1188, - "name": "AuthMFAUnenrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1140, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1140" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1189, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1190, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1142" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1190] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1140, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1140" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1186, - "name": "AuthMFAVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for MFA verification operations.\nReturns session tokens on successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1133, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1133" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1179, - "name": "AuthMFAVerifyResponseData", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1179, - "name": "AuthMFAVerifyResponseData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data returned after successful MFA verification.\nContains new session tokens and updated user information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1112, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1112" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1181, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New access token (JWT) after successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1183, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of seconds in which the access token will expire." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1120, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1120" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1184, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Refresh token you can use to obtain new access tokens when expired." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1123" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of token, always " - }, - { - "kind": "code", - "text": "`bearer`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1117" - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 1185, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updated user profile." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1126, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1126" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1181, 1183, 1184, 1182, 1185] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1112, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1112" - } - ] - } - } - }, - { - "id": 1565, - "name": "AuthOAuthAuthorizationDetailsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for getting OAuth authorization details.\nReturns either full authorization details (if consent needed) or redirect URL (if already consented).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase.auth.oauth.getAuthorizationDetails(authorizationId)\n\nif (error) {\n console.error('Error:', error)\n} else if ('authorization_id' in data) {\n // User needs to provide consent - show consent page\n console.log('Client:', data.client.name)\n console.log('Scopes:', data.scope)\n console.log('Redirect URI:', data.redirect_uri)\n} else {\n // User already consented - redirect immediately\n window.location.href = data.redirect_url\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2550, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2550" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1552, - "name": "OAuthAuthorizationDetails", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1562, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1566, - "name": "AuthOAuthConsentResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth consent decision (approve/deny).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2558, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2558" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1562, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1572, - "name": "AuthOAuthGrantsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing user's OAuth grants.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2577, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2577" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1567, - "name": "OAuthGrant", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1573, - "name": "AuthOAuthRevokeGrantResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for revoking an OAuth grant.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2583, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2583" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1574, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2583, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2583" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 820, - "name": "AuthOtpResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AuthOtpResponse is returned when OTP is used.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "AuthResponse" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 256, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L256" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 821, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 824, - "name": "messageId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 259, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L259" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 823, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 258, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L258" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 822, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 257, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L257" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [824, 823, 822] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 256, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L256" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1671, - "name": "AuthPasskeyAdminDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2800, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2800" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1674, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2802, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2802" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1673, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2801" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1674, 1673] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2800, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2800" - } - ] - } - } - }, - { - "id": 1668, - "name": "AuthPasskeyAdminListParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2796, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2796" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1669, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1670, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2797, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2797" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1670] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2796, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2796" - } - ] - } - } - }, - { - "id": 1660, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2784, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2784" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1612, - "name": "PasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2786, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2786" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1662, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1663, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1664, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1663, 1664] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ] - } - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1667, - "name": "AuthPasskeyDeleteResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2792, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2792" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "literal", - "value": null - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1665, - "name": "AuthPasskeyListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2790, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2790" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1621, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1658, - "name": "AuthPasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2778, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2778" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "PasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2780, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2780" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1607, - "name": "PasskeyMetadata", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1666, - "name": "AuthPasskeyUpdateResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2791, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2791" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1621, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 811, - "name": "AuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 240, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L240" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 812, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 814, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 242, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L242" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 813, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 241, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L241" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [814, 813] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 240, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L240" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 815, - "name": "AuthResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 245, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L245" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 818, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 247, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L247" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 817, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L246" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 819, - "name": "weak_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 248, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L248" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 785, - "name": "WeakPassword", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [818, 817, 819] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 245, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L245" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 825, - "name": "AuthTokenResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 262, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L262" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 826, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 828, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 264, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L264" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 827, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 263, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L263" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [828, 827] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 262, - "character": 61, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L262" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 829, - "name": "AuthTokenResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 267, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L267" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 830, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 832, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 269, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L269" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 831, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 268, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L268" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - }, - { - "id": 833, - "name": "weakPassword", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 270, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L270" - } - ], - "type": { - "type": "reference", - "target": 785, - "name": "WeakPassword", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [832, 831, 833] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 267, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L267" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1292, - "name": "CallRefreshTokenResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1822, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1822" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1471, - "name": "CreateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new custom provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2288, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2288" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1472, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1478, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2300" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1481, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2306, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2306" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1482, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2308" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1488, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2320, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2320" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1476, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2296, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2296" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1477, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2298, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2298" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1486, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2316, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2316" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1484, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2312, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2312" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1483, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2310, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2310" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1474, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2292" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1485, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2314, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2314" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1491, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2326, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2326" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1475, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2294, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2294" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1480, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2304, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2304" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1473, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2290, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2290" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1479, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2302, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2302" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1487, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2318, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2318" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1489, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2322" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1490, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2324, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2324" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1478, 1481, 1482, 1488, 1476, 1477, 1486, 1484, 1483, 1474, 1485, 1491, 1475, 1480, - 1473, 1479, 1487, 1489, 1490 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2288, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2288" - } - ] - } - } - }, - { - "id": 1381, - "name": "CreateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2073, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2073" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1382, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1383, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2075, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2075" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1384, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2077, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2077" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1386, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2081, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2081" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1385, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2079" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1387, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types (optional, defaults to code)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2083, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2083" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1361, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1388, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2085, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2085" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1389, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method (defaults to server default if not specified)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2087, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2087" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1383, 1384, 1386, 1385, 1387, 1388, 1389] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2073, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2073" - } - ] - } - } - }, - { - "id": 1447, - "name": "CustomOAuthProvider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom OAuth/OIDC provider object returned from the admin API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2238, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2238" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1448, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1454, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2250, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2250" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1457, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2256, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2256" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1458, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2258, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2258" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1464, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2270, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2270" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1453, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2248, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2248" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1469, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2280" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1468, - "name": "discovery_document", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document (OIDC providers only)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2278, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2278" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1435, - "name": "OIDCDiscoveryDocument", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1462, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2266, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2266" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1460, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2262, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2262" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1459, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2260, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2260" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1449, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2240, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2240" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1451, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2244, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2244" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1461, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2264, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2264" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1467, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2276, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1452, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2246" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1456, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2254" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1450, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2242, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2242" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1455, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2252, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2252" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1463, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2268, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2268" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1465, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2272, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2272" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1470, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2282, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2282" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1466, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2274, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2274" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1454, 1457, 1458, 1464, 1453, 1469, 1468, 1462, 1460, 1459, 1449, 1451, 1461, 1467, - 1452, 1456, 1450, 1455, 1463, 1465, 1470, 1466 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2238, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2238" - } - ] - } - } - }, - { - "id": 1515, - "name": "CustomProviderListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2387, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2387" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1516, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1517, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1518, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1519, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1447, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1519] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ] - } - } - }, - { - "id": 1520, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2390, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2390" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1517, 1520] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2388, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2388" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1521, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1522, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1523, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1524, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1524] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ] - } - } - }, - { - "id": 1525, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2394, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2394" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1522, 1525] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2392, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2392" - } - ] - } - } - ] - } - }, - { - "id": 1514, - "name": "CustomProviderResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for custom provider operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2382, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2382" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1447, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1434, - "name": "CustomProviderType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of custom identity provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2205, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2205" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - } - }, - { - "id": 1091, - "name": "EmailOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 851, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L851" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1092, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 858, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L858" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1050, - "name": "EthereumWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 762, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L762" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "EIP1193Provider" - }, - "name": "EIP1193Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1051, - "name": "EthereumWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 764, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L764" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1052, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1053, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 766, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L766" - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1056, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 774, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L774" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1059, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 779, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L779" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1060, - "name": "signInWithEthereum", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 781, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L781" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "EthereumSignInInput" - }, - "name": "EthereumSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1058, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 776, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L776" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1059, 1060, 1058] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 774, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L774" - } - ] - } - } - }, - { - "id": 1055, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 772, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L772" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1054, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.ethereum`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 769, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L769" - } - ], - "type": { - "type": "reference", - "target": 1050, - "name": "EthereumWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1053, 1056, 1055, 1054] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 765, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L765" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1061, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1062, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 787, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L787" - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1063, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Ethereum compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 790, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L790" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1065, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 795, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L795" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1067, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 797, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L797" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1067] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 795, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L795" - } - ] - } - } - }, - { - "id": 1064, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ethereum curve (secp256k1) signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 793, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L793" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "Hex" - }, - "name": "Hex", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1062, 1063, 1065, 1064] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 786, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L786" - } - ] - } - } - ] - } - }, - { - "id": 781, - "name": "ExperimentalFeatureFlags", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 182, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L182" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 782, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 783, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enables passkey support:\n - " - }, - { - "kind": "code", - "text": "`auth.signInWithPasskey()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`auth.registerPasskey()`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.passkey.*`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.admin.passkey.*`" - }, - { - "kind": "text", - "text": "\n\nDefaults to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ". Calling any passkey method while this flag is\ndisabled throws a descriptive error at call time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L192" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [783] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 182, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L182" - } - ] - } - } - }, - { - "id": 880, - "name": "Factor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A MFA factor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 1209 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#listFactors", - "target": 1260 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAAdminApi#listFactors" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 412, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L412" - } - ], - "typeParameters": [ - { - "id": 889, - "name": "Type", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 879, - "name": "FactorType", - "package": "@supabase/auth-js" - }, - "default": { - "type": "reference", - "target": 879, - "name": "FactorType", - "package": "@supabase/auth-js" - } - }, - { - "id": 890, - "name": "Status", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorVerificationStatus" - }, - "name": "FactorVerificationStatus", - "package": "@supabase/auth-js" - }, - "default": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorVerificationStatuses" - }, - "name": "FactorVerificationStatuses", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 881, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 886, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 432, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L432" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 884, - "name": "factor_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L425" - } - ], - "type": { - "type": "reference", - "target": 889, - "name": "Type", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 883, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L420" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 882, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 417, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L417" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 888, - "name": "last_challenged_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 434, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L434" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 885, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification status of the factor, default is " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " after " - }, - { - "kind": "code", - "text": "`.enroll()`" - }, - { - "kind": "text", - "text": ", then " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " after the user verifies it with " - }, - { - "kind": "code", - "text": "`.verify()`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 430, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L430" - } - ], - "type": { - "type": "reference", - "target": 890, - "name": "Status", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 887, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 433, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L433" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [886, 884, 883, 882, 888, 885, 887] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 415, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L415" - } - ] - } - } - }, - { - "id": 879, - "name": "FactorType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 396, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L396" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1138, - "name": "GenerateEmailChangeLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 937, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L937" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1141, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 940, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L940" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1142, - "name": "newEmail", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 944, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L944" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1143, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 945, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L945" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1140, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 938, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L938" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1141, 1142, 1143, 1140] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 937, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L937" - } - ] - } - } - }, - { - "id": 1128, - "name": "GenerateInviteOrMagiclinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 923, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L923" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1129, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1131, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 926, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L926" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1132, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 927, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L927" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1130, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 924, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L924" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1131, 1132, 1130] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 923, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L923" - } - ] - } - } - }, - { - "id": 1147, - "name": "GenerateLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 959, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L959" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1122, - "name": "GenerateSignupLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1128, - "name": "GenerateInviteOrMagiclinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1133, - "name": "GenerateRecoveryLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1138, - "name": "GenerateEmailChangeLinkParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1152, - "name": "GenerateLinkProperties", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The properties related to the email link generated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 971, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L971" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1154, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 976, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L976" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1155, - "name": "email_otp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 981, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L981" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1156, - "name": "hashed_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The hashed token appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 985, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L985" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1157, - "name": "redirect_to", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 987, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L987" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1158, - "name": "verification_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification type that the email link is associated to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 989, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L989" - } - ], - "type": { - "type": "reference", - "target": 1159, - "name": "GenerateLinkType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1154, 1155, 1156, 1157, 1158] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 971, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L971" - } - ] - } - } - }, - { - "id": 1148, - "name": "GenerateLinkResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 965, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L965" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1149, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1150, - "name": "properties", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 966, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L966" - } - ], - "type": { - "type": "reference", - "target": 1152, - "name": "GenerateLinkProperties", - "package": "@supabase/auth-js" - } - }, - { - "id": 1151, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L967" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1150, 1151] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 965, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L965" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1159, - "name": "GenerateLinkType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 992, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L992" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - }, - { - "id": 1133, - "name": "GenerateRecoveryLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 930, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L930" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1136, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 933, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L933" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1137, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 934, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L934" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1135, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 931, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L931" - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1136, 1137, 1135] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 930, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L930" - } - ] - } - } - }, - { - "id": 1122, - "name": "GenerateSignupLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 916, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L916" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1125, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 918, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L918" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1127, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 920, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L920" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1126, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 919, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L919" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1124, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 917, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L917" - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1125, 1127, 1126, 1124] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 916, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L916" - } - ] - } - } - }, - { - "id": 748, - "name": "GoTrueClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L80" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 749, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 764, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L109" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 770, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 127, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L127" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 771, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 127, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L127" - } - ], - "signatures": [ - { - "id": 772, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 773, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 774, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - }, - { - "id": 756, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if you want to automatically detect OAuth grants in the URL and sign in the user.\nSet to \"false\" to disable automatic detection.\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\nThe function receives the current URL and parsed parameters, and should return true if the URL\nshould be processed as a Supabase auth callback, or false to ignore it.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 757, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "signatures": [ - { - "id": 758, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 759, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 760, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 761, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "indexSignatures": [ - { - "id": 762, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "parameters": [ - { - "id": 763, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 780, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 179, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L179" - } - ], - "type": { - "type": "reference", - "target": 781, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 768, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L123" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/fetch.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/auth-js" - } - }, - { - "id": 769, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L125" - } - ], - "type": { - "type": "reference", - "target": 993, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 776, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if there is a custom authorization header set globally." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L146" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 751, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "indexSignatures": [ - { - "id": 753, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "parameters": [ - { - "id": 754, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 775, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe client coordinates refreshes itself (single-flight via\n" - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " + commit guard) and relies on the GoTrue server to\nresolve cross-tab refresh races. Passing a custom lock opts into a\nlegacy path that wraps every auth operation in your supplied lock — this\npath is preserved for backwards compatibility (typically React Native\n" - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": " or Node multi-process setups)." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\nconstructor options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L141" - } - ], - "type": { - "type": "reference", - "target": 739, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - }, - { - "id": 778, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option. Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is\npassed — the default lockless path doesn't use this timeout." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 162, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 765, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L111" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 779, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in constructor. Useful for SSR\ncontexts where initialization timing must be controlled to prevent race\nconditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L171" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 766, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "reference", - "target": 1286, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 755, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L86" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 777, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L151" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 750, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L82" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 767, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " - }, - { - "kind": "code", - "text": "`storage`" - }, - { - "kind": "text", - "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " - }, - { - "kind": "code", - "text": "`userStorage`" - }, - { - "kind": "text", - "text": " will only contain the user object under the key " - }, - { - "kind": "code", - "text": "`storageKey + '-user'`" - }, - { - "kind": "text", - "text": ".\n\nWhen this option is set and cookie storage is used, " - }, - { - "kind": "code", - "text": "`getSession()`" - }, - { - "kind": "text", - "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch a user object in those scenarios." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L121" - } - ], - "type": { - "type": "reference", - "target": 1286, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 764, 770, 756, 780, 768, 769, 776, 751, 775, 778, 765, 779, 766, 755, 777, 750, 767 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 80, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L80" - } - ] - } - } - }, - { - "id": 1289, - "name": "InitializeResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1290, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1291, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1291] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ] - } - } - }, - { - "id": 1313, - "name": "JwtHeader", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1939, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1939" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1314, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1315, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1940, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1940" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "RS256" - }, - { - "type": "literal", - "value": "ES256" - }, - { - "type": "literal", - "value": "HS256" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1316, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1940, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1940" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1317, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1941" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1318, - "name": "typ", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1942, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1942" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1315, 1317, 1318] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1939, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1939" - } - ] - } - } - }, - { - "id": 1511, - "name": "ListCustomProvidersParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2374, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2374" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1512, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1513, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2376" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1513] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2374, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2374" - } - ] - } - } - }, - { - "id": 739, - "name": "LockFunc", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": " async function, such that no other client instances will be able to\nhold it at the same time." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 740, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "signatures": [ - { - "id": 741, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameters": [ - { - "id": 747, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 742, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 743, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 744, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to execute when the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 747, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 747, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1178, - "name": "MFAChallengeAndVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1106, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1106" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - }, - { - "id": 1177, - "name": "MFAChallengeParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1094, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1094" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1174, - "name": "MFAChallengeTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1175, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1176, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1175, - "name": "MFAChallengePhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1075, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1075" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParamFields" - }, - "name": "MFAChallengePhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1174, - "name": "MFAChallengeTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1068, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1068" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1176, - "name": "MFAChallengeWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for initiating a WebAuthn MFA challenge.\nIncludes Relying Party information needed for WebAuthn ceremonies." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Relying Party Operations", - "target": "https://w3c.github.io/webauthn/#sctn-rp-operations" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1092, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1092" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParamFields" - }, - "name": "MFAChallengeWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1160, - "name": "MFAEnrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1000, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1000" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1307, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1308, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1309, - "name": "MFAEnrollWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1308, - "name": "MFAEnrollPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1870, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1870" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParamFields" - }, - "name": "MFAEnrollPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1307, - "name": "MFAEnrollTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1864, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1864" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParamFields" - }, - "name": "MFAEnrollTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1309, - "name": "MFAEnrollWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for enrolling a WebAuthn factor.\nCreates an unverified WebAuthn factor that must be verified with a credential." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1881, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1881" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnFields" - }, - "name": "MFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1173, - "name": "MFATOTPChannel", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1066, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1066" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFATOTPChannels" - }, - "name": "MFATOTPChannels", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1161, - "name": "MFAUnenrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1002, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1002" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1162, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1163, - "name": "factorId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor being unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1004, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1004" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1163] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1002, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1002" - } - ] - } - } - }, - { - "id": 1172, - "name": "MFAVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1058, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1058" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1164, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1165, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1170, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1165, - "name": "MFAVerifyPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1023, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1023" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParamFields" - }, - "name": "MFAVerifyPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1164, - "name": "MFAVerifyTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1019, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1019" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParamFields" - }, - "name": "MFAVerifyTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1166, - "name": "MFAVerifyWebauthnParamFields", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "WebAuthn-specific fields for MFA verification.\nSupports both credential creation (registration) and request (authentication) flows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1045, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1045" - } - ], - "typeParameters": [ - { - "id": 1169, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1167, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1168, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1046, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1046" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFieldsBase" - }, - "name": "MFAVerifyWebauthnParamFieldsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnCredentialParamFields" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1169, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnCredentialParamFields", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1168] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1045, - "character": 98, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1045" - } - ] - } - } - }, - { - "id": 1170, - "name": "MFAVerifyWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for WebAuthn MFA verification.\nUsed to verify WebAuthn credentials after challenge." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Verifying an Authentication Assertion", - "target": "https://w3c.github.io/webauthn/#sctn-verifying-assertion" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1055, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1055" - } - ], - "typeParameters": [ - { - "id": 1171, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1166, - "typeArguments": [ - { - "type": "reference", - "target": 1171, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1089, - "name": "MobileOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 850, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L850" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1090, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 850, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L850" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1546, - "name": "OAuthAuthorizationClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client details in an authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2470, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2470" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1547, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1548, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2472" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1551, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1549, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2474, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2474" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1550, - "name": "uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's website" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2476, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2476" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1548, 1551, 1549, 1550] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2470, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2470" - } - ] - } - } - }, - { - "id": 1552, - "name": "OAuthAuthorizationDetails", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth authorization details when user needs to provide consent.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response includes all information needed to display a consent page:\nclient details, user info, requested scopes, and where the user will be redirected.\n\nNote: " - }, - { - "kind": "code", - "text": "`redirect_uri`" - }, - { - "kind": "text", - "text": " is the base URI (e.g., \"https://app.com/callback\") without\nquery parameters. After consent, you'll receive a complete " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " with\nthe authorization code and state parameters appended." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2492, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2492" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1553, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1554, - "name": "authorization_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID used to approve or deny the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2494, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2494" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1556, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client requesting authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2498, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2498" - } - ], - "type": { - "type": "reference", - "target": 1546, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 1555, - "name": "redirect_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client's registered redirect URI (base URI without query parameters)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2496, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2496" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1561, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Space-separated list of requested scopes (e.g., \"openid profile email\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2507" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1557, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User object associated with the authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2500" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1558, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1560, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2504, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2504" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1559, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User ID (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2502, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2502" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1560, 1559] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2500, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2500" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1554, 1556, 1555, 1561, 1557] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2492, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2492" - } - ] - } - } - }, - { - "id": 1365, - "name": "OAuthClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client object returned from the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2038, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2038" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1367, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2040, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2040" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1368, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2042, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2042" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1369, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client secret (only returned on registration and regeneration)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2044, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2044" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1370, - "name": "client_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2046, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2046" - } - ], - "type": { - "type": "reference", - "target": 1362, - "name": "OAuthClientType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1373, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2052, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2052" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1379, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2064, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2064" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1376, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2058, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2058" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1374, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2054, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2054" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1375, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2056, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2056" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1372, - "name": "registration_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registration type of the client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2050, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2050" - } - ], - "type": { - "type": "reference", - "target": 1363, - "name": "OAuthClientRegistrationType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1377, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2060, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2060" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1361, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1378, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2062, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2062" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1371, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2048, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2048" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 1380, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2066, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2066" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1367, 1368, 1369, 1370, 1373, 1379, 1376, 1374, 1375, 1372, 1377, 1378, 1371, 1380 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2038, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2038" - } - ] - } - } - }, - { - "id": 1359, - "name": "OAuthClientGrantType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client grant types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2005, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2005" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1360, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2005, - "character": 86, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2005" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1399, - "name": "OAuthClientListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing OAuth clients.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2120, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2120" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1400, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1401, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1404, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1403, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1365, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1404, 1403] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ] - } - }, - { - "type": "reference", - "target": 1293, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1405, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2123, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2123" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1401, 1405] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2121" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1406, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1407, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1408, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1409, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1409] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ] - } - } - }, - { - "id": 1410, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2127, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2127" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1407, 1410] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2125, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2125" - } - ] - } - } - ] - } - }, - { - "id": 1363, - "name": "OAuthClientRegistrationType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client registration type.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2023, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2023" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - } - }, - { - "id": 1398, - "name": "OAuthClientResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth client operations.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2114, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2114" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1365, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1361, - "name": "OAuthClientResponseType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client response types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2011, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2011" - } - ], - "type": { - "type": "literal", - "value": "code" - } - }, - { - "id": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client token endpoint authentication method.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2029, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2029" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - } - }, - { - "id": 1362, - "name": "OAuthClientType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client type indicating whether the client can keep credentials confidential.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2017, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2017" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - } - }, - { - "id": 1567, - "name": "OAuthGrant", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An OAuth grant representing a user's authorization of an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2564, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2564" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1568, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1569, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client information" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2566" - } - ], - "type": { - "type": "reference", - "target": 1546, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 1571, - "name": "granted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the grant was created (ISO 8601 date-time)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2570" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1570, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of scopes granted to this client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2568, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2568" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1569, 1571, 1570] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2564, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2564" - } - ] - } - } - }, - { - "id": 1562, - "name": "OAuthRedirect", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth redirect response when user has already consented or after consent decision.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response is returned in three scenarios:\n1. User already consented to these scopes (auto-approved)\n2. User just approved the authorization request\n3. User just denied the authorization request\n\nThe " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " is a complete URL ready for redirecting the user back to the\nOAuth client, including authorization code (on success) or error (on denial) in\nquery parameters, along with the state parameter if one was provided." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2523, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2523" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1563, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1564, - "name": "redirect_url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Complete redirect URL with authorization code and state parameters (e.g., \"https://app.com/callback?code=xxx&state=yyy\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2525, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2525" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1564] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2523, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2523" - } - ] - } - } - }, - { - "id": 834, - "name": "OAuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 273, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L273" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 835, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 836, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L275" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 837, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 838, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L276" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 839, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L277" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [838, 839] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 275, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L275" - } - ] - } - } - }, - { - "id": 840, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L279" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [836, 840] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 274, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L274" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 841, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 842, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 282, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L282" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 844, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 283, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L283" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 845, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 284, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L284" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [844, 845] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 282, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L282" - } - ] - } - } - }, - { - "id": 846, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 286, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L286" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [842, 846] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 281, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L281" - } - ] - } - } - ] - } - }, - { - "id": 1435, - "name": "OIDCDiscoveryDocument", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document fields.\nPopulated when the server successfully fetches and validates the\nprovider's OpenID Connect discovery document." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2212, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2212" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1436, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1438, - "name": "authorization_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the authorization endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2216" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1437, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The issuer identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2214, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2214" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1440, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the JSON Web Key Set" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2220, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2220" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1442, - "name": "revocation_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the revocation endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2224, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2224" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1446, - "name": "supported_id_token_signing_algs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported ID token signing algorithms" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2232, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2232" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1444, - "name": "supported_response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2228, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2228" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1443, - "name": "supported_scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported scopes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2226, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2226" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1445, - "name": "supported_subject_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported subject types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2230, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2230" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1439, - "name": "token_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the token endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2218, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2218" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1441, - "name": "userinfo_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the userinfo endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2222, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2222" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1438, 1437, 1440, 1442, 1446, 1444, 1443, 1445, 1439, 1441] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2212, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2212" - } - ] - } - } - }, - { - "id": 1300, - "name": "PageParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1831, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1831" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1301, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1302, - "name": "page", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The page number" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1833, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1833" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1303, - "name": "perPage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items returned per page" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1835, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1835" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1302, 1303] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1831, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1831" - } - ] - } - } - }, - { - "id": 1293, - "name": "Pagination", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1824, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1824" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1294, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1296, - "name": "lastPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1827, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1827" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1295, - "name": "nextPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1826, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1826" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1297, - "name": "total", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1828, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1828" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1296, 1295, 1297] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1824, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1824" - } - ], - "indexSignatures": [ - { - "id": 1298, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1825, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1825" - } - ], - "parameters": [ - { - "id": 1299, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 1612, - "name": "PasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/authentication/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2709, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2709" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1613, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1614, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2710, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2710" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1616, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2712, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2712" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1615, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2711, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2711" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialRequestOptions" - }, - "name": "ServerCredentialRequestOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1614, 1616, 1615] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2709, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2709" - } - ] - } - } - }, - { - "id": 1617, - "name": "PasskeyAuthenticationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/authentication/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2716, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2716" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1618, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1619, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2717, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2717" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1620, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2718, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2718" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.dom.ts", - "qualifiedName": "AuthenticationResponseJSON" - }, - "name": "AuthenticationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1619, 1620] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2716, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2716" - } - ] - } - } - }, - { - "id": 1655, - "name": "PasskeyDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2771, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2771" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1657, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to delete" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2773, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2773" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1657] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2771, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2771" - } - ] - } - } - }, - { - "id": 1621, - "name": "PasskeyListItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Item in the passkeys list (GET /passkeys/ and admin list)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2722, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1625, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2725, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2725" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1624, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2724, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2724" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1623, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2723, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2723" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1626, - "name": "last_used_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2726, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2726" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1625, 1624, 1623, 1626] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2722, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2722" - } - ] - } - } - }, - { - "id": 1607, - "name": "PasskeyMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2702, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2702" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1608, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1611, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1610, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2704, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2704" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1609, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2703, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2703" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1611, 1610, 1609] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2702, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2702" - } - ] - } - } - }, - { - "id": 1598, - "name": "PasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2689, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2689" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1599, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1600, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2690" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1602, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2692" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1601, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2691, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2691" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialCreationOptions" - }, - "name": "ServerCredentialCreationOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1600, 1602, 1601] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2689, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2689" - } - ] - } - } - }, - { - "id": 1603, - "name": "PasskeyRegistrationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2696, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2696" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1604, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1605, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2697, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2697" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1606, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2698, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2698" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.dom.ts", - "qualifiedName": "RegistrationResponseJSON" - }, - "name": "RegistrationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1605, 1606] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2696, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2696" - } - ] - } - } - }, - { - "id": 1651, - "name": "PasskeyUpdateParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2764, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2764" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1652, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1654, - "name": "friendlyName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New friendly name (max 120 chars)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2768, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2768" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1653, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2766, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2766" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1654, 1653] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2764, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2764" - } - ] - } - } - }, - { - "id": 789, - "name": "Prettify", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resolve mapped types and show the derived keys and their types when hovering in\nVS Code, instead of just showing the names those mapped types are defined with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ], - "typeParameters": [ - { - "id": 790, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - } - }, - { - "id": 736, - "name": "Provider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue. Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 24, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ], - "elementSummaries": [ - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [ - { - "kind": "text", - "text": "Uses OAuth 1.0a" - } - ], - [ - { - "kind": "text", - "text": "Uses OAuth 2.0" - } - ], - [], - [], - [], - [] - ] - } - }, - { - "id": 1633, - "name": "RegisterPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2738, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2738" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1634, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1635, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2739, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2739" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1636, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1637, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2740, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2740" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1637] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2739, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2739" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1635] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2738, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2738" - } - ] - } - } - }, - { - "id": 794, - "name": "RequestResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "a shared result type that encapsulates errors instead of throwing them, allows you to optionally specify the ErrorType" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 219, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L219" - } - ], - "typeParameters": [ - { - "id": 801, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 802, - "name": "ErrorType", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "default": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 795, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 796, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": 801, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 797, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [796, 797] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 220, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L220" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 798, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 799, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 800, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "extendsType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "trueType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "falseType": { - "type": "reference", - "target": 802, - "name": "ErrorType", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [799, 800] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 224, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L224" - } - ] - } - } - ] - } - }, - { - "id": 803, - "name": "RequestResultSafeDestructure", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "similar to RequestResult except it allows you to destructure the possible shape of the success response\n " - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "RequestResult" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 233, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L233" - } - ], - "typeParameters": [ - { - "id": 810, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 804, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 805, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ], - "type": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 806, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [805, 806] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 807, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 808, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 236, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L236" - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "object" - }, - "trueType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "literal", - "value": null - } - }, - "falseType": { - "type": "literal", - "value": null - } - } - }, - { - "id": 809, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 237, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L237" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [808, 809] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L235" - } - ] - } - } - ] - } - }, - { - "id": 1319, - "name": "RequiredClaims", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1945, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1945" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1320, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1327, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1952, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1952" - } - ], - "type": { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - } - }, - { - "id": 1323, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1948, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1948" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1324, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1949, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1949" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1325, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1950, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1950" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1321, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1946, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1946" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1326, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1951, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1951" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1328, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1953, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1953" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1322, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1947" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1327, 1323, 1324, 1325, 1321, 1326, 1328, 1322] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1945, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1945" - } - ] - } - }, - "extendedBy": [ - { - "type": "reference", - "target": 1329, - "name": "JwtPayload" - } - ] - }, - { - "id": 1093, - "name": "ResendParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 860, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L860" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1096, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 863, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1097, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 864, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L864" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1098, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1100, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 868, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L868" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1099, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 866, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L866" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1100, 1099] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 864, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L864" - } - ] - } - } - }, - { - "id": 1095, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 862, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L862" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1096, 1097, 1095] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L861" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1101, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1104, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 874, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L874" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1105, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1106, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L876" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1106] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 874, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L874" - } - ] - } - } - }, - { - "id": 1103, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 873, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L873" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1102, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 872, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L872" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1089, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1104, 1103, 1102] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 871, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L871" - } - ] - } - } - ] - } - }, - { - "id": 957, - "name": "SignInAnonymouslyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 615, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L615" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 958, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 959, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L616" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 960, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 962, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 624, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L624" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 961, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 622, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L622" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [962, 961] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 616, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L616" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [959] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 615, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L615" - } - ] - } - } - }, - { - "id": 1007, - "name": "SignInWithIdTokenCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 701, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L701" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1008, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1012, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 707, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L707" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1013, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L709" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1014, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 710, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L710" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1015, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1016, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 712, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L712" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1016] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 710, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L710" - } - ] - } - } - }, - { - "id": 1009, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider name or OIDC " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " value identifying which provider should be used to verify the provided token. Supported names: " - }, - { - "kind": "code", - "text": "`google`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`apple`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`azure`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`facebook`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`kakao`" - }, - { - "kind": "text", - "text": ". Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 703, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L703" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1010, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 703, - "character": 97, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L703" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1011, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC ID token issued by the specified provider. The " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " which require that you provide an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " value to be accepted properly. If the token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim you must supply the nonce used to obtain the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1012, 1013, 1014, 1009, 1011] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 701, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L701" - } - ] - } - } - }, - { - "id": 995, - "name": "SignInWithOAuthCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 686, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L686" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 996, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 998, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 689, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L689" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 999, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1002, - "name": "queryParams", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object of query params" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1003, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "indexSignatures": [ - { - "id": 1004, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "parameters": [ - { - "id": 1005, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1000, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 691, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L691" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1001, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A space-separated list of scopes granted to the OAuth application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 693, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L693" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1006, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 697, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L697" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1002, 1000, 1001, 1006] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 689, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L689" - } - ] - } - } - }, - { - "id": 997, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 688, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L688" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [998, 997] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 686, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L686" - } - ] - } - } - }, - { - "id": 1627, - "name": "SignInWithPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2731, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2731" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1628, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1629, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2732, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2732" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1631, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2733, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2733" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1632, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2734, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2734" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1631, 1632] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2732, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2732" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1629] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2731, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2731" - } - ] - } - } - }, - { - "id": 971, - "name": "SignInWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 641, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L641" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 972, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 973, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 642, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L642" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 975, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 643, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L643" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [975] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 642, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L642" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [973] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 641, - "character": 70, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L641" - } - ] - } - } - ] - } - }, - { - "id": 976, - "name": "SignInWithPasswordlessCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 647, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L647" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 977, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 978, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 650, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L650" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 979, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 651, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L651" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 980, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 984, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 663, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L663" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 983, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 661, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L661" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 981, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The redirect url embedded in the email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 653, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L653" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 982, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 655, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L655" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [984, 983, 981, 982] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 651, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L651" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [978, 979] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 648, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L648" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 985, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 987, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 669, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L669" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 988, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 991, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 679, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L679" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 992, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Messaging channel to use (e.g. whatsapp or sms)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 681, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L681" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 990, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 677, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L677" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 989, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 671, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L671" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [991, 992, 990, 989] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 669, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L669" - } - ] - } - } - }, - { - "id": 986, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 668, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L668" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [987, 986] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 666, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L666" - } - ] - } - } - ] - } - }, - { - "id": 1107, - "name": "SignInWithSSO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 880, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L880" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1110, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 885, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L885" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1113, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 889, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L889" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1112, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 887, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L887" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1114, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 895, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113, 1112, 1114] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 885, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L885" - } - ] - } - } - }, - { - "id": 1109, - "name": "providerId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the SSO provider to invoke single-sign on to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 883, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L883" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1110, 1109] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 881, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L881" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1116, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Domain name of the organization for which to invoke single-sign on." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 900, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L900" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1117, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 902, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L902" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1120, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 906, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L906" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1119, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 904, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L904" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1121, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 912, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L912" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1120, 1119, 1121] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 902, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L902" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1116, 1117] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 898, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L898" - } - ] - } - } - ] - } - }, - { - "id": 1304, - "name": "SignOut", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1838, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1838" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1305, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1306, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1849, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1849" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1306] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1838, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1838" - } - ] - } - } - }, - { - "id": 1358, - "name": "SignOutScope", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1999, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1999" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1357, - "name": "SIGN_OUT_SCOPES", - "package": "@supabase/auth-js" - } - } - } - }, - { - "id": 963, - "name": "SignUpWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 628, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L628" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 964, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 965, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 629, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L629" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 966, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 969, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 632, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L632" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 970, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 633, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L633" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 968, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 631, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L631" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 967, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 630, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L630" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [969, 970, 968, 967] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 629, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L629" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [965] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 628, - "character": 70, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L628" - } - ] - } - } - ] - } - }, - { - "id": 1017, - "name": "SolanaWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 716, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L716" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1018, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1023, - "name": "publicKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 718, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L718" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1024, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1025, - "name": "toBase58", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 719, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L719" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1026, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 719, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L719" - } - ], - "signatures": [ - { - "id": 1027, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1025] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 718, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L718" - } - ] - } - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1019, - "name": "signIn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 717, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L717" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1020, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 717, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L717" - } - ], - "signatures": [ - { - "id": 1021, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1022, - "name": "inputs", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1028, - "name": "signMessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 722, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 722, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L722" - } - ], - "signatures": [ - { - "id": 1030, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1031, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - }, - { - "id": 1032, - "name": "encoding", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "utf8" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1023, 1019, 1028] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 716, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L716" - } - ] - } - } - }, - { - "id": 1033, - "name": "SolanaWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 725, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L725" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1034, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1035, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 727, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L727" - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1038, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 735, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L735" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1039, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1041, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 740, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L740" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1042, - "name": "signInWithSolana", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 742, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L742" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "chain" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1040, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 737, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L737" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1041, 1042, 1040] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 735, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L735" - } - ] - } - } - }, - { - "id": 1037, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 733, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L733" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1036, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.solana`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 730, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L730" - } - ], - "type": { - "type": "reference", - "target": 1017, - "name": "SolanaWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1035, 1038, 1037, 1036] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 726, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L726" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1043, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1044, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 748, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L748" - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1045, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Solana compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 751, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L751" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1047, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 756, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L756" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1048, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1049, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 758, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L758" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1049] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 756, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L756" - } - ] - } - } - }, - { - "id": 1046, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ed25519 signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 754, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L754" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1044, 1045, 1047, 1046] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 747, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L747" - } - ] - } - } - ] - } - }, - { - "id": 847, - "name": "SSOResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 289, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L289" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 848, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 849, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " - }, - { - "kind": "code", - "text": "`window.location.href`" - }, - { - "kind": "text", - "text": " to take\nthe user to the authentication flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L297" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [849] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 289, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L289" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1642, - "name": "StartPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2751, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2751" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1643, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1644, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2752, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2752" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1645, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1646, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2753, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2753" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1646] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2752, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2752" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1644] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2751, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2751" - } - ] - } - } - }, - { - "id": 791, - "name": "StrictOmit", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A stricter version of TypeScript's Omit that only allows omitting keys that actually exist.\nThis prevents typos and ensures type safety at compile time.\nUnlike regular Omit, this will error if you try to omit a non-existent key." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 214, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L214" - } - ], - "typeParameters": [ - { - "id": 792, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 793, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 792, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 792, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 793, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1286, - "name": "SupportedStorage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1807, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1807" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PromisifyMethods" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "PromisifyMethods", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1287, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1288, - "name": "isServer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1817, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1817" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1288] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1809, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1809" - } - ] - } - } - ] - } - }, - { - "id": 1492, - "name": "UpdateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing custom provider.\nAll fields are optional. Only provided fields will be updated.\n" - }, - { - "kind": "code", - "text": "`provider_type`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " are immutable and cannot be changed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2334, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2334" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1493, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1497, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2342" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1500, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2348, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2348" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1501, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2350" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1507, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2362, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2362" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1495, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2338, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2338" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1496, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2340, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2340" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1505, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2358, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2358" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1503, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2354, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2354" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1502, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2352" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1504, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2356" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1510, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2368, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2368" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1494, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2336, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2336" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1499, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2346, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2346" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1498, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2344" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1506, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2360" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1508, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2364, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2364" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1509, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2366" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1497, 1500, 1501, 1507, 1495, 1496, 1505, 1503, 1502, 1504, 1510, 1494, 1499, 1498, - 1506, 1508, 1509 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2334, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2334" - } - ] - } - } - }, - { - "id": 1390, - "name": "UpdateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing OAuth client.\nAll fields are optional. Only provided fields will be updated.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2095, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2095" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1392, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2097, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2097" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1393, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2099" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1396, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2105, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2105" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1394, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2101, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2101" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1395, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2103, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2103" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1397, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2107" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1392, 1393, 1396, 1394, 1395, 1397] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2095, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2095" - } - ] - } - } - }, - { - "id": 850, - "name": "UserResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 300, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L300" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 852, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [852] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 300, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L300" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1069, - "name": "VerifyOtpParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 803, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L803" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1070, - "name": "VerifyMobileOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1078, - "name": "VerifyEmailOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1086, - "name": "VerifyTokenHashParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1647, - "name": "VerifyPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2757, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2757" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1648, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1649, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startAuthentication" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2759, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2759" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1650, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.get()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2761, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2761" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1649, 1650] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2757, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2757" - } - ] - } - } - }, - { - "id": 1638, - "name": "VerifyPasskeyRegistrationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2744, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2744" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1639, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1640, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startRegistration" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2746, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2746" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1641, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.create()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2748, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2748" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1640, 1641] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2744, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2744" - } - ] - } - } - }, - { - "id": 785, - "name": "WeakPassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 198, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L198" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 786, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 788, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 200, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L200" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 787, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 784, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [788, 787] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 198, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L198" - } - ] - } - } - }, - { - "id": 784, - "name": "WeakPasswordReasons", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 197, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L197" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1068, - "name": "Web3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 801, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L801" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1033, - "name": "SolanaWeb3Credentials", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1051, - "name": "EthereumWeb3Credentials", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 710, - "name": "AuthAdminApi", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/AuthAdminApi.ts", - "line": 3, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/AuthAdminApi.ts#L3" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1, - "name": "default", - "package": "@supabase/auth-js" - } - }, - "defaultValue": "GoTrueAdminApi" - }, - { - "id": 711, - "name": "AuthClient", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/AuthClient.ts", - "line": 3, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/AuthClient.ts#L3" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 136, - "name": "default", - "package": "@supabase/auth-js" - } - }, - "defaultValue": "GoTrueClient" - }, - { - "id": 725, - "name": "lockInternals", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Debug flag for " - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": ". The auth\nclient ignores both, so this has no client-side effect." - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 17, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L17" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 726, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 727, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [727] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 17, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L17" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1357, - "name": "SIGN_OUT_SCOPES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1998, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1998" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1705, - "name": "isAuthApiError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 75, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L75" - } - ], - "signatures": [ - { - "id": 1706, - "name": "isAuthApiError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 75, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L75" - } - ], - "parameters": [ - { - "id": 1707, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1744, - "name": "AuthApiError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1702, - "name": "isAuthError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L50" - } - ], - "signatures": [ - { - "id": 1703, - "name": "isAuthError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L50" - } - ], - "parameters": [ - { - "id": 1704, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1711, - "name": "isAuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 210, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L210" - } - ], - "signatures": [ - { - "id": 1712, - "name": "isAuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 210, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L210" - } - ], - "parameters": [ - { - "id": 1713, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1714, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 274, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L274" - } - ], - "signatures": [ - { - "id": 1715, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 274, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L274" - } - ], - "parameters": [ - { - "id": 1716, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1720, - "name": "isAuthRefreshDiscardedError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 328, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L328" - } - ], - "signatures": [ - { - "id": 1721, - "name": "isAuthRefreshDiscardedError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 328, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L328" - } - ], - "parameters": [ - { - "id": 1722, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1717, - "name": "isAuthRetryableFetchError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 296, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L296" - } - ], - "signatures": [ - { - "id": 1718, - "name": "isAuthRetryableFetchError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 296, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L296" - } - ], - "parameters": [ - { - "id": 1719, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1708, - "name": "isAuthSessionMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 140, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L140" - } - ], - "signatures": [ - { - "id": 1709, - "name": "isAuthSessionMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 140, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L140" - } - ], - "parameters": [ - { - "id": 1710, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1723, - "name": "isAuthWeakPasswordError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 373, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L373" - } - ], - "signatures": [ - { - "id": 1724, - "name": "isAuthWeakPasswordError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 373, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L373" - } - ], - "parameters": [ - { - "id": 1725, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 712, - "name": "navigatorLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 86, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L86" - } - ], - "signatures": [ - { - "id": 713, - "name": "navigatorLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient", - "target": 136 - }, - { - "kind": "text", - "text": ".\n\nYou can turn on debugging by setting the " - }, - { - "kind": "code", - "text": "`supabase.gotrue-js.locks.debug`" - }, - { - "kind": "text", - "text": "\nlocal storage item to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " - }, - { - "kind": "code", - "text": "`request`" - }, - { - "kind": "text", - "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: navigatorLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 86, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L86" - } - ], - "typeParameters": [ - { - "id": 714, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 715, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 716, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 717, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 718, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 89, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L89" - } - ], - "signatures": [ - { - "id": 719, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 89, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L89" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 714, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 714, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 728, - "name": "processLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 325, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L325" - } - ], - "signatures": [ - { - "id": 729, - "name": "processLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#navigatorLock" - }, - { - "kind": "text", - "text": " in browser environments." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: processLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nawait processLock('migrate', 5000, async () => {\n await runMigration()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 325, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L325" - } - ], - "typeParameters": [ - { - "id": 730, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 731, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 732, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 733, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 734, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 328, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L328" - } - ], - "signatures": [ - { - "id": 735, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 328, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L328" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 730, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 730, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [ - 1744, 1726, 1849, 1832, 1979, 1816, 1907, 1878, 1941, 1923, 1800, 1762, 1958, 1780, 1, 136, - 720 - ] - }, - { - "title": "Interfaces", - "children": [ - 933, 864, 1575, 1675, 1144, 1526, 1279, 1411, 1695, 1208, 1349, 1329, 853, 947, 899, 891, - 926, 867, 896, 1078, 1070, 1086 - ] - }, - { - "title": "Type Aliases", - "children": [ - 862, 738, 737, 1201, 993, 1269, 1266, 1276, 1273, 1192, 1196, 1191, 1193, 1194, 1195, 1311, - 1187, 1310, 1312, 1203, 1197, 1188, 1186, 1179, 1565, 1566, 1572, 1573, 820, 1671, 1668, - 1660, 1661, 1667, 1665, 1658, 1659, 1666, 811, 815, 825, 829, 1292, 1471, 1381, 1447, 1515, - 1514, 1434, 1091, 1050, 1051, 781, 880, 879, 1138, 1128, 1147, 1152, 1148, 1159, 1133, 1122, - 748, 1289, 1313, 1511, 739, 1178, 1177, 1175, 1174, 1176, 1160, 1308, 1307, 1309, 1173, - 1161, 1172, 1165, 1164, 1166, 1170, 1089, 1546, 1552, 1365, 1359, 1399, 1363, 1398, 1361, - 1364, 1362, 1567, 1562, 834, 1435, 1300, 1293, 1612, 1617, 1655, 1621, 1607, 1598, 1603, - 1651, 789, 736, 1633, 794, 803, 1319, 1093, 957, 1007, 995, 1627, 971, 976, 1107, 1304, - 1358, 963, 1017, 1033, 847, 1642, 791, 1286, 1492, 1390, 850, 1069, 1647, 1638, 785, 784, - 1068 - ] - }, - { - "title": "Variables", - "children": [710, 711, 725, 1357] - }, - { - "title": "Functions", - "children": [1705, 1702, 1711, 1714, 1720, 1717, 1708, 1723, 712, 728] - } - ], - "packageName": "@supabase/auth-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Auth JS SDK

    \n\n

    An isomorphic JavaScript SDK for the Supabase Auth API.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/auth-js)](https://www.npmjs.com/package/@supabase/auth-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/auth-js)](https://pkg.pr.new/~/supabase/auth-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Quick start\n\nInstall\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install --save @supabase/auth-js\n```" - }, - { - "kind": "text", - "text": "\n\nUsage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst GOTRUE_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: GOTRUE_URL })\n```" - }, - { - "kind": "text", - "text": "\n\n- " - }, - { - "kind": "code", - "text": "`signUp()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signup\n- " - }, - { - "kind": "code", - "text": "`signIn()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signin\n- " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signout\n\n### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`auth-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst AUTH_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: AUTH_URL, fetch: fetch })\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build auth-js\n\n# Build with watch mode for development\npnpm nx build auth-js --watch\n\n# Individual build targets\npnpm nx build:main auth-js # CommonJS build (dist/main/)\npnpm nx build:module auth-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx lint auth-js # Run ESLint\npnpm nx typecheck auth-js # TypeScript type checking\npnpm nx docs auth-js # Generate documentation\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\n### Testing\n\nThe auth-js package has two test suites:\n\n1. **CLI Tests** - Main test suite using Supabase CLI (331 tests)\n2. **Docker Tests** - Edge case tests requiring specific GoTrue configurations (11 tests)\n\n#### Prerequisites\n\n- **Supabase CLI** - Required for main test suite ([installation guide](https://supabase.com/docs/guides/cli))\n- **Docker** - Required for edge case tests\n\n#### Running Tests\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run main test suite with Supabase CLI (recommended)\npnpm nx test:auth auth-js\n\n# Run Docker-only edge case tests\npnpm nx test:docker auth-js\n\n# Run both test suites\npnpm nx test:auth auth-js && pnpm nx test:docker auth-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Main Test Suite (Supabase CLI)\n\nThe " - }, - { - "kind": "code", - "text": "`test:auth`" - }, - { - "kind": "text", - "text": " command automatically:\n\n1. Stops any existing Supabase instance\n2. Starts a local Supabase instance via CLI\n3. Runs the test suite (excludes " - }, - { - "kind": "code", - "text": "`docker-tests/`" - }, - { - "kind": "text", - "text": " folder)\n4. Cleans up after tests complete\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Individual commands for manual control\npnpm nx test:infra auth-js # Start Supabase CLI\npnpm nx test:suite auth-js # Run tests only\npnpm nx test:clean-post auth-js # Stop Supabase CLI\n```" - }, - { - "kind": "text", - "text": "\n\n#### Docker Tests (Edge Cases)\n\nThe " - }, - { - "kind": "code", - "text": "`test:docker`" - }, - { - "kind": "text", - "text": " target runs tests that require specific GoTrue configurations not possible with a single Supabase CLI instance:\n\n- **Signup disabled** - Tests for disabled signup functionality\n- **Asymmetric JWT (RS256)** - Tests for RS256 JWT verification\n- **Phone OTP / SMS** - Tests requiring Twilio SMS provider\n- **Anonymous sign-in disabled** - Tests for disabled anonymous auth\n\nThese tests are located in " - }, - { - "kind": "code", - "text": "`test/docker-tests/`" - }, - { - "kind": "text", - "text": " and use the Docker Compose setup in " - }, - { - "kind": "code", - "text": "`infra/docker-compose.yml`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Individual commands for manual control\npnpm nx test:docker:infra auth-js # Start Docker containers\npnpm nx test:docker:suite auth-js # Run Docker tests only\npnpm nx test:docker:clean-post auth-js # Stop Docker containers\n```" - }, - { - "kind": "text", - "text": "\n\n#### Development Testing\n\nFor actively developing and debugging tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Start Supabase CLI once\npnpm nx test:infra auth-js\n\n# Run tests multiple times (faster since instance stays up)\npnpm nx test:suite auth-js\n\n# Clean up when done\npnpm nx test:clean-post auth-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure\n\n| Suite | Infrastructure | Configuration |\n| ------------ | -------------- | --------------------------- |\n| CLI Tests | Supabase CLI | " - }, - { - "kind": "code", - "text": "`test/supabase/config.toml`" - }, - { - "kind": "text", - "text": " |\n| Docker Tests | Docker Compose | " - }, - { - "kind": "code", - "text": "`infra/docker-compose.yml`" - }, - { - "kind": "text", - "text": " |\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "2": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.__constructor" - }, - "3": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__0" - }, - "5": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "6": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.url" - }, - "7": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.headers" - }, - "8": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "9": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "11": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.fetch" - }, - "12": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "13": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "14": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "15": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "16": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "17": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "18": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "19": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.experimental" - }, - "20": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.mfa" - }, - "21": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.oauth" - }, - "22": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.customProviders" - }, - "23": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.passkey" - }, - "38": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "39": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "40": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "jwt" - }, - "41": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "scope" - }, - "42": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "43": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "44": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "45": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "46": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "47": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "email" - }, - "48": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "options" - }, - "49": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "50": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "51": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.redirectTo" - }, - "52": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "53": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "54": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "55": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "56": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "57": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "58": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "59": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "60": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "61": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "62": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "63": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "64": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "65": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.aud" - }, - "66": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "67": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "69": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "71": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "72": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "73": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "74": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "75": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "76": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "77": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "78": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "79": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "80": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "81": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "id" - }, - "82": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "shouldSoftDelete" - }, - "136": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "138": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.__constructor" - }, - "139": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "140": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "142": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.admin" - }, - "143": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.mfa" - }, - "144": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.oauth" - }, - "145": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.passkey" - }, - "213": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "214": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "226": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "227": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "230": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "231": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "232": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "233": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "234": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "235": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "236": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "237": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "238": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "239": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "240": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "241": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "242": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "243": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "244": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "authCode" - }, - "245": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "246": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "247": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "248": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "249": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "250": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "251": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "252": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "253": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "254": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "255": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "256": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "257": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "258": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "259": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "298": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "299": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "300": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "301": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "302": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "303": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "304": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "305": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "306": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "307": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "308": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "309": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "310": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "311": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "314": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "315": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "316": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "317": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "318": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "319": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "320": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "321": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "322": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "323": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "324": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "325": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "326": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "327": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "328": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "329": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "330": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "331": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "332": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "333": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "380": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "381": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "382": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "386": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "387": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "388": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "389": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "390": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "391": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "398": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "399": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "400": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "401": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "402": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "403": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "410": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "411": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "412": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "413": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "414": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "451": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "452": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "453": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "454": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "455": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "461": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "462": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "463": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "464": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "465": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "466": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "467": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "468": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "469": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "470": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "471": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "472": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "473": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "474": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "475": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "476": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "477": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "478": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "479": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "480": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "481": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "485": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "486": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "487": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "email" - }, - "488": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "489": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "490": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.redirectTo" - }, - "491": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.captchaToken" - }, - "492": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "493": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "494": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "495": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "496": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "497": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "498": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "499": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "500": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "501": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "502": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "503": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "504": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.identities" - }, - "505": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "506": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "507": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "508": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "509": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "510": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "511": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "512": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "513": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "520": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "521": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "522": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "identity" - }, - "523": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "524": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "525": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "526": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "527": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "528": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "529": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "575": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "576": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "577": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "578": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "579": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "580": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "662": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "663": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "664": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "665": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "666": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "667": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "668": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.allowExpired" - }, - "669": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.jwks" - }, - "670": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "671": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "672": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "673": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "674": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "675": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.claims" - }, - "676": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.header" - }, - "677": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.signature" - }, - "678": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "679": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "680": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "681": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "682": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "683": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "684": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "685": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "686": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "687": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "688": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "689": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "690": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "710": { - "sourceFileName": "src/AuthAdminApi.ts", - "qualifiedName": "AuthAdminApi" - }, - "711": { - "sourceFileName": "src/AuthClient.ts", - "qualifiedName": "AuthClient" - }, - "712": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "713": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "714": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "R" - }, - "715": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "name" - }, - "716": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "717": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "fn" - }, - "718": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "719": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "720": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "721": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.__constructor" - }, - "722": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "723": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "message" - }, - "724": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.isAcquireTimeout" - }, - "725": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "internals" - }, - "726": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__object" - }, - "727": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__object.debug" - }, - "728": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "729": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "730": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "R" - }, - "731": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "name" - }, - "732": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "733": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "fn" - }, - "734": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "735": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "736": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Provider" - }, - "737": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthChangeEventMFA" - }, - "738": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthChangeEvent" - }, - "739": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "LockFunc" - }, - "740": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "741": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "742": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "name" - }, - "743": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "acquireTimeout" - }, - "744": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "fn" - }, - "745": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "746": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "747": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "R" - }, - "748": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueClientOptions" - }, - "749": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "750": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "751": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "752": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "753": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "755": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "756": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "757": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "758": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "url" - }, - "760": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "761": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "762": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "764": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "765": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "766": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "767": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "768": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "769": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "770": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "771": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "772": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "773": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "message" - }, - "774": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "args" - }, - "775": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "776": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.hasCustomAuthorizationHeader" - }, - "777": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "778": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "779": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "780": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "781": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ExperimentalFeatureFlags" - }, - "782": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "783": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkey" - }, - "784": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "785": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPassword" - }, - "786": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "787": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.reasons" - }, - "788": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "789": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Prettify" - }, - "790": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "791": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "StrictOmit" - }, - "792": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "793": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "794": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequestResult" - }, - "795": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "796": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "797": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "798": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "799": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "800": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "801": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "802": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorType" - }, - "803": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequestResultSafeDestructure" - }, - "804": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "805": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "806": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "807": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "808": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "809": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "810": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "811": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthResponse" - }, - "812": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "813": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "814": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "815": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthResponsePassword" - }, - "816": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "817": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "818": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "819": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.weak_password" - }, - "820": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOtpResponse" - }, - "821": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "822": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "823": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "824": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.messageId" - }, - "825": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthTokenResponse" - }, - "826": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "827": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "828": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "829": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthTokenResponsePassword" - }, - "830": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "831": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "832": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "833": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.weakPassword" - }, - "834": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthResponse" - }, - "835": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "836": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "837": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "838": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "839": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "840": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "841": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "842": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "843": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "844": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "845": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "846": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "847": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SSOResponse" - }, - "848": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "849": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "850": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserResponse" - }, - "851": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "852": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "853": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session" - }, - "854": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.provider_token" - }, - "855": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.provider_refresh_token" - }, - "856": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.access_token" - }, - "857": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.refresh_token" - }, - "858": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.expires_in" - }, - "859": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.expires_at" - }, - "860": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.token_type" - }, - "861": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.user" - }, - "862": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMRMethod" - }, - "863": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "864": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry" - }, - "865": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry.method" - }, - "866": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry.timestamp" - }, - "867": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity" - }, - "868": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.id" - }, - "869": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.user_id" - }, - "870": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_data" - }, - "871": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "874": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_id" - }, - "875": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.provider" - }, - "876": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.created_at" - }, - "877": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.last_sign_in_at" - }, - "878": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.updated_at" - }, - "879": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorType" - }, - "880": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Factor" - }, - "881": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "882": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "883": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "884": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factor_type" - }, - "885": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.status" - }, - "886": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "887": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "888": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.last_challenged_at" - }, - "889": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Type" - }, - "890": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Status" - }, - "891": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata" - }, - "892": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.provider" - }, - "893": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.providers" - }, - "894": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.__index" - }, - "896": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserMetadata" - }, - "897": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserMetadata.__index" - }, - "899": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User" - }, - "900": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.id" - }, - "901": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.app_metadata" - }, - "902": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.user_metadata" - }, - "903": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.aud" - }, - "904": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.confirmation_sent_at" - }, - "905": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.recovery_sent_at" - }, - "906": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email_change_sent_at" - }, - "907": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.new_email" - }, - "908": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.new_phone" - }, - "909": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.invited_at" - }, - "910": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.action_link" - }, - "911": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email" - }, - "912": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.phone" - }, - "913": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.created_at" - }, - "914": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.confirmed_at" - }, - "915": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email_confirmed_at" - }, - "916": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.phone_confirmed_at" - }, - "917": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.last_sign_in_at" - }, - "918": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.role" - }, - "919": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.updated_at" - }, - "920": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.identities" - }, - "921": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.is_anonymous" - }, - "922": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.is_sso_user" - }, - "923": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.factors" - }, - "924": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.deleted_at" - }, - "925": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.banned_until" - }, - "926": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes" - }, - "927": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.current_password" - }, - "928": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.email" - }, - "929": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.phone" - }, - "930": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.password" - }, - "931": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.nonce" - }, - "932": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.data" - }, - "933": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes" - }, - "934": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.user_metadata" - }, - "935": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.app_metadata" - }, - "936": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.email_confirm" - }, - "937": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.phone_confirm" - }, - "938": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.ban_duration" - }, - "939": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.role" - }, - "940": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.password_hash" - }, - "941": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.id" - }, - "942": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "nonce" - }, - "943": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "phone" - }, - "944": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "email" - }, - "945": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "password" - }, - "946": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "current_password" - }, - "947": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription" - }, - "948": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.id" - }, - "949": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.callback" - }, - "950": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "951": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "952": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "event" - }, - "953": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "session" - }, - "954": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.unsubscribe" - }, - "955": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "956": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "957": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInAnonymouslyCredentials" - }, - "958": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "959": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "960": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "961": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "962": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "963": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignUpWithPasswordCredentials" - }, - "964": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "965": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "966": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "967": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "968": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "969": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "970": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "971": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasswordCredentials" - }, - "972": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "973": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "974": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "975": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "976": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasswordlessCredentials" - }, - "977": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "978": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "979": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "980": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "981": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "982": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "983": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "984": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "985": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "986": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "987": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "988": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "989": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "990": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "991": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "992": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "993": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthFlowType" - }, - "994": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "995": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithOAuthCredentials" - }, - "996": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "997": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "998": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "999": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1000": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1001": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1002": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.queryParams" - }, - "1003": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1004": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1006": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1007": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithIdTokenCredentials" - }, - "1008": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1009": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1010": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1011": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token" - }, - "1012": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1013": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nonce" - }, - "1014": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1015": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1016": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1017": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SolanaWallet" - }, - "1018": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1019": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signIn" - }, - "1020": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1021": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1022": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "inputs" - }, - "1023": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.publicKey" - }, - "1024": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1025": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.toBase58" - }, - "1026": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1027": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1028": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signMessage" - }, - "1029": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1030": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1031": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "message" - }, - "1032": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "encoding" - }, - "1033": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SolanaWeb3Credentials" - }, - "1034": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1035": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1036": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1037": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1038": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1039": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1040": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1041": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1042": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signInWithSolana" - }, - "1043": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1044": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1045": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1046": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1047": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1048": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1049": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1050": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EthereumWallet" - }, - "1051": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EthereumWeb3Credentials" - }, - "1052": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1053": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1054": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1055": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1056": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1057": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1058": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1059": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1060": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signInWithEthereum" - }, - "1061": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1062": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1063": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1064": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1065": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1066": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1067": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1068": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Web3Credentials" - }, - "1069": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyOtpParams" - }, - "1070": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams" - }, - "1071": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.phone" - }, - "1072": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.token" - }, - "1073": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.type" - }, - "1074": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.options" - }, - "1075": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1076": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1077": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1078": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams" - }, - "1079": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.email" - }, - "1080": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.token" - }, - "1081": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.type" - }, - "1082": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.options" - }, - "1083": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1084": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1085": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1086": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams" - }, - "1087": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.token_hash" - }, - "1088": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.type" - }, - "1089": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MobileOtpType" - }, - "1090": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1091": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EmailOtpType" - }, - "1092": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1093": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ResendParams" - }, - "1094": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1095": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1096": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1097": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1098": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1099": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1100": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1101": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1102": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1103": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1104": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1105": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1106": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1107": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithSSO" - }, - "1108": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1109": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providerId" - }, - "1110": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1111": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1112": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1113": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1114": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1115": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1116": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.domain" - }, - "1117": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1118": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1119": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1120": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1121": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1122": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateSignupLinkParams" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1124": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1125": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1126": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.password" - }, - "1127": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1128": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateInviteOrMagiclinkParams" - }, - "1129": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1130": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1131": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1132": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1133": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateRecoveryLinkParams" - }, - "1134": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1135": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1136": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1137": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1138": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateEmailChangeLinkParams" - }, - "1139": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1140": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1141": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1142": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.newEmail" - }, - "1143": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1144": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions" - }, - "1145": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.data" - }, - "1146": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.redirectTo" - }, - "1147": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkParams" - }, - "1148": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkResponse" - }, - "1149": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1150": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.properties" - }, - "1151": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1152": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkProperties" - }, - "1153": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1154": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.action_link" - }, - "1155": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_otp" - }, - "1156": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.hashed_token" - }, - "1157": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_to" - }, - "1158": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.verification_type" - }, - "1159": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkType" - }, - "1160": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParams" - }, - "1161": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAUnenrollParams" - }, - "1162": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1163": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factorId" - }, - "1164": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParams" - }, - "1165": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParams" - }, - "1166": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFields" - }, - "1167": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1168": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.webauthn" - }, - "1169": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1170": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParams" - }, - "1171": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1172": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParams" - }, - "1173": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFATOTPChannel" - }, - "1174": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeTOTPParams" - }, - "1175": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParams" - }, - "1176": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParams" - }, - "1177": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParams" - }, - "1178": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyParams" - }, - "1179": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponseData" - }, - "1180": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1181": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1182": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_type" - }, - "1183": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_in" - }, - "1184": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.refresh_token" - }, - "1185": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1186": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponse" - }, - "1187": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponse" - }, - "1188": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAUnenrollResponse" - }, - "1189": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1190": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1191": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponse" - }, - "1192": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponse" - }, - "1193": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponse" - }, - "1194": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseDataJSON" - }, - "1195": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnServerResponse" - }, - "1196": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponse" - }, - "1197": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAListFactorsResponse" - }, - "1198": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1199": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.all" - }, - "1200": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1201": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthenticatorAssuranceLevels" - }, - "1202": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1203": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - }, - "1204": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1205": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.currentLevel" - }, - "1206": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nextLevel" - }, - "1207": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.currentAuthenticationMethods" - }, - "1208": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi" - }, - "1209": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1210": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1211": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1212": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1213": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1214": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1215": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1216": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1217": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1218": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1219": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1220": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1221": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1222": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1223": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1224": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1225": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1226": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1227": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1228": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1229": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1230": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1231": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1232": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1233": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1234": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1235": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1236": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1237": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1238": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1239": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1240": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1241": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1242": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1243": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1244": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1245": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1246": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1247": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1248": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1249": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1250": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1251": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1252": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1253": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1254": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "1255": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "1256": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1257": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "1258": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "1259": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1260": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "1261": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "1262": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "1263": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "1264": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "jwt" - }, - "1265": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.webauthn" - }, - "1266": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorResponse" - }, - "1267": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1268": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1269": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorParams" - }, - "1270": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1271": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1272": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1273": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsResponse" - }, - "1274": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1275": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factors" - }, - "1276": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsParams" - }, - "1277": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1278": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1279": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi" - }, - "1280": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "1281": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "1282": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1283": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "1284": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "1285": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1286": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupportedStorage" - }, - "1287": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1288": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.isServer" - }, - "1289": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "InitializeResult" - }, - "1290": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1291": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1292": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CallRefreshTokenResult" - }, - "1293": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Pagination" - }, - "1294": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1295": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nextPage" - }, - "1296": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lastPage" - }, - "1297": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.total" - }, - "1298": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1300": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PageParams" - }, - "1301": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1302": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.page" - }, - "1303": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.perPage" - }, - "1304": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignOut" - }, - "1305": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1306": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1307": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParams" - }, - "1308": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParams" - }, - "1309": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnParams" - }, - "1310": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponse" - }, - "1311": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponse" - }, - "1312": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnResponse" - }, - "1313": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtHeader" - }, - "1314": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1315": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.alg" - }, - "1316": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1317": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.kid" - }, - "1318": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.typ" - }, - "1319": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequiredClaims" - }, - "1320": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1321": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "1322": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "1323": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1324": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "1325": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "1326": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "1327": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "1328": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "1329": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload" - }, - "1330": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.email" - }, - "1331": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.phone" - }, - "1332": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.is_anonymous" - }, - "1333": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.jti" - }, - "1334": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.nbf" - }, - "1335": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.app_metadata" - }, - "1336": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.user_metadata" - }, - "1337": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.amr" - }, - "1338": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.ref" - }, - "1339": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "1340": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "1341": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1342": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "1343": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "1344": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "1345": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "1346": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "1347": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.__index" - }, - "1349": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK" - }, - "1350": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.kty" - }, - "1351": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1352": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.key_ops" - }, - "1353": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.alg" - }, - "1354": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.kid" - }, - "1355": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.__index" - }, - "1357": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SIGN_OUT_SCOPES" - }, - "1358": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignOutScope" - }, - "1359": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientGrantType" - }, - "1360": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1361": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientResponseType" - }, - "1362": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientType" - }, - "1363": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientRegistrationType" - }, - "1364": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientTokenEndpointAuthMethod" - }, - "1365": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClient" - }, - "1366": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1368": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1369": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1370": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_type" - }, - "1371": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1372": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.registration_type" - }, - "1373": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1374": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1375": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1376": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1377": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "1378": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1379": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1380": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1381": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CreateOAuthClientParams" - }, - "1382": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1383": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1384": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1385": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1386": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1387": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "1388": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1389": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1390": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UpdateOAuthClientParams" - }, - "1391": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1392": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1393": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1394": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1395": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1396": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1397": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1398": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientResponse" - }, - "1399": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientListResponse" - }, - "1400": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1401": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1402": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "1404": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1405": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1406": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1407": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1408": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1409": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "1410": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1411": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi" - }, - "1412": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "1413": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "1414": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1415": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "1416": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "1417": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1418": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "1419": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "1420": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1421": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "1422": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "1423": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1424": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1425": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "1426": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "1427": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1428": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1429": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1430": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1431": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "1432": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "1433": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1434": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderType" - }, - "1435": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OIDCDiscoveryDocument" - }, - "1436": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1437": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1438": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_endpoint" - }, - "1439": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint" - }, - "1440": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1441": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_endpoint" - }, - "1442": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.revocation_endpoint" - }, - "1443": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_scopes" - }, - "1444": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_response_types" - }, - "1445": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_subject_types" - }, - "1446": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_id_token_signing_algs" - }, - "1447": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomOAuthProvider" - }, - "1448": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1449": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1450": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "1451": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "1452": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1453": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1454": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1455": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1456": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1457": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1458": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1459": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1460": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1461": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1462": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1463": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1464": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1465": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1466": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1467": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1468": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_document" - }, - "1469": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1470": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1471": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CreateCustomProviderParams" - }, - "1472": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1473": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "1474": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "1475": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1476": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1477": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1478": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1479": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1480": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1481": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1482": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1483": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1484": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1485": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1486": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1487": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1488": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1489": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1490": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1491": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1492": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UpdateCustomProviderParams" - }, - "1493": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1494": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1495": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1496": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1497": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1498": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1499": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1500": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1501": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1502": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1503": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1504": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1505": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1506": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1507": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1508": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1509": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1510": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1511": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListCustomProvidersParams" - }, - "1512": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1513": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1514": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderResponse" - }, - "1515": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderListResponse" - }, - "1516": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1517": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1518": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1519": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "1520": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1521": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1522": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1523": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1524": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "1525": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1526": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi" - }, - "1527": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "1528": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "1529": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1530": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "1531": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "1532": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1533": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "1534": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "1535": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1536": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "1537": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "1538": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1539": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1540": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "1541": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "1542": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1543": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1544": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1545": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1546": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationClient" - }, - "1547": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1548": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1549": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1550": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.uri" - }, - "1551": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1552": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationDetails" - }, - "1553": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1554": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_id" - }, - "1555": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uri" - }, - "1556": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "1557": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1558": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1559": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1560": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1561": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1562": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthRedirect" - }, - "1563": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1564": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_url" - }, - "1565": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthAuthorizationDetailsResponse" - }, - "1566": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthConsentResponse" - }, - "1567": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthGrant" - }, - "1568": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1569": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "1570": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1571": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.granted_at" - }, - "1572": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthGrantsResponse" - }, - "1573": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthRevokeGrantResponse" - }, - "1574": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1575": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi" - }, - "1576": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "1577": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "1578": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1579": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "1580": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "1581": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1582": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1583": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1584": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1585": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "1586": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "1587": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1588": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1589": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1590": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1591": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "1592": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "1593": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "1594": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "1595": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1596": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1597": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clientId" - }, - "1598": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationOptionsResponse" - }, - "1599": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1600": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1601": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1602": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "1603": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationVerifyParams" - }, - "1604": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1605": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1606": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1607": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyMetadata" - }, - "1608": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1609": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1610": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1611": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1612": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationOptionsResponse" - }, - "1613": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1614": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1615": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1616": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "1617": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationVerifyParams" - }, - "1618": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1619": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1620": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1621": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyListItem" - }, - "1622": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1623": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1624": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1625": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1626": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.last_used_at" - }, - "1627": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasskeyCredentials" - }, - "1628": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1629": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1630": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1631": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1632": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "1633": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RegisterPasskeyCredentials" - }, - "1634": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1635": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1636": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1637": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "1638": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyPasskeyRegistrationParams" - }, - "1639": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1640": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "1641": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1642": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "StartPasskeyAuthenticationParams" - }, - "1643": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1644": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1645": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1646": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1647": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyPasskeyAuthenticationParams" - }, - "1648": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1649": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "1650": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1651": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyUpdateParams" - }, - "1652": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1653": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1654": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendlyName" - }, - "1655": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyDeleteParams" - }, - "1656": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1657": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1658": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationOptionsResponse" - }, - "1659": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationVerifyResponse" - }, - "1660": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationOptionsResponse" - }, - "1661": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationVerifyResponse" - }, - "1662": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1663": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1664": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1665": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyListResponse" - }, - "1666": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyUpdateResponse" - }, - "1667": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyDeleteResponse" - }, - "1668": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminListParams" - }, - "1669": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1670": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1671": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminDeleteParams" - }, - "1672": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1673": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1674": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1675": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi" - }, - "1676": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "1677": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "1678": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "1679": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "1680": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1681": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "1682": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "1683": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1684": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "1685": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "1686": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1687": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "1688": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "1689": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "1690": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "1691": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1692": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "1693": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "1694": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1695": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi" - }, - "1696": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "1697": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "1698": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1699": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "1700": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "1701": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1702": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "1703": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "1704": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1705": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "1706": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "1707": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1708": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "1709": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "1710": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1711": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "1712": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "1713": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1714": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "1715": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "1716": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1717": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "1718": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "1719": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1720": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "1721": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "1722": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1723": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "1724": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "1725": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1726": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "1727": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.__constructor" - }, - "1728": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "1729": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1730": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1731": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1732": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1733": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1734": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "1736": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1737": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1738": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1739": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1740": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1741": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1742": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1743": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1744": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "1745": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError.__constructor" - }, - "1746": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "1747": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1748": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1749": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1750": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError.status" - }, - "1751": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1752": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1754": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1755": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1756": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1757": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1758": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1759": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1760": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1761": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1762": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "1763": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.__constructor" - }, - "1764": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "1765": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1766": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "originalError" - }, - "1767": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.originalError" - }, - "1768": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1769": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1770": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "1772": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1773": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1774": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1775": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1776": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1777": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1778": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1779": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1780": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "1781": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.__constructor" - }, - "1782": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "1783": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1784": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "name" - }, - "1785": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1786": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1787": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1788": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1789": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1790": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1792": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1793": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1794": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1795": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1796": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1797": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1798": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1799": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1800": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "1801": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError.__constructor" - }, - "1802": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "1803": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1804": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1805": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1806": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1808": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1809": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1810": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1811": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1812": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1813": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1814": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1815": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1816": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "1817": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError.__constructor" - }, - "1818": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "1819": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1820": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1821": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1822": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1824": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1825": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1826": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1827": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1828": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1829": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1830": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1831": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1832": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "1833": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError.__constructor" - }, - "1834": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "1835": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1836": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1837": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1838": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1839": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1841": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1842": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1843": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1844": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1845": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1846": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1847": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1848": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1849": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "1850": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.__constructor" - }, - "1851": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "1852": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1853": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "details" - }, - "1854": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1855": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1856": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1857": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.details" - }, - "1858": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1859": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1860": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1861": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "1862": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "1863": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1864": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1865": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1866": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1867": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1868": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1869": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "1870": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1871": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1872": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1873": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1874": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1875": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1876": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1878": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "1879": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.__constructor" - }, - "1880": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "1881": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1882": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "details" - }, - "1883": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1884": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1885": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1886": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.details" - }, - "1887": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1888": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1889": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1890": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "1891": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "1892": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1893": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1894": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1895": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1896": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1897": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1898": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "1899": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1900": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1901": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1902": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1903": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1904": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1905": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1907": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "1908": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError.__constructor" - }, - "1909": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "1910": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1911": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1912": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1913": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1915": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1916": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1917": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1918": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1919": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1920": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1921": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1922": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1923": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "1924": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError.__constructor" - }, - "1925": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "1926": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1927": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1928": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1929": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1930": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1931": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1933": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1934": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1935": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1936": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1937": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1938": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1939": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1940": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1941": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "1942": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError.__constructor" - }, - "1943": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "1944": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1945": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1946": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1947": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1948": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1950": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1951": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1952": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1953": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1954": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1955": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1956": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1957": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1958": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "1959": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.__constructor" - }, - "1960": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "1961": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1962": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1963": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "reasons" - }, - "1964": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.reasons" - }, - "1965": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "1966": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "1967": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1968": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1969": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1970": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1971": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1972": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1973": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.reasons" - }, - "1974": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1975": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1976": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1977": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1979": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "1980": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError.__constructor" - }, - "1981": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "1982": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1983": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1984": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1985": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1986": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1988": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1989": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1990": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1991": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1992": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1993": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1994": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1995": { - "sourceFileName": "", - "qualifiedName": "__type" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json deleted file mode 100644 index 50e553a359d..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ /dev/null @@ -1,52557 +0,0 @@ -{ - "id": 0, - "name": "@supabase/auth-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1744, - "name": "AuthApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error returned directly from the GoTrue REST API." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthApiError } from '@supabase/auth-js'\n\nthrow new AuthApiError('Invalid credentials', 400, 'invalid_credentials')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1745, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L67" - } - ], - "signatures": [ - { - "id": 1746, - "name": "AuthApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L67" - } - ], - "parameters": [ - { - "id": 1747, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1748, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1749, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 1744, - "name": "AuthApiError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1751, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1750, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L65" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1754, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1755, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1756, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1760, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1761, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1758, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1757, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1759, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1760, 1758, 1757, 1759] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1745] - }, - { - "title": "Properties", - "children": [1751, 1750] - }, - { - "title": "Methods", - "children": [1754] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 64, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L64" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1726, - "name": "AuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error thrown by Supabase Auth helpers." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthError } from '@supabase/auth-js'\n\nthrow new AuthError('Unexpected auth error', 500, 'unexpected')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1727, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L28" - } - ], - "signatures": [ - { - "id": 1728, - "name": "AuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L28" - } - ], - "parameters": [ - { - "id": 1729, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1730, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1731, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 1732, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1733, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1734, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1736, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1737, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1738, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1742, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1743, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1740, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1739, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1741, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1742, 1740, 1739, 1741] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1727] - }, - { - "title": "Properties", - "children": [1732, 1734] - }, - { - "title": "Methods", - "children": [1736] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 14, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L14" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1744, - "name": "AuthApiError" - }, - { - "type": "reference", - "target": 1762, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError" - } - ] - }, - { - "id": 1849, - "name": "AuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when implicit grant redirects contain an error." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthImplicitGrantRedirectError } from '@supabase/auth-js'\n\nthrow new AuthImplicitGrantRedirectError('OAuth redirect failed', {\n error: 'access_denied',\n code: 'oauth_error',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1850, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "signatures": [ - { - "id": 1851, - "name": "AuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "parameters": [ - { - "id": 1852, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1853, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1854, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1856, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1855, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1856, 1855] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 191, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L191" - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1875, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1876, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1857, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1858, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1860, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1859, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1860, 1859] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 190, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L190" - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1873, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1874, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1861, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ], - "signatures": [ - { - "id": 1862, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1867, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 200, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L200" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1868, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1869, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1870, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1872, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1871, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1872, 1871] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 201, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L201" - } - ] - } - } - ] - } - }, - { - "id": 1865, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 198, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L198" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1864, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 197, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L197" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1866, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 199, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L199" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1867, 1869, 1865, 1864, 1866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 196, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L196" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1850] - }, - { - "title": "Properties", - "children": [1875, 1857, 1873, 1874] - }, - { - "title": "Methods", - "children": [1861] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 189, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L189" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1832, - "name": "AuthInvalidCredentialsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when email/password credentials are invalid." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidCredentialsError } from '@supabase/auth-js'\n\nthrow new AuthInvalidCredentialsError('Email or password is incorrect')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1833, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L171" - } - ], - "signatures": [ - { - "id": 1834, - "name": "AuthInvalidCredentialsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L171" - } - ], - "parameters": [ - { - "id": 1835, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1832, - "name": "AuthInvalidCredentialsError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1838, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1839, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1836, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1837, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1841, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1842, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1847, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1848, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1845, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1844, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1846, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1847, 1845, 1844, 1846] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1833] - }, - { - "title": "Properties", - "children": [1838, 1836, 1837] - }, - { - "title": "Methods", - "children": [1841] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 170, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L170" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1979, - "name": "AuthInvalidJwtError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a JWT cannot be verified or parsed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidJwtError } from '@supabase/auth-js'\n\nthrow new AuthInvalidJwtError('Token signature is invalid')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1980, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L388" - } - ], - "signatures": [ - { - "id": 1981, - "name": "AuthInvalidJwtError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L388" - } - ], - "parameters": [ - { - "id": 1982, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1979, - "name": "AuthInvalidJwtError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1985, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1986, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1983, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1984, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1988, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1989, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1990, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1994, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1995, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1992, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1991, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1993, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1994, 1992, 1991, 1993] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1980] - }, - { - "title": "Properties", - "children": [1985, 1983, 1984] - }, - { - "title": "Methods", - "children": [1988] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 387, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L387" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1816, - "name": "AuthInvalidTokenResponseError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the token response is malformed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidTokenResponseError } from '@supabase/auth-js'\n\nthrow new AuthInvalidTokenResponseError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1817, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L155" - } - ], - "signatures": [ - { - "id": 1818, - "name": "AuthInvalidTokenResponseError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L155" - } - ], - "type": { - "type": "reference", - "target": 1816, - "name": "AuthInvalidTokenResponseError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1821, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1822, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1819, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1820, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1824, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1825, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1826, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1830, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1831, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1828, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1827, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1829, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1830, 1828, 1827, 1829] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1817] - }, - { - "title": "Properties", - "children": [1821, 1819, 1820] - }, - { - "title": "Methods", - "children": [1824] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 154, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L154" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the PKCE code verifier is not found in storage.\nThis typically happens when the auth flow was initiated in a different\nbrowser, device, or the storage was cleared." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCECodeVerifierMissingError } from '@supabase/auth-js'\n\nthrow new AuthPKCECodeVerifierMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1908, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L261" - } - ], - "signatures": [ - { - "id": 1909, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L261" - } - ], - "type": { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1912, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1913, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1910, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1911, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1915, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1916, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1917, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1921, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1919, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1918, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1920, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1921, 1919, 1918, 1920] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1908] - }, - { - "title": "Properties", - "children": [1912, 1910, 1911] - }, - { - "title": "Methods", - "children": [1915] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 260, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L260" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1878, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown during PKCE code exchanges." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'\n\nthrow new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1879, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "signatures": [ - { - "id": 1880, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "parameters": [ - { - "id": 1881, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1882, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1883, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1885, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1884, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1885, 1884] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 229, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L229" - } - ] - } - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": 1878, - "name": "AuthPKCEGrantCodeExchangeError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1904, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1905, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1886, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1887, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1889, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1888, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1889, 1888] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 227, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L227" - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 1902, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1903, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1890, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ], - "signatures": [ - { - "id": 1891, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1892, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1896, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 238, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L238" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1897, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1898, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1899, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1901, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1900, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1901, 1900] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 239, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L239" - } - ] - } - } - ] - } - }, - { - "id": 1894, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 236, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L236" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1893, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L235" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1895, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 237, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L237" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1896, 1898, 1894, 1893, 1895] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 234, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L234" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1879] - }, - { - "title": "Properties", - "children": [1904, 1886, 1902, 1903] - }, - { - "title": "Methods", - "children": [1890] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 226, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L226" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1941, - "name": "AuthRefreshDiscardedError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returned when the server rotated a refresh token successfully but the\nclient chose not to persist the rotated tokens because the local session\nchanged mid-flight. Usually means a concurrent " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " cleared storage\nbetween when the refresh started and when it came back.\n\nSet on the " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " field of the refresh result so callers can tell \"we\ngot rotated tokens but threw them away\" apart from \"the refresh failed.\"\nThe rotated session on the server will be picked up on the next refresh\nvia GoTrue's parent-of-active path." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { isAuthRefreshDiscardedError } from '@supabase/auth-js'\n\nif (isAuthRefreshDiscardedError(error)) {\n // Concurrent signOut/sign-in raced our refresh. Treat as a no-op.\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1942, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L321" - } - ], - "signatures": [ - { - "id": 1943, - "name": "AuthRefreshDiscardedError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L321" - } - ], - "parameters": [ - { - "id": 1944, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'Refresh result discarded: session state changed mid-flight (e.g., concurrent signOut)'" - } - ], - "type": { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1947, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1948, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1945, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1946, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1950, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1951, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1952, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1956, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1957, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1954, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1953, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1955, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1956, 1954, 1953, 1955] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1942] - }, - { - "title": "Properties", - "children": [1947, 1945, 1946] - }, - { - "title": "Methods", - "children": [1950] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 320, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L320" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1923, - "name": "AuthRetryableFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a transient fetch issue occurs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthRetryableFetchError } from '@supabase/auth-js'\n\nthrow new AuthRetryableFetchError('Service temporarily unavailable', 503)\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1924, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 291, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L291" - } - ], - "signatures": [ - { - "id": 1925, - "name": "AuthRetryableFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 291, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L291" - } - ], - "parameters": [ - { - "id": 1926, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1927, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1930, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1931, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1928, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1929, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1933, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1934, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1935, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1939, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1940, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1937, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1936, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1938, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1939, 1937, 1936, 1938] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1924] - }, - { - "title": "Properties", - "children": [1930, 1928, 1929] - }, - { - "title": "Methods", - "children": [1933] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 290, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L290" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1800, - "name": "AuthSessionMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when an operation requires a session but none is present." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthSessionMissingError } from '@supabase/auth-js'\n\nthrow new AuthSessionMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1801, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 135, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L135" - } - ], - "signatures": [ - { - "id": 1802, - "name": "AuthSessionMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 135, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L135" - } - ], - "type": { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1805, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1806, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1803, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1804, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1808, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1809, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1810, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1814, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1815, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1812, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1811, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1813, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1814, 1812, 1811, 1813] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1801] - }, - { - "title": "Properties", - "children": [1805, 1803, 1804] - }, - { - "title": "Methods", - "children": [1808] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 134, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L134" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1762, - "name": "AuthUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps non-standard errors so callers can inspect the root cause." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthUnknownError } from '@supabase/auth-js'\n\ntry {\n await someAuthCall()\n} catch (err) {\n throw new AuthUnknownError('Auth failed', err)\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1763, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L96" - } - ], - "signatures": [ - { - "id": 1764, - "name": "AuthUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 96, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L96" - } - ], - "parameters": [ - { - "id": 1765, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1766, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 1762, - "name": "AuthUnknownError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1768, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1767, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L94" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1770, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1772, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1773, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1774, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1778, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1776, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1775, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1777, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1778, 1776, 1775, 1777] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1763] - }, - { - "title": "Properties", - "children": [1768, 1767, 1770] - }, - { - "title": "Methods", - "children": [1772] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 93, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L93" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1958, - "name": "AuthWeakPasswordError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a supplied password is considered weak." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthWeakPasswordError } from '@supabase/auth-js'\n\nthrow new AuthWeakPasswordError('Password too short', 400, ['min_length'])\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1959, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 353, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L353" - } - ], - "signatures": [ - { - "id": 1960, - "name": "AuthWeakPasswordError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 353, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L353" - } - ], - "parameters": [ - { - "id": 1961, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1962, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1963, - "name": "reasons", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1782, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1781, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 1976, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1977, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1789, - "name": "CustomAuthError.code" - } - }, - { - "id": 1974, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1787, - "name": "CustomAuthError.name" - } - }, - { - "id": 1964, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reasons why the password is deemed weak." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L351" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 1975, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1788, - "name": "CustomAuthError.status" - } - }, - { - "id": 1965, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ], - "signatures": [ - { - "id": 1966, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1967, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1971, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 363, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L363" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1972, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1969, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 361, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L361" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1968, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 360, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L360" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1973, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 364, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L364" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 1970, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 362, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L362" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1971, 1969, 1968, 1973, 1970] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 359, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L359" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1793, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1792, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1959] - }, - { - "title": "Properties", - "children": [1976, 1974, 1964, 1975] - }, - { - "title": "Methods", - "children": [1965] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 347, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L347" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1780, - "name": "CustomAuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Flexible error class used to create named auth errors at runtime." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { CustomAuthError } from '@supabase/auth-js'\n\nthrow new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 1781, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L117" - } - ], - "signatures": [ - { - "id": 1782, - "name": "CustomAuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L117" - } - ], - "parameters": [ - { - "id": 1783, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1784, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1785, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1786, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 1780, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 1728, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1727, - "name": "AuthError.constructor" - } - }, - { - "id": 1789, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1732, - "name": "AuthError.code" - } - }, - { - "id": 1787, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "AuthError.name" - } - }, - { - "id": 1788, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1734, - "name": "AuthError.status" - } - }, - { - "id": 1792, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "signatures": [ - { - "id": 1793, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1798, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 39, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L39" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1799, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1796, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1795, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 36, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1797, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 38, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L38" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1798, 1796, 1795, 1797] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 35, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L35" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1737, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1736, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1781] - }, - { - "title": "Properties", - "children": [1789, 1787, 1788] - }, - { - "title": "Methods", - "children": [1792] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 113, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L113" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "target": 1816, - "name": "AuthInvalidTokenResponseError" - }, - { - "type": "reference", - "target": 1832, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "target": 1878, - "name": "AuthPKCEGrantCodeExchangeError" - }, - { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError" - }, - { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError" - }, - { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError" - }, - { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError" - }, - { - "type": "reference", - "target": 1979, - "name": "AuthInvalidJwtError" - } - ] - }, - { - "id": 1, - "name": "GoTrueAdminApi", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 92, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L92" - } - ], - "signatures": [ - { - "id": 3, - "name": "GoTrueAdminApi", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an admin API client that can be used to manage users and OAuth clients." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\nconst { data, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueAdminApi } from '@supabase/auth-js'\n\nconst admin = new GoTrueAdminApi({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { Authorization: `Bearer ${process.env.SUPABASE_SECRET_KEY}` },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 92, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L92" - } - ], - "parameters": [ - { - "id": 4, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 19, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 103, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L103" - } - ], - "type": { - "type": "reference", - "target": 781, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 11, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 102, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L102" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 13, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 14, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 15, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 16, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 17, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 18, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 7, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 99, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L99" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 8, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 99, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L99" - } - ], - "indexSignatures": [ - { - "id": 9, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L100" - } - ], - "parameters": [ - { - "id": 10, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 6, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 98, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L98" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - } - ], - "groups": [ - { - "title": "Properties", - "children": [19, 11, 7, 6] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 97, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L97" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 22, - "name": "customProviders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L55" - } - ], - "type": { - "type": "reference", - "target": 1526, - "name": "GoTrueAdminCustomProvidersApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 20, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all MFA administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 46, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L46" - } - ], - "type": { - "type": "reference", - "target": 1279, - "name": "GoTrueAdminMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 21, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 52, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L52" - } - ], - "type": { - "type": "reference", - "target": 1411, - "name": "GoTrueAdminOAuthApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 23, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all passkey administration methods.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L62" - } - ], - "type": { - "type": "reference", - "target": 1695, - "name": "GoTrueAdminPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 55, - "name": "createUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 485, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L485" - } - ], - "signatures": [ - { - "id": 56, - "name": "createUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To confirm the user's email address or phone number, set " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " to true. Both arguments default to false.\n- " - }, - { - "kind": "code", - "text": "`createUser()`" - }, - { - "kind": "text", - "text": " will not send a confirmation email to the user. You can use [" - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " param to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "With custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n password: 'password',\n user_metadata: { name: 'Yoda' }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With custom user metadata\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n email_confirm: true\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n phone: '1234567890',\n phone_confirm: true\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 485, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L485" - } - ], - "parameters": [ - { - "id": 57, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 933, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 79, - "name": "deleteUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 839, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L839" - } - ], - "signatures": [ - { - "id": 80, - "name": "deleteUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a user. Requires a " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`deleteUser()`" - }, - { - "kind": "text", - "text": " method requires the user's ID, which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Removes a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.deleteUser(\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Removes a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {}\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 839, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L839" - } - ], - "parameters": [ - { - "id": 81, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user id you want to remove." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 82, - "name": "shouldSoftDelete", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 52, - "name": "generateLink", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 375, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L375" - } - ], - "signatures": [ - { - "id": 53, - "name": "generateLink", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates email links and OTPs to be sent via a custom email provider." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The following types can be passed into " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": ": " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_current`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_new`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " only generates the email link for " - }, - { - "kind": "code", - "text": "`email_change_email`" - }, - { - "kind": "text", - "text": " if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " handles the creation of the user for " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Generate a signup link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'signup',\n email: 'email@example.com',\n password: 'secret'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Generate a signup link\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"properties\": {\n \"action_link\": \"\",\n \"email_otp\": \"999999\",\n \"hashed_token\": \"\",\n \"verification_type\": \"signup\"\n },\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"email@example.com\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"email@example.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate an invite link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'invite',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a magic link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'magiclink',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a recovery link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'recovery',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate links to change current email address", - "content": [ - { - "kind": "code", - "text": "```js\n// generate an email change link to be sent to the current email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_current',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n\n// generate an email change link to be sent to the new email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_new',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 375, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L375" - } - ], - "parameters": [ - { - "id": 54, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1147, - "name": "GenerateLinkParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1148, - "name": "GenerateLinkResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 72, - "name": "getUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 628, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L628" - } - ], - "signatures": [ - { - "id": 73, - "name": "getUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get user by id." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Fetches the user object from the database based on the user's id.\n- The " - }, - { - "kind": "code", - "text": "`getUserById()`" - }, - { - "kind": "text", - "text": " method requires the user's id which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Fetch the user object using the access_token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.getUserById(1)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Fetch the user object using the access_token jwt\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 628, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L628" - } - ], - "parameters": [ - { - "id": 74, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 45, - "name": "inviteUserByEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 232, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L232" - } - ], - "signatures": [ - { - "id": 46, - "name": "inviteUserByEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends an invite link to an email address." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Sends an invite link to the user's email address.\n- The " - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": " method is typically used by administrators to invite users to join the application.\n- Note that PKCE is not supported when using " - }, - { - "kind": "code", - "text": "`inviteUserByEmail`" - }, - { - "kind": "text", - "text": ". This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow." - } - ] - }, - { - "tag": "@example", - "name": "Invite a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Invite a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"invited_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 232, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L232" - } - ], - "parameters": [ - { - "id": 47, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options to be included when inviting." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 49, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 50, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store additional metadata about the user. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.user_metadata`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 236, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L236" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 51, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 239, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L239" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [50, 51] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 234, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L234" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 58, - "name": "listUsers", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 526, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L526" - } - ], - "signatures": [ - { - "id": 59, - "name": "listUsers", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Defaults to return 50 users per page." - } - ] - }, - { - "tag": "@example", - "name": "Get a page of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Paginated list of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\n page: 1,\n perPage: 1000\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 526, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L526" - } - ], - "parameters": [ - { - "id": 60, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object which supports " - }, - { - "kind": "code", - "text": "`page`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`perPage`" - }, - { - "kind": "text", - "text": " as numbers, to alter the paginated results." - } - ] - }, - "type": { - "type": "reference", - "target": 1300, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 61, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 62, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 63, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 65, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 64, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [65, 64] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ] - } - }, - { - "type": "reference", - "target": 1293, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 66, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [62, 66] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 529, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L529" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 68, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 70, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [70] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ] - } - } - }, - { - "id": 71, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [68, 71] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 530, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L530" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 38, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 142, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L142" - } - ], - "signatures": [ - { - "id": 39, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a logged-in session." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 142, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L142" - } - ], - "parameters": [ - { - "id": 40, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A valid, logged-in JWT." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 41, - "name": "scope", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logout sope." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 42, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 43, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 44, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [43, 44] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 145, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L145" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 75, - "name": "updateUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 789, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L789" - } - ], - "signatures": [ - { - "id": 76, - "name": "updateUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the user data. Changes are applied directly without confirmation flows." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "**Important:** This is a server-side operation and does **not** trigger client-side\n" - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " listeners. The admin API has no connection to client state.\n\nTo sync changes to the client after calling this method:\n1. On the client, call " - }, - { - "kind": "code", - "text": "`supabase.auth.refreshSession()`" - }, - { - "kind": "text", - "text": " to fetch the updated user data\n2. This will trigger the " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event and notify all listeners" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\n// Server-side (Edge Function)\nconst { data, error } = await supabase.auth.admin.updateUserById(\n userId,\n { user_metadata: { preferences: { theme: 'dark' } } }\n)\n\n// Client-side (to sync the changes)\nconst { data, error } = await supabase.auth.refreshSession()\n// onAuthStateChange listeners will now be notified with updated user\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.refreshSession", - "target": 410 - }, - { - "kind": "text", - "text": " for syncing admin changes to the client" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.updateUser", - "target": 386 - }, - { - "kind": "text", - "text": " for client-side user updates (triggers listeners automatically)" - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '11111111-1111-1111-1111-111111111111',\n { email: 'new@email.com' }\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updates a user's email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"new@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { password: 'new_password' }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { user_metadata: { hello: 'world' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's app_metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { app_metadata: { plan: 'trial' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's email address", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { email_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { phone_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Ban a user for 100 years", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { ban_duration: '876000h' }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 789, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L789" - } - ], - "parameters": [ - { - "id": 77, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "reference", - "target": 933, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [22, 20, 21, 23] - }, - { - "title": "Methods", - "children": [55, 79, 52, 72, 45, 58, 38, 75] - } - ], - "categories": [ - { - "title": "Auth", - "children": [55, 79, 52, 72, 45, 58, 38, 75] - }, - { - "title": "Other", - "children": [2, 22, 20, 21, 23] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", - "line": 44, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueAdminApi.ts#L44" - } - ] - }, - { - "id": 136, - "name": "GoTrueClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 138, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L366" - } - ], - "signatures": [ - { - "id": 139, - "name": "GoTrueClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueClient } from '@supabase/auth-js'\n\nconst auth = new GoTrueClient({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { apikey: 'your-publishable-key' },\n storageKey: 'supabase-auth',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L366" - } - ], - "parameters": [ - { - "id": 140, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 748, - "name": "GoTrueClientOptions", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": 136, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 142, - "name": "admin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 234, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L234" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - }, - { - "id": 143, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the MFA methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L238" - } - ], - "type": { - "type": "reference", - "target": 1208, - "name": "GoTrueMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 144, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the OAuth 2.1 authorization server methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\nUsed to implement the authorization code flow on the consent page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 244, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L244" - } - ], - "type": { - "type": "reference", - "target": 1575, - "name": "AuthOAuthServerApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 145, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for passkey methods.\nIncludes lower-level two-step registration/authentication and passkey management.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 251, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L251" - } - ], - "type": { - "type": "reference", - "target": 1675, - "name": "AuthPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 579, - "name": "dispose", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5189, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5189" - } - ], - "signatures": [ - { - "id": 580, - "name": "dispose", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tears down the client's background work: stops the auto-refresh interval,\nremoves the " - }, - { - "kind": "code", - "text": "`visibilitychange`" - }, - { - "kind": "text", - "text": " listener, closes the cross-tab\n" - }, - { - "kind": "code", - "text": "`BroadcastChannel`" - }, - { - "kind": "text", - "text": ", and clears registered " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " subscribers.\n\nCall this from cleanup hooks when the client is being replaced before\nits JS realm is destroyed. React Strict Mode and HMR are the common\ncases. Any in-flight " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " calls continue to completion and may still\nwrite to storage; dispose doesn't abort them or erase storage.\n\nLifecycle caveat: because in-flight refreshes are not aborted, a\ndisposed instance can still persist a rotated session to storage after\n" - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " returns. A subsequent " - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " against the same\n" - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " will pick up that session on its next read. If you need\nstrict isolation between client lifecycles, await any pending auth\noperation before calling " - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " (or change the " - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " for\nthe replacement client).\n\nSafe to call repeatedly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup on React unmount", - "content": [ - { - "kind": "code", - "text": "```ts\nuseEffect(() => {\n const client = createClient(...)\n return () => { client.auth.dispose() }\n}, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5189, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5189" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 242, - "name": "exchangeCodeForSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1453, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1453" - } - ], - "signatures": [ - { - "id": 243, - "name": "exchangeCodeForSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Used when " - }, - { - "kind": "code", - "text": "`flowType`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`pkce`" - }, - { - "kind": "text", - "text": " in client options." - } - ] - }, - { - "tag": "@example", - "name": "Exchange Auth Code", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Exchange Auth Code\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n session: {\n access_token: '',\n token_type: 'bearer',\n expires_in: 3600,\n expires_at: 1700000000,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com'\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n \"provider\": \"email\",\n \"providers\": [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n provider_token: '',\n provider_refresh_token: ''\n },\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n redirectType: null\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1453, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1453" - } - ], - "parameters": [ - { - "id": 244, - "name": "authCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 662, - "name": "getClaims", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6145" - } - ], - "signatures": [ - { - "id": 663, - "name": "getClaims", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" - }, - { - "kind": "code", - "text": "`/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": ") to verify the JWT." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\n- A network request is sent to your project's JWT signing key discovery endpoint " - }, - { - "kind": "code", - "text": "`https://project-id.supabase.co/auth/v1/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": ", which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook)." - } - ] - }, - { - "tag": "@example", - "name": "Get JWT claims, header and signature", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getClaims()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get JWT claims, header and signature\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"claims\": {\n \"aal\": \"aal1\",\n \"amr\": [{\n \"method\": \"email\",\n \"timestamp\": 1715766000\n }],\n \"app_metadata\": {},\n \"aud\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"exp\": 1715769600,\n \"iat\": 1715766000,\n \"is_anonymous\": false,\n \"iss\": \"https://project-id.supabase.co/auth/v1\",\n \"phone\": \"+13334445555\",\n \"role\": \"authenticated\",\n \"session_id\": \"11111111-1111-1111-1111-111111111111\",\n \"sub\": \"11111111-1111-1111-1111-111111111111\",\n \"user_metadata\": {}\n },\n \"header\": {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"signature\": [/** Uint8Array */],\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6145" - } - ], - "parameters": [ - { - "id": 664, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getSession" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Various additional options that allow you to customize the\n behavior of this method." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 666, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 668, - "name": "allowExpired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " the " - }, - { - "kind": "code", - "text": "`exp`" - }, - { - "kind": "text", - "text": " claim will not be validated against the current time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6154, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6154" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 669, - "name": "jwks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 670, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 671, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1349, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [671] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6157, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6157" - } - ] - } - } - }, - { - "id": 667, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Please use options.jwks instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6151, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6151" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1349, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [668, 669, 667] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6147, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6147" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 673, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 674, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 675, - "name": "claims", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": 1329, - "name": "JwtPayload", - "package": "@supabase/auth-js" - } - }, - { - "id": 676, - "name": "header", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": 1313, - "name": "JwtHeader", - "package": "@supabase/auth-js" - } - }, - { - "id": 677, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [675, 676, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6161, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6161" - } - ] - } - } - }, - { - "id": 678, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6162, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6162" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [673, 678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6160" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 679, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 680, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 681, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [680, 681] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6164" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 682, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 683, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 684, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [683, 684] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6165, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6165" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 317, - "name": "getSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2719, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2719" - } - ], - "signatures": [ - { - "id": 318, - "name": "getSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser()" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " instead.\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\n- The session contains an access token (signed JWT), a refresh token and the user object.\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\n- When using in a browser, or you've called " - }, - { - "kind": "code", - "text": "`startAutoRefresh()`" - }, - { - "kind": "text", - "text": " in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or your own JWT verification library to securely establish the user's identity and access. You can also use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch the user object directly from the Auth server for this purpose.\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed." - } - ] - }, - { - "tag": "@example", - "name": "Get the session data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getSession()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the session data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2719, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2719" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 320, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2820, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2820" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 322, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2821, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2821" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [322] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2820, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2820" - } - ] - } - } - }, - { - "id": 323, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2823, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2823" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [320, 323] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2819, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2819" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 324, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 325, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2826, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2826" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 326, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 327, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2827, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2827" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [327] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2826, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2826" - } - ] - } - } - }, - { - "id": 328, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2829, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2829" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [325, 328] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2825, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2825" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 330, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2832, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2832" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 332, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2833, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2833" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [332] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2832, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2832" - } - ] - } - } - }, - { - "id": 333, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2835, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2835" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [330, 333] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2831, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2831" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 380, - "name": "getUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3042, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3042" - } - ], - "signatures": [ - { - "id": 381, - "name": "getUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method fetches the user object from the database instead of local session.\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\n- Should always be used when checking for user authorization on the server. On the client, you can instead use " - }, - { - "kind": "code", - "text": "`getSession().session.user`" - }, - { - "kind": "text", - "text": " for faster results. " - }, - { - "kind": "code", - "text": "`getSession`" - }, - { - "kind": "text", - "text": " is insecure on the server." - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with the current existing session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the logged in user with the current existing session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with a custom access token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3042, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3042" - } - ], - "parameters": [ - { - "id": 382, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 499, - "name": "getUserIdentities", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4337" - } - ], - "signatures": [ - { - "id": 500, - "name": "getUserIdentities", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets all the identities linked to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`getUserIdentities()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Returns a list of identities linked to the user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getUserIdentities()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Returns a list of identities linked to the user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"2024-01-01T00:00:00Z\",\n \"user_id\": \"2024-01-01T00:00:00Z\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ]\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4337" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 501, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 502, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4339, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4339" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 503, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 504, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4340, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4340" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [504] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4339, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4339" - } - ] - } - } - }, - { - "id": 505, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4342, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4342" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [502, 505] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4338, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4338" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 506, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 507, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 508, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [507, 508] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4344, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4344" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 226, - "name": "initialize", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L544" - } - ], - "signatures": [ - { - "id": 227, - "name": "initialize", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L544" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1289, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 213, - "name": "isThrowOnErrorEnabled", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 506, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L506" - } - ], - "signatures": [ - { - "id": 214, - "name": "isThrowOnErrorEnabled", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns whether error throwing mode is enabled for this client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 506, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L506" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 509, - "name": "linkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`linkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- If the candidate identity is already linked to the existing user or another user, " - }, - { - "kind": "code", - "text": "`linkIdentity()`" - }, - { - "kind": "text", - "text": " will fail.\n- If " - }, - { - "kind": "code", - "text": "`linkIdentity`" - }, - { - "kind": "text", - "text": " is run in the browser, the user is automatically redirected to the returned URL. On the server, you should handle the redirect." - } - ] - }, - { - "tag": "@example", - "name": "Link an identity to a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.linkIdentity({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Link an identity to a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4362, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4362" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4367, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4367" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4396, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4396" - } - ], - "signatures": [ - { - "id": 510, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4362, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4362" - } - ], - "parameters": [ - { - "id": 511, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 995, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 834, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 512, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an OIDC identity to an existing user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4367, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4367" - } - ], - "parameters": [ - { - "id": 513, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1007, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 461, - "name": "onAuthStateChange", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Subscribes to important events occurring on the user's session.\n- Use on the frontend/client. It is less useful on the server.\n- Events are emitted across tabs to keep your application's UI up-to-date. Some events can fire very frequently, based on the number of tabs open. Use a quick and efficient callback function, and defer or debounce as many operations as you can to be performed outside of the callback.\n- Callbacks can be " - }, - { - "kind": "code", - "text": "`async`" - }, - { - "kind": "text", - "text": " and can safely call other Supabase auth methods (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", etc.) from inside the callback.\n- Keep callbacks quick. Events are awaited in order, so a slow callback delays subsequent events to subscribers in this tab.\n- Emitted events:\n - " - }, - { - "kind": "code", - "text": "`INITIAL_SESSION`" - }, - { - "kind": "text", - "text": "\n - Emitted right after the Supabase client is constructed and the initial session from storage is loaded.\n - " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": "\n - Emitted each time a user session is confirmed or re-established, including on user sign in and when refocusing a tab.\n - Avoid making assumptions as to when this event is fired, this may occur even when the user is already signed in. Instead, check the user object attached to the event to see if a new user has signed in and update your application's UI.\n - This event can fire very frequently depending on the number of tabs open in your application.\n - " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": "\n - Emitted when the user signs out. This can be after:\n - A call to " - }, - { - "kind": "code", - "text": "`supabase.auth.signOut()`" - }, - { - "kind": "text", - "text": ".\n - After the user's session has expired for any reason:\n - User has signed out on another device.\n - The session has reached its timebox limit or inactivity timeout.\n - User has signed in on another device with single session per user enabled.\n - Check the [User Sessions](/docs/guides/auth/sessions) docs for more information.\n - Use this to clean up any local storage your application has associated with the user.\n - " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": "\n - Emitted each time a new access and refresh token are fetched for the signed in user.\n - It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application.\n - Avoid frequent calls to " - }, - { - "kind": "code", - "text": "`supabase.auth.getSession()`" - }, - { - "kind": "text", - "text": " for the same purpose.\n - There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event.\n - The frequency of this event is related to the JWT expiry limit configured on your project.\n - " - }, - { - "kind": "code", - "text": "`USER_UPDATED`" - }, - { - "kind": "text", - "text": "\n - Emitted each time the " - }, - { - "kind": "code", - "text": "`supabase.auth.updateUser()`" - }, - { - "kind": "text", - "text": " method finishes successfully. Listen to it to update your application's UI based on new profile information.\n - " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": "\n - Emitted instead of the " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event when the user lands on a page that includes a password recovery link in the URL.\n - Use it to show a UI to the user where they can [reset their password](/docs/guides/auth/passwords#resetting-a-users-password-forgot-password)." - } - ] - }, - { - "tag": "@example", - "name": "Listen to auth changes", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase.auth.onAuthStateChange((event, session) => {\n console.log(event, session)\n\n if (event === 'INITIAL_SESSION') {\n // handle initial session\n } else if (event === 'SIGNED_IN') {\n // handle sign in event\n } else if (event === 'SIGNED_OUT') {\n // handle sign out event\n } else if (event === 'PASSWORD_RECOVERY') {\n // handle password recovery event\n } else if (event === 'TOKEN_REFRESHED') {\n // handle token refreshed event\n } else if (event === 'USER_UPDATED') {\n // handle user updated event\n }\n})\n\n// call unsubscribe to remove the callback\ndata.subscription.unsubscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to sign out\nMake sure you clear out any local data, such as local and session storage, after the client library has detected the user's sign out." - } - ] - }, - { - "tag": "@example", - "name": "Listen to sign out", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'SIGNED_OUT') {\n console.log('SIGNED_OUT', session)\n\n // clear local and session storage\n [\n window.localStorage,\n window.sessionStorage,\n ].forEach((storage) => {\n Object.entries(storage)\n .forEach(([key]) => {\n storage.removeItem(key)\n })\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Store OAuth provider tokens on sign in\nWhen using [OAuth (Social Login)](/docs/guides/auth/social-login) you sometimes wish to get access to the provider's access token and refresh token, in order to call provider APIs in the name of the user.\n\nFor example, if you are using [Sign in with Google](/docs/guides/auth/social-login/auth-google) you may want to use the provider token to call Google APIs on behalf of the user. Supabase Auth does not keep track of the provider access and refresh token, but does return them for you once, immediately after sign in. You can use the " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " method to listen for the presence of the provider tokens and store them in local storage. You can further send them to your server's APIs for use on the backend.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Store OAuth provider tokens on sign in", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Use React Context for the User's session\nInstead of relying on " - }, - { - "kind": "code", - "text": "`supabase.auth.getSession()`" - }, - { - "kind": "text", - "text": " within your React components, you can use a [React Context](https://react.dev/reference/react/createContext) to store the latest session information from the " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback and access it that way." - } - ] - }, - { - "tag": "@example", - "name": "Use React Context for the User's session", - "content": [ - { - "kind": "code", - "text": "```js\nconst SessionContext = React.createContext(null)\n\nfunction main() {\n const [session, setSession] = React.useState(null)\n\n React.useEffect(() => {\n const {data: { subscription }} = supabase.auth.onAuthStateChange(\n (event, session) => {\n if (event === 'SIGNED_OUT') {\n setSession(null)\n } else if (session) {\n setSession(session)\n }\n })\n\n return () => {\n subscription.unsubscribe()\n }\n }, [])\n\n return (\n \n \n \n )\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to password recovery events", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'PASSWORD_RECOVERY') {\n console.log('PASSWORD_RECOVERY', session)\n // show screen to update user's password\n showPasswordResetScreen(true)\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to sign in", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'SIGNED_IN') console.log('SIGNED_IN', session)\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to token refresh", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'TOKEN_REFRESHED') console.log('TOKEN_REFRESHED', session)\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to user updates", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'USER_UPDATED') console.log('USER_UPDATED', session)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - }, - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4128" - } - ], - "signatures": [ - { - "id": 462, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens.\nSafe to use without an async function as callback." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "parameters": [ - { - "id": 463, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 464, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "signatures": [ - { - "id": 465, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ], - "parameters": [ - { - "id": 466, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 467, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 469, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 471, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ], - "type": { - "type": "reference", - "target": 947, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [471] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3929, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3929" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [469] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3928, - "character": 90, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3928" - } - ] - } - } - }, - { - "id": 472, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens. Common reentry\npatterns (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", reading the session from inside a\nhandler) complete normally. One hazard remains: calling " - }, - { - "kind": "code", - "text": "`refreshSession`" - }, - { - "kind": "text", - "text": "\n(or anything that routes through " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": ") from inside a\n" - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " handler. " - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " resolves only after\n" - }, - { - "kind": "code", - "text": "`_notifyAllSubscribers`" - }, - { - "kind": "text", - "text": " returns, so the inner refresh dedupes onto the\nouter's unresolved promise and the two wait on each other." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Async callbacks can deadlock when they trigger a nested\nrefresh from a " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event. Prefer the sync overload, or move\nrefresh-triggering work outside the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "parameters": [ - { - "id": 473, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 474, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "signatures": [ - { - "id": 475, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ], - "parameters": [ - { - "id": 476, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 477, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 478, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 479, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 481, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ], - "type": { - "type": "reference", - "target": 947, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [481] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3948, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3948" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [479] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3947, - "character": 99, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3947" - } - ] - } - } - } - ] - }, - { - "id": 310, - "name": "reauthenticate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2497" - } - ], - "signatures": [ - { - "id": 311, - "name": "reauthenticate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used together with " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " when a user's password needs to be updated.\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\n- After receiving the OTP, include it as the " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " in your " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " call to finalize the password change." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Send reauthentication nonce\nSends a reauthentication nonce to the user's email or phone number." - } - ] - }, - { - "tag": "@example", - "name": "Send reauthentication nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.reauthenticate()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2497" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 410, - "name": "refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "signatures": [ - { - "id": 411, - "name": "refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method will refresh and return a new session whether the current one is expired or not." - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using the current session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession()\nconst { session, user } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Refresh session using the current session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using a refresh token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\nconst { session, user } = data\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "parameters": [ - { - "id": 412, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session. If passed in, it must contain a refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 414, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3619, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3619" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 688, - "name": "registerPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6325, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6325" - } - ], - "signatures": [ - { - "id": 689, - "name": "registerPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Register a passkey for the current authenticated user. Handles the full WebAuthn ceremony:\n1. Fetches registration challenge from server\n2. Prompts user via navigator.credentials.create()\n3. Verifies credential with server\n\nRequires an active session. Requires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6325, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6325" - } - ], - "parameters": [ - { - "id": 690, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1633, - "name": "RegisterPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 314, - "name": "resend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2593, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2593" - } - ], - "signatures": [ - { - "id": 315, - "name": "resend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Resends a signup confirmation, email change or phone change email to the user.\n- Passwordless sign-ins can be resent by calling the " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " method again.\n- Password recovery emails can be resent by calling the " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " method again.\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " again to resend the OTP).\n- You can specify a redirect url when you resend an email link using the " - }, - { - "kind": "code", - "text": "`emailRedirectTo`" - }, - { - "kind": "text", - "text": " option." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend an email signup confirmation\nResends the email signup confirmation to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend an email signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'signup',\n email: 'email@example.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend a phone signup confirmation\nResends the phone signup confirmation email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend a phone signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'sms',\n phone: '1234567890'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend email change email\nResends the email change email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend email change email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'email_change',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend phone change OTP\nResends the phone change OTP to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend phone change OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'phone_change',\n phone: '1234567890'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2593, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2593" - } - ], - "parameters": [ - { - "id": 316, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1093, - "name": "ResendParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 820, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 485, - "name": "resetPasswordForEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4253, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4253" - } - ], - "signatures": [ - { - "id": 486, - "name": "resetPasswordForEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a password reset request to an email address. This method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\n- The " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " only sends a password reset link to the user's email.\nTo update the user's password, see [" - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-updateuser).\n- A " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": " event will be emitted when the password recovery link is clicked.\nYou can use [" - }, - { - "kind": "code", - "text": "`onAuthStateChange()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\n- When the user clicks the reset link in the email they are redirected back to your application.\nYou can configure the URL that the user is redirected to with the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter.\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- After the user has been redirected successfully, prompt them for a new password and call " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": ":\n" - }, - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: new_password\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\n redirectTo: 'https://example.com/update-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Reset password\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {}\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password (React)", - "content": [ - { - "kind": "code", - "text": "```js\n/**\n * Step 1: Send the user an email to get a password reset token.\n * This email contains a link which sends the user back to your application.\n */\nconst { data, error } = await supabase.auth\n .resetPasswordForEmail('user@email.com')\n\n/**\n * Step 2: Once the user is redirected back to your application,\n * ask the user to reset their password.\n */\n useEffect(() => {\n supabase.auth.onAuthStateChange(async (event, session) => {\n if (event == \"PASSWORD_RECOVERY\") {\n const newPassword = prompt(\"What would you like your new password to be?\");\n const { data, error } = await supabase.auth\n .updateUser({ password: newPassword })\n\n if (data) alert(\"Password updated successfully!\")\n if (error) alert(\"There was an error updating your password.\")\n }\n })\n }, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4253, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4253" - } - ], - "parameters": [ - { - "id": 487, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 488, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 489, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 491, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4257, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4257" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 490, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to send the user to after they click the password reset link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4256, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4256" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [491, 490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4255, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4255" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 492, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 493, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4261, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4261" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 494, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 495, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4262, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4262" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [493, 495] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4260, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4260" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 496, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 497, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 498, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [497, 498] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4264, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4264" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 398, - "name": "setSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ], - "signatures": [ - { - "id": 399, - "name": "setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method sets the session using an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`refresh_token`" - }, - { - "kind": "text", - "text": ".\n- If successful, a " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event is emitted." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Set the session\nSets the session data from an access_token and refresh_token, then returns an auth response or error." - } - ] - }, - { - "tag": "@example", - "name": "Set the session", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.setSession({\n access_token,\n refresh_token\n })\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set the session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"11111111-1111-1111-1111-111111111111\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"2024-01-01T00:00:00Z\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"token_type\": \"bearer\",\n \"expires_in\": 3500,\n \"expires_at\": 1700000000\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ], - "parameters": [ - { - "id": 400, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session that minimally contains an access token and refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 401, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 402, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3421, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3421" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 403, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3422, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3422" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [402, 403] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3420, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3420" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 230, - "name": "signInAnonymously", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 722, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L722" - } - ], - "signatures": [ - { - "id": 231, - "name": "signInAnonymously", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new anonymous user." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A session where the is_anonymous claim in the access token JWT set to true" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Returns an anonymous user\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the " - }, - { - "kind": "code", - "text": "`options`" - }, - { - "kind": "text", - "text": " param." - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n captchaToken\n }\n});\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create an anonymous user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user with custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n data\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 722, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L722" - } - ], - "parameters": [ - { - "id": 232, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 957, - "name": "SignInAnonymouslyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 298, - "name": "signInWithIdToken", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2030, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2030" - } - ], - "signatures": [ - { - "id": 299, - "name": "signInWithIdToken", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use an ID token to sign in.\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API." - } - ] - }, - { - "tag": "@example", - "name": "Sign In using ID Token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithIdToken({\n provider: 'google',\n token: 'your-id-token'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign In using ID Token\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2030, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2030" - } - ], - "parameters": [ - { - "id": 300, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1007, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 825, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 239, - "name": "signInWithOAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1274" - } - ], - "signatures": [ - { - "id": 240, - "name": "signInWithOAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider with redirect\n- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter. This parameter defaults to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider with redirect", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n redirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with scopes and access provider tokens\nIf you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the " - }, - { - "kind": "code", - "text": "`scopes`" - }, - { - "kind": "text", - "text": " option takes in **a space-separated list** of scopes.\n\nBecause OAuth sign-in often includes redirects, you should register an " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback immediately after you create the Supabase client. This callback will listen for the presence of " - }, - { - "kind": "code", - "text": "`provider_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`provider_refresh_token`" - }, - { - "kind": "text", - "text": " properties on the " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with scopes and access provider tokens", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n\n// Call this on your Sign in with GitHub button to initiate OAuth\n// with GitHub with the requested elevated scopes.\nawait supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n scopes: 'repo gist notifications'\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1274" - } - ], - "parameters": [ - { - "id": 241, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 995, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 834, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 301, - "name": "signInWithOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2143" - } - ], - "signatures": [ - { - "id": 302, - "name": "signInWithOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " 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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email or phone number.\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\n- If the user doesn't exist, " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " will signup the user instead. To restrict this behavior, you can set " - }, - { - "kind": "code", - "text": "`shouldCreateUser`" - }, - { - "kind": "text", - "text": " in " - }, - { - "kind": "code", - "text": "`SignInWithPasswordlessCredentials.options`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ".\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\n- If you're using phone, you can configure whether you want the user to receive a OTP.\n- The magic link's destination URL is determined by the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": ".\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with email\nThe user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n email: 'example@email.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": null,\n \"session\": null\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with SMS OTP\nThe user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with SMS OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with WhatsApp OTP\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with WhatsApp OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n options: {\n channel:'whatsapp',\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2143" - } - ], - "parameters": [ - { - "id": 303, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 976, - "name": "SignInWithPasswordlessCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 820, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 685, - "name": "signInWithPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6267" - } - ], - "signatures": [ - { - "id": 686, - "name": "signInWithPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with a passkey. Handles the full WebAuthn ceremony:\n1. Fetches authentication challenge from server\n2. Prompts user via navigator.credentials.get()\n3. Verifies credential with server and creates session\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 6267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L6267" - } - ], - "parameters": [ - { - "id": 687, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1627, - "name": "SignInWithPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 236, - "name": "signInWithPassword", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1135" - } - ], - "signatures": [ - { - "id": 237, - "name": "signInWithPassword", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user with an email and password or phone and password.\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\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email and password or a phone number and password." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email and password\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with phone and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n phone: '+13334445555',\n password: 'some-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nLog the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so fields like " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " aren't hidden. The " - }, - { - "kind": "code", - "text": "`error.code`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`'invalid_credentials'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'email_not_confirmed'`" - }, - { - "kind": "text", - "text": ") is often more useful for branching than " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": ", and the full object surfaces both." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\nif (error) {\n console.error(error)\n return\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1135" - } - ], - "parameters": [ - { - "id": 238, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 971, - "name": "SignInWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 829, - "name": "AuthTokenResponsePassword", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 307, - "name": "signInWithSSO", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2434, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2434" - } - ], - "signatures": [ - { - "id": 308, - "name": "signInWithSSO", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\n- If you've associated an email domain to the identity provider, you can use the " - }, - { - "kind": "code", - "text": "`domain`" - }, - { - "kind": "text", - "text": " property to start a sign-in flow.\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the " - }, - { - "kind": "code", - "text": "`providerId`" - }, - { - "kind": "text", - "text": " property. For example:\n - Mapping specific user email addresses with an identity provider.\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email domain", - "content": [ - { - "kind": "code", - "text": "```js\n // You can extract the user's email domain and use it to trigger the\n // authentication flow with the correct identity provider.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n domain: 'company.com'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with provider UUID", - "content": [ - { - "kind": "code", - "text": "```js\n // Useful when you need to map a user's sign in request according\n // to different rules that can't use email domains.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2434, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2434" - } - ], - "parameters": [ - { - "id": 309, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1107, - "name": "SignInWithSSO", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 847, - "name": "SSOResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 245, - "name": "signInWithWeb3", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1554, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1554" - } - ], - "signatures": [ - { - "id": 246, - "name": "signInWithWeb3", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." - } - ], - "blockTags": [ - { - "tag": "@reference", - "content": [ - { - "kind": "text", - "text": "https://eips.ethereum.org/EIPS/eip-4361" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana or Ethereum (Window API)", - "content": [ - { - "kind": "code", - "text": "```js\n // uses window.ethereum for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n\n // uses window.solana for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Ethereum (Message and Signature)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n message: '',\n signature: '',\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Brave)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet: window.braveSolana\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Wallet Adapter)", - "content": [ - { - "kind": "code", - "text": "```jsx\n function SignInButton() {\n const wallet = useWallet()\n\n return (\n <>\n {wallet.connected ? (\n {\n supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet,\n })\n }}\n >\n Sign in with Solana\n \n ) : (\n \n )}\n \n )\n}\n\nfunction App() {\n const endpoint = clusterApiUrl('devnet')\n const wallets = useMemo(() => [], [])\n\n return (\n \n \n \n \n \n \n \n )\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1554, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1554" - } - ], - "parameters": [ - { - "id": 247, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1068, - "name": "Web3Credentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 248, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 249, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 250, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 251, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 252, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [251, 252] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1556, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1556" - } - ] - } - } - }, - { - "id": 253, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1557, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1557" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [249, 253] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1555, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1555" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 254, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 255, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 256, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 257, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 258, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [257, 258] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ] - } - } - }, - { - "id": 259, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [255, 259] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 1559, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L1559" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 451, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "signatures": [ - { - "id": 452, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inside a browser context, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " - }, - { - "kind": "code", - "text": "`\"SIGNED_OUT\"`" - }, - { - "kind": "text", - "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " - }, - { - "kind": "code", - "text": "`auth.api.signOut(JWT: string)`" - }, - { - "kind": "text", - "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " - }, - { - "kind": "code", - "text": "`others`" - }, - { - "kind": "text", - "text": " scope, no " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event is fired!\n\n**Warning:** the default " - }, - { - "kind": "code", - "text": "`scope`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`'global'`" - }, - { - "kind": "text", - "text": ". This signs the user out of\n**every device they are currently signed in on**, not just the current\ntab/session. If you only want to sign the user out of the current session\n(the behavior most other auth libraries default to), pass\n" - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " explicitly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " uses the **global** scope, which signs out the user\n on every device they are signed in on (not just the current one). Pass\n " - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " to only sign out the current session. This is\n usually what apps want on a \"Sign out\" button, especially when users\n sign in from multiple devices and do not expect signing out of one to\n terminate the others.\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires." - } - ] - }, - { - "tag": "@example", - "name": "Sign out of every device (global – default)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out only the current session (recommended for most apps)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out of all other sessions, keep the current one", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "parameters": [ - { - "id": 453, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1304, - "name": "SignOut", - "package": "@supabase/auth-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 455, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [455] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3876, - "character": 65, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3876" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 233, - "name": "signUp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 932, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L932" - } - ], - "signatures": [ - { - "id": 234, - "name": "signUp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A logged-in session if the server has \"autoconfirm\" ON" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A user if the server has \"autoconfirm\" OFF" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\n- **Confirm email** determines if users need to confirm their email address after signing up.\n - If **Confirm email** is enabled, a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " is returned but " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " is null.\n - If **Confirm email** is disabled, both a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " and a " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " are returned.\n- When the user confirms their email address, they are redirected to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your " - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": " or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\n- If signUp() is called for an existing confirmed user:\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, " - }, - { - "kind": "code", - "text": "`User already registered`" - }, - { - "kind": "text", - "text": " is returned.\n- To fetch the currently logged-in user, refer to [" - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-getuser)." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with an email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign up with an email and password\n" - }, - { - "kind": "code", - "text": "```json\n// Some fields may be null if \"confirm email\" is enabled.\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (SMS)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'sms'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a phone number and password (whatsapp)\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (whatsapp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'whatsapp'\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with additional user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n data: {\n first_name: 'John',\n age: 27,\n }\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a redirect URL\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a redirect URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 932, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L932" - } - ], - "parameters": [ - { - "id": 235, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 963, - "name": "SignUpWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 575, - "name": "startAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5119, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5119" - } - ], - "signatures": [ - { - "id": 576, - "name": "startAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClientOptions#autoRefreshToken", - "target": 764 - }, - { - "kind": "text", - "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "#stopAutoRefresh" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- To give this hint to the application, you should be calling this method when the app is in focus and calling " - }, - { - "kind": "code", - "text": "`supabase.auth.stopAutoRefresh()`" - }, - { - "kind": "text", - "text": " when it's out of focus." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5119, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5119" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 577, - "name": "stopAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5154, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5154" - } - ], - "signatures": [ - { - "id": 578, - "name": "stopAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#startAutoRefresh" - }, - { - "kind": "text", - "text": " for more details." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 5154, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L5154" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 520, - "name": "unlinkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4516, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4516" - } - ], - "signatures": [ - { - "id": 521, - "name": "unlinkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`unlinkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- The user must have at least 2 identities in order to unlink an identity.\n- The identity to be unlinked must belong to the user." - } - ] - }, - { - "tag": "@example", - "name": "Unlink an identity", - "content": [ - { - "kind": "code", - "text": "```js\n// retrieve all identities linked to a user\nconst identities = await supabase.auth.getUserIdentities()\n\n// find the google identity\nconst googleIdentity = identities.find(\n identity => identity.provider === 'google'\n)\n\n// unlink the google identity\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4516, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4516" - } - ], - "parameters": [ - { - "id": 522, - "name": "identity", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 523, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 524, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4518, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4518" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 525, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 526, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4519, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4519" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [524, 526] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4517, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4517" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 527, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 528, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 529, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [528, 529] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 4521, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L4521" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 386, - "name": "updateUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3224, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3224" - } - ], - "signatures": [ - { - "id": 387, - "name": "updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates user data for a logged in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, email updates sends a confirmation link to both the user's current and new email.\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers)." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\nSends a \"Confirm Email Change\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email)." - } - ] - }, - { - "tag": "@example", - "name": "Update the email for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n email: 'new@email.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"new_email\": \"new@email.com\",\n \"email_change_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the phone number for an authenticated user\nSends a one-time password (OTP) to the new phone number." - } - ] - }, - { - "tag": "@example", - "name": "Update the phone number for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n phone: '123456789'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update the password for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's metadata\nUpdates the user's custom metadata.\n\n**Note**: The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column in your Supabase database. When calling " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": ", the data will be available as " - }, - { - "kind": "code", - "text": "`user.user_metadata`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n data: { hello: 'world' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's password with a nonce\nIf **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's password with a nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password',\n nonce: '123456'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3224, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3224" - } - ], - "parameters": [ - { - "id": 388, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 926, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 389, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 391, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3227, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3227" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [391] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 3226, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L3226" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 850, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 304, - "name": "verifyOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2334" - } - ], - "signatures": [ - { - "id": 305, - "name": "verifyOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " method takes in different verification types.\n- If a phone number is used, the type can either be:\n 1. " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new phone number during a phone number update process.\n- If an email address is used, the type can be one of the following (note: " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": " types are deprecated):\n 1. " - }, - { - "kind": "code", - "text": "`email`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent for account recovery, typically after a password reset request.\n 3. " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent as part of an invitation to join a project or organization.\n 4. " - }, - { - "kind": "code", - "text": "`email_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new email address during an email update process.\n- The verification type used should be determined based on the corresponding auth method called before " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " to sign up / sign-in a user.\n- The " - }, - { - "kind": "code", - "text": "`TokenHash`" - }, - { - "kind": "text", - "text": " is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details." - } - ] - }, - { - "tag": "@example", - "name": "Verify Signup One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify Signup One-Time Password (OTP)\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify SMS One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify Email Auth (Token Hash)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 2334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L2334" - } - ], - "parameters": [ - { - "id": 306, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1069, - "name": "VerifyOtpParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 811, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [138] - }, - { - "title": "Properties", - "children": [142, 143, 144, 145] - }, - { - "title": "Methods", - "children": [ - 579, 242, 662, 317, 380, 499, 226, 213, 509, 461, 310, 410, 688, 314, 485, 398, 230, - 298, 239, 301, 685, 236, 307, 245, 451, 233, 575, 577, 520, 386, 304 - ] - } - ], - "categories": [ - { - "title": "Auth", - "children": [ - 579, 242, 662, 317, 380, 499, 226, 509, 461, 310, 410, 688, 314, 485, 398, 230, 298, - 239, 301, 685, 236, 307, 245, 451, 233, 575, 577, 520, 386, 304 - ] - }, - { - "title": "Other", - "children": [138, 142, 143, 144, 145, 213] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/GoTrueClient.ts", - "line": 225, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/GoTrueClient.ts#L225" - } - ] - }, - { - "id": 720, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client doesn't call " - }, - { - "kind": "code", - "text": "`navigator.locks`" - }, - { - "kind": "text", - "text": ", so this error\nnever originates from " - }, - { - "kind": "code", - "text": "`supabase.auth.*`" - }, - { - "kind": "text", - "text": " calls. Direct callers of\n" - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " still receive it on acquire timeout." - } - ] - } - ] - }, - "children": [ - { - "id": 721, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L39" - } - ], - "signatures": [ - { - "id": 722, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L39" - } - ], - "parameters": [ - { - "id": 723, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 720, - "name": "NavigatorLockAcquireTimeoutError", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - }, - { - "id": 724, - "name": "isAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true, - "isReadonly": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L37" - } - ], - "type": { - "type": "literal", - "value": true - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.isAcquireTimeout" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [721] - }, - { - "title": "Properties", - "children": [724] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 49, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L49" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError" - }, - "name": "LockAcquireTimeoutError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 933, - "name": "AdminUserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 935, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's application specific metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.app_metadata`" - }, - { - "kind": "text", - "text": " column.\n\nOnly a service role can modify.\n\nThe " - }, - { - "kind": "code", - "text": "`app_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 544, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L544" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 938, - "name": "ban_duration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L570" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 946, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.current_password" - } - }, - { - "id": 944, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 495, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L495" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.email" - } - }, - { - "id": 936, - "name": "email_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's email as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L551" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 941, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " for the user.\n\nAllows you to overwrite the default " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " set for the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 595, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L595" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 942, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.nonce" - } - }, - { - "id": 945, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 505, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L505" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.password" - } - }, - { - "id": 940, - "name": "password_hash", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`password_hash`" - }, - { - "kind": "text", - "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 588, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L588" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 943, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L500" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.phone" - } - }, - { - "id": 937, - "name": "phone_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's phone as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 558, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L558" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 939, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " - }, - { - "kind": "code", - "text": "`authenticated`" - }, - { - "kind": "text", - "text": " by default. You should only modify the " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " is not recommended as it grants the user admin privileges." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 579, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L579" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 934, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\n\nThe " - }, - { - "kind": "code", - "text": "`user_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 534, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L534" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [935, 938, 946, 944, 936, 941, 942, 945, 940, 943, 937, 939, 934] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 523, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L523" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 926, - "name": "UserAttributes", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "data" - } - ], - "name": "Omit", - "package": "typescript" - } - ] - }, - { - "id": 864, - "name": "AMREntry", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An authentication method reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time.\n\nNote: Custom access token hooks can return AMR claims as either:\n- An array of AMREntry objects (detailed format with timestamps)\n- An array of strings (RFC-8176 compliant format)" - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 1262 - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "children": [ - { - "id": 865, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication method name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 369, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L369" - } - ], - "type": { - "type": "reference", - "target": 862, - "name": "AMRMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 866, - "name": "timestamp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 375, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L375" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [865, 866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 367, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L367" - } - ] - }, - { - "id": 1575, - "name": "AuthOAuthServerApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth 2.1 authorization server user-facing methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThese methods are used to implement the consent page." - } - ] - }, - "children": [ - { - "id": 1579, - "name": "approveAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2633, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2633" - } - ], - "signatures": [ - { - "id": 1580, - "name": "approveAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Approves an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter approval, the user's consent is stored and an authorization code is generated.\nThe response contains a complete redirect URL with the authorization code and state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with authorization code" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2633, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2633" - } - ], - "parameters": [ - { - "id": 1581, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to approve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1582, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1583, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1584, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2635, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2635" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1584] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2635, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2635" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1566, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1585, - "name": "denyAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2653" - } - ], - "signatures": [ - { - "id": 1586, - "name": "denyAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Denies an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter denial, the response contains a redirect URL with an OAuth error\n(access_denied) to inform the OAuth client that the user rejected the request." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with error information" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2653" - } - ], - "parameters": [ - { - "id": 1587, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to deny" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1588, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1589, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1590, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2655, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2655" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1590] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2655, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2655" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1566, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1576, - "name": "getAuthorizationDetails", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2616" - } - ], - "signatures": [ - { - "id": 1577, - "name": "getAuthorizationDetails", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves details about an OAuth authorization request.\nUsed to display consent information to the user.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis method returns one of two response types:\n- " - }, - { - "kind": "code", - "text": "`OAuthAuthorizationDetails`" - }, - { - "kind": "text", - "text": ": User needs to consent - show consent page with client info\n- " - }, - { - "kind": "code", - "text": "`OAuthRedirect`" - }, - { - "kind": "text", - "text": ": User already consented - redirect immediately to the OAuth client\n\nUse type narrowing to distinguish between the responses:\n" - }, - { - "kind": "code", - "text": "```typescript\nif ('authorization_id' in data) {\n // Show consent page\n} else {\n // Redirect to data.redirect_url\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Authorization details or redirect URL depending on consent status" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2616" - } - ], - "parameters": [ - { - "id": 1578, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID from the authorization request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "AuthOAuthAuthorizationDetailsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1591, - "name": "listGrants", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2667" - } - ], - "signatures": [ - { - "id": 1592, - "name": "listGrants", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth grants that the authenticated user has authorized.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Response with array of OAuth grants with client information and granted scopes" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2667" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1572, - "name": "AuthOAuthGrantsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1593, - "name": "revokeGrant", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "signatures": [ - { - "id": 1594, - "name": "revokeGrant", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revokes a user's OAuth grant for a specific client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\nand invalidates associated refresh tokens." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Empty response on successful revocation" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "parameters": [ - { - "id": 1595, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revocation options" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1597, - "name": "clientId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client identifier (UUID) to revoke access for" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1597] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2683, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2683" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1573, - "name": "AuthOAuthRevokeGrantResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1579, 1585, 1576, 1591, 1593] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1579, 1585, 1576, 1591, 1593] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2591, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2591" - } - ] - }, - { - "id": 1675, - "name": "AuthPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lower-level two-step API and management methods for passkeys.\nAccess via " - }, - { - "kind": "code", - "text": "`supabase.auth.passkey`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "children": [ - { - "id": 1692, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2883, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2883" - } - ], - "signatures": [ - { - "id": 1693, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a passkey for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2883, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2883" - } - ], - "parameters": [ - { - "id": 1694, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1655, - "name": "PasskeyDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1667, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1687, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2867, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2867" - } - ], - "signatures": [ - { - "id": 1688, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2867, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2867" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1665, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1681, - "name": "startAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2845, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2845" - } - ], - "signatures": [ - { - "id": 1682, - "name": "startAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey authentication ceremony. Fetches an authentication\nchallenge and credential request options from the server. Used as the\nfirst step of a two-step sign-in flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.get()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2845, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2845" - } - ], - "parameters": [ - { - "id": 1683, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1642, - "name": "StartPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1660, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1676, - "name": "startRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2822, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2822" - } - ], - "signatures": [ - { - "id": 1677, - "name": "startRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey registration ceremony. Fetches a registration challenge\nand credential creation options from the server. Used as the first step of\na two-step registration flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.create()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2822, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2822" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1658, - "name": "AuthPasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1689, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2875, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2875" - } - ], - "signatures": [ - { - "id": 1690, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a passkey's friendly name." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2875, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2875" - } - ], - "parameters": [ - { - "id": 1691, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1651, - "name": "PasskeyUpdateParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1666, - "name": "AuthPasskeyUpdateResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1684, - "name": "verifyAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2856, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2856" - } - ], - "signatures": [ - { - "id": 1685, - "name": "verifyAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey authentication credential against a previously issued\nchallenge. Used as the second step of a two-step sign-in flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2856, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2856" - } - ], - "parameters": [ - { - "id": 1686, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1647, - "name": "VerifyPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1678, - "name": "verifyRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2831, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2831" - } - ], - "signatures": [ - { - "id": 1679, - "name": "verifyRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey registration credential against a previously issued\nchallenge. Used as the second step of a two-step registration flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2831, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2831" - } - ], - "parameters": [ - { - "id": 1680, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1638, - "name": "VerifyPasskeyRegistrationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1692, 1687, 1681, 1676, 1689, 1684, 1678] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1692, 1687, 1681, 1676, 1689, 1684, 1678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2811, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2811" - } - ] - }, - { - "id": 1144, - "name": "GenerateLinkOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1145, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 954, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L954" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1146, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 956, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L956" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1145, 1146] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 948, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L948" - } - ] - }, - { - "id": 1526, - "name": "GoTrueAdminCustomProvidersApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "children": [ - { - "id": 1530, - "name": "createProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2425" - } - ], - "signatures": [ - { - "id": 1531, - "name": "createProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new custom OIDC/OAuth provider.\n\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\nfrom the issuer's well-known endpoint (or the provided " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": ") at creation time.\nThis may return a validation error (" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\nin the document does not match the expected issuer.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2425" - } - ], - "parameters": [ - { - "id": 1532, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1471, - "name": "CreateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1540, - "name": "deleteProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "signatures": [ - { - "id": 1541, - "name": "deleteProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a custom provider.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "parameters": [ - { - "id": 1542, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1543, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1544, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1545, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 60, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1544, 1545] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2463, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2463" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1533, - "name": "getProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2435" - } - ], - "signatures": [ - { - "id": 1534, - "name": "getProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific custom provider by identifier.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2435" - } - ], - "parameters": [ - { - "id": 1535, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1527, - "name": "listProviders", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2409" - } - ], - "signatures": [ - { - "id": 1528, - "name": "listProviders", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all custom providers with optional type filter.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2409" - } - ], - "parameters": [ - { - "id": 1529, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1511, - "name": "ListCustomProvidersParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1515, - "name": "CustomProviderListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1536, - "name": "updateProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2450" - } - ], - "signatures": [ - { - "id": 1537, - "name": "updateProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing custom provider.\n\nWhen " - }, - { - "kind": "code", - "text": "`issuer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": " is changed on an OIDC provider, the server re-fetches and\nvalidates the discovery document before persisting. This may return a validation error\n(" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery document is unreachable, invalid, or\nthe issuer does not match.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2450" - } - ], - "parameters": [ - { - "id": 1538, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1539, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1492, - "name": "UpdateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1530, 1540, 1533, 1527, 1536] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1530, 1540, 1533, 1527, 1536] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2400, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2400" - } - ] - }, - { - "id": 1279, - "name": "GoTrueAdminMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication administration API." - } - ], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "children": [ - { - "id": 1283, - "name": "deleteFactor", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1795, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1795" - } - ], - "signatures": [ - { - "id": 1284, - "name": "deleteFactor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#unenroll", - "target": 1254 - } - ] - }, - { - "tag": "@expermental", - "content": [] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Delete a factor for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a factor for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1795, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1795" - } - ], - "parameters": [ - { - "id": 1285, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1269, - "name": "AuthMFAAdminDeleteFactorParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1266, - "name": "AuthMFAAdminDeleteFactorResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1280, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1764, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1764" - } - ], - "signatures": [ - { - "id": 1281, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all factors associated to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "List all factors for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "List all factors for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n factors: Factor[\n {\n id: '',\n friendly_name: 'Auth App Factor',\n factor_type: 'totp',\n status: 'verified',\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z'\n }\n ]\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1764, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1764" - } - ], - "parameters": [ - { - "id": 1282, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1276, - "name": "AuthMFAAdminListFactorsParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1273, - "name": "AuthMFAAdminListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1283, 1280] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1283, 1280] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1732, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1732" - } - ] - }, - { - "id": 1411, - "name": "GoTrueAdminOAuthApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "children": [ - { - "id": 1415, - "name": "createClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2155" - } - ], - "signatures": [ - { - "id": 1416, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2155" - } - ], - "parameters": [ - { - "id": 1417, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1381, - "name": "CreateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1425, - "name": "deleteClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "signatures": [ - { - "id": 1426, - "name": "deleteClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "parameters": [ - { - "id": 1427, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1428, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1429, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1430, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1429, 1430] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2188, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2188" - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1418, - "name": "getClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2166" - } - ], - "signatures": [ - { - "id": 1419, - "name": "getClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2166" - } - ], - "parameters": [ - { - "id": 1420, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1412, - "name": "listClients", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2144" - } - ], - "signatures": [ - { - "id": 1413, - "name": "listClients", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth clients with optional pagination.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2144" - } - ], - "parameters": [ - { - "id": 1414, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1300, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1399, - "name": "OAuthClientListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1431, - "name": "regenerateClientSecret", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2199" - } - ], - "signatures": [ - { - "id": 1432, - "name": "regenerateClientSecret", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Regenerates the secret for an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2199" - } - ], - "parameters": [ - { - "id": 1433, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1421, - "name": "updateClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2177" - } - ], - "signatures": [ - { - "id": 1422, - "name": "updateClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2177" - } - ], - "parameters": [ - { - "id": 1423, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1424, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1390, - "name": "UpdateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1398, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1415, 1425, 1418, 1412, 1431, 1421] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1415, 1425, 1418, 1412, 1431, 1421] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2134, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2134" - } - ] - }, - { - "id": 1695, - "name": "GoTrueAdminPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1699, - "name": "deletePasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2905" - } - ], - "signatures": [ - { - "id": 1700, - "name": "deletePasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a specific passkey for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2905" - } - ], - "parameters": [ - { - "id": 1701, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1671, - "name": "AuthPasskeyAdminDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1667, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1696, - "name": "listPasskeys", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2895" - } - ], - "signatures": [ - { - "id": 1697, - "name": "listPasskeys", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2895" - } - ], - "parameters": [ - { - "id": 1698, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1668, - "name": "AuthPasskeyAdminListParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1665, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [1699, 1696] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1699, 1696] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2886, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2886" - } - ] - }, - { - "id": 1208, - "name": "GoTrueMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication API." - } - ] - }, - "children": [ - { - "id": 1265, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1690" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "WebAuthnApi" - }, - "name": "WebAuthnApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1218, - "name": "challenge", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1423" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1424" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1425" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1426" - } - ], - "signatures": [ - { - "id": 1219, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- A phone factor sends a code to the user upon challenge. The channel defaults to " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " unless otherwise specified." - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor (WhatsApp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n channel: 'whatsapp',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor (WhatsApp)\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1423" - } - ], - "parameters": [ - { - "id": 1220, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1221, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1222, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1223, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1222, 1223] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1224, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1225, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1226, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1225, 1226] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1227, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1424" - } - ], - "parameters": [ - { - "id": 1228, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1175, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1229, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1230, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1231, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1230, 1231] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1232, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1233, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1234, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1233, 1234] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1235, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1425" - } - ], - "parameters": [ - { - "id": 1236, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1176, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1237, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1238, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1239, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1238, 1239] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1240, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1241, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1242, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1241, 1242] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1243, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1426" - } - ], - "parameters": [ - { - "id": 1244, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1177, - "name": "MFAChallengeParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1196, - "name": "AuthMFAChallengeResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1257, - "name": "challengeAndVerify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1618" - } - ], - "signatures": [ - { - "id": 1258, - "name": "challengeAndVerify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Intended for use with only TOTP factors.\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking " - }, - { - "kind": "code", - "text": "`challengeAndVerify()`" - }, - { - "kind": "text", - "text": ".\n- Executes [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge) and [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify) in a single step." - } - ] - }, - { - "tag": "@example", - "name": "Create and verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create and verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1618" - } - ], - "parameters": [ - { - "id": 1259, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1209, - "name": "enroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1349, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1349" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1350" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1351" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1352" - } - ], - "signatures": [ - { - "id": 1210, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " as the " - }, - { - "kind": "code", - "text": "`factorType`" - }, - { - "kind": "text", - "text": " and use the returned " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " to create a challenge.\n- To create a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge).\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- To create and verify a TOTP challenge in a single step, see [" - }, - { - "kind": "code", - "text": "`mfa.challengeAndVerify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challengeandverify).\n- To generate a QR code for the " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " secret in Next.js, you can do the following:\n" - }, - { - "kind": "code", - "text": "```html\n{data.totp.uri}\n```" - }, - { - "kind": "text", - "text": "\n- The " - }, - { - "kind": "code", - "text": "`challenge`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`verify`" - }, - { - "kind": "text", - "text": " steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge." - } - ] - }, - { - "tag": "@example", - "name": "Enroll a time-based, one-time password (TOTP) factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'totp',\n friendlyName: 'your_friendly_name'\n})\n\n// Use the id to create a challenge.\n// The challenge can be verified by entering the code generated from the authenticator app.\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a time-based, one-time password (TOTP) factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp'\n totp: {\n qr_code: '',\n secret: '',\n uri: '',\n }\n friendly_name?: 'Important app'\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Enroll a Phone Factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'phone',\n friendlyName: 'your_friendly_name',\n phone: '+12345678',\n})\n\n// Use the id to create a challenge and send an SMS with a code to the user.\nconst { id, type, friendly_name, phone } = data\n\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a Phone Factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n friendly_name?: 'Important app',\n phone: '+5787123456'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1349, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1349" - } - ], - "parameters": [ - { - "id": 1211, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1307, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1212, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1350" - } - ], - "parameters": [ - { - "id": 1213, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1308, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1214, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1351, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1351" - } - ], - "parameters": [ - { - "id": 1215, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1216, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1352" - } - ], - "parameters": [ - { - "id": 1217, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1160, - "name": "MFAEnrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1187, - "name": "AuthMFAEnrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1262, - "name": "getAuthenticatorAssuranceLevel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1685, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1685" - } - ], - "signatures": [ - { - "id": 1263, - "name": "getAuthenticatorAssuranceLevel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " (or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\nand rarely uses the network. When a JWT is provided (useful in server-side\nenvironments like Edge Functions where no session is stored), this method\nwill make a network request to validate the user and fetch their MFA factors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\n- In Supabase, having an AAL of " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\n- If the user has a verified factor, the " - }, - { - "kind": "code", - "text": "`nextLevel`" - }, - { - "kind": "text", - "text": " field will return " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": ", else, it will return " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": ".\n- An optional " - }, - { - "kind": "code", - "text": "`jwt`" - }, - { - "kind": "text", - "text": " parameter can be passed to check the AAL level of a specific JWT instead of the current session." - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details of a session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the AAL details of a session\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n currentLevel: 'aal1',\n nextLevel: 'aal2',\n currentAuthenticationMethods: [\n {\n method: 'password',\n timestamp: 1700000000\n }\n ]\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details for a specific JWT", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1685, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1685" - } - ], - "parameters": [ - { - "id": 1264, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1203, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1260, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1631, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1631" - } - ], - "signatures": [ - { - "id": 1261, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the list of MFA factors enabled for this user." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 1209 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 1262 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient#getUser", - "target": 380 - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1631, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1631" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1197, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - } - } - ], - "name": "AuthMFAListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1254, - "name": "unenroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1536" - } - ], - "signatures": [ - { - "id": 1255, - "name": "unenroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unenroll removes a MFA factor.\nA user has to have an " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " authenticator level in order to unenroll a " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " factor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@example", - "name": "Unenroll a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.unenroll({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Unenroll a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: ''\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1536" - } - ], - "parameters": [ - { - "id": 1256, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1161, - "name": "MFAUnenrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1188, - "name": "AuthMFAUnenrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1245, - "name": "verify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1507" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1508, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1508" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1509, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1509" - }, - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1510, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1510" - } - ], - "signatures": [ - { - "id": 1246, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first." - } - ] - }, - { - "tag": "@example", - "name": "Verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.verify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1507" - } - ], - "parameters": [ - { - "id": 1247, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1164, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1248, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1508, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1508" - } - ], - "parameters": [ - { - "id": 1249, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1165, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1250, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1509, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1509" - } - ], - "parameters": [ - { - "id": 1251, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1170, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1252, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1510, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1510" - } - ], - "parameters": [ - { - "id": 1253, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1172, - "name": "MFAVerifyParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1186, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [1265] - }, - { - "title": "Methods", - "children": [1218, 1257, 1209, 1262, 1260, 1254, 1245] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1218, 1257, 1209, 1262, 1260, 1254, 1245] - }, - { - "title": "Other", - "children": [1265] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1267, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1267" - } - ] - }, - { - "id": 1349, - "name": "JWK", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1353, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1993, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1993" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1352, - "name": "key_ops", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1992, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1992" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1354, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1994, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1994" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1350, - "name": "kty", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1991, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1991" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1351, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1353, 1352, 1354, 1350] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1990, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1990" - } - ], - "indexSignatures": [ - { - "id": 1355, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1995, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1995" - } - ], - "parameters": [ - { - "id": 1356, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1329, - "name": "JwtPayload", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWT Payload containing claims for Supabase authentication tokens.\n\nRequired claims (iss, aud, exp, iat, sub, role, aal, session_id) are inherited from RequiredClaims.\nAll other claims are optional as they can be customized via Custom Access Token Hooks." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://supabase.com/docs/guides/auth/jwt-fields" - } - ] - } - ] - }, - "children": [ - { - "id": 1345, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1952, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1952" - } - ], - "type": { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aal" - } - }, - { - "id": 1337, - "name": "amr", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication Method References.\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1981, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1981" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 864, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - } - ] - } - }, - { - "id": 1335, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1973, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1973" - } - ], - "type": { - "type": "reference", - "target": 891, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 1341, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1948, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1948" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aud" - } - }, - { - "id": 1330, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1966, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1966" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1342, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1949, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1949" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.exp" - } - }, - { - "id": 1343, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1950, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1950" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iat" - } - }, - { - "id": 1332, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1968, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1968" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1339, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1946, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1946" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iss" - } - }, - { - "id": 1333, - "name": "jti", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1971" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1334, - "name": "nbf", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1972, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1972" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1331, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1967" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1338, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1984, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1984" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1344, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1951, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1951" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.role" - } - }, - { - "id": 1346, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1953, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1953" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.session_id" - } - }, - { - "id": 1340, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1947" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.sub" - } - }, - { - "id": 1336, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1974, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1974" - } - ], - "type": { - "type": "reference", - "target": 896, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1345, 1337, 1335, 1341, 1330, 1342, 1343, 1332, 1339, 1333, 1334, 1331, 1338, 1344, - 1346, 1340, 1336 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1964, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1964" - } - ], - "indexSignatures": [ - { - "id": 1347, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1987, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1987" - } - ], - "parameters": [ - { - "id": 1348, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1319, - "name": "RequiredClaims", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 853, - "name": "Session", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 856, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 317, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L317" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 859, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 329, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L329" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 858, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 325, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L325" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 855, - "name": "provider_refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 313, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L313" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 854, - "name": "provider_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 857, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A one-time used refresh token that never expires." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 321, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L321" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 860, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 330, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L330" - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 861, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When using a separate user storage, accessing properties of this object will throw an error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 335, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L335" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [856, 859, 858, 855, 854, 857, 860, 861] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 304, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L304" - } - ] - }, - { - "id": 947, - "name": "Subscription", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 949, - "name": "callback", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to call every time there is an event. eg: (eventName) => {}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 950, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "signatures": [ - { - "id": 951, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 608, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L608" - } - ], - "parameters": [ - { - "id": 952, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 738, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 953, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 948, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for this subscription, set by the client.\nThis is an internal identifier used for managing callbacks and should not be\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 604, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L604" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 954, - "name": "unsubscribe", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Call this to remove the listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 955, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "signatures": [ - { - "id": 956, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 612, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L612" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [949, 948, 954] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 598, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L598" - } - ] - }, - { - "id": 899, - "name": "User", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 910, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 464, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L464" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 901, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 455, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L455" - } - ], - "type": { - "type": "reference", - "target": 891, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 903, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 457, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L457" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 925, - "name": "banned_until", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 479, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L479" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 904, - "name": "confirmation_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L458" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 914, - "name": "confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L468" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 913, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 467, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L467" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 924, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 911, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L465" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 906, - "name": "email_change_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 460, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L460" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 915, - "name": "email_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L469" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 923, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 477, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - }, - { - "type": "literal", - "value": "unverified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - ] - } - } - }, - { - "id": 900, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 454, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L454" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 920, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 474, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L474" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 867, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 909, - "name": "invited_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L463" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 921, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 475, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L475" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 922, - "name": "is_sso_user", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 476, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L476" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 917, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 471, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L471" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 907, - "name": "new_email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L461" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 908, - "name": "new_phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L462" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 912, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 466, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L466" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "phone_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L470" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 905, - "name": "recovery_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 459, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L459" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 918, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L472" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 919, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L473" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 902, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L456" - } - ], - "type": { - "type": "reference", - "target": 896, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 910, 901, 903, 925, 904, 914, 913, 924, 911, 906, 915, 923, 900, 920, 909, 921, 922, - 917, 907, 908, 912, 916, 905, 918, 919, 902 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 453, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L453" - } - ] - }, - { - "id": 891, - "name": "UserAppMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 892, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The first provider that the user used to sign up with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 441, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L441" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 893, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all providers that the user has linked to their account." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 445, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L445" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [892, 893] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 437, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L437" - } - ], - "indexSignatures": [ - { - "id": 894, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 446, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L446" - } - ], - "parameters": [ - { - "id": 895, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 926, - "name": "UserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 927, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 932, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 520, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L520" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 928, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 495, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L495" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 931, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 930, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 505, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L505" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 929, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L500" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [927, 932, 928, 931, 930, 929] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 482, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L482" - } - ] - }, - { - "id": 867, - "name": "UserIdentity", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 876, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 386, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L386" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 868, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 379, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L379" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 870, - "name": "identity_data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 381, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L381" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 381, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L381" - } - ], - "indexSignatures": [ - { - "id": 872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 382, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L382" - } - ], - "parameters": [ - { - "id": 873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 874, - "name": "identity_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 384, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L384" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 877, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 387, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L387" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 875, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 385, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 878, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 388, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L388" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 869, - "name": "user_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 380, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [876, 868, 870, 874, 877, 875, 878, 869] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 378, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L378" - } - ] - }, - { - "id": 896, - "name": "UserMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 449, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L449" - } - ], - "indexSignatures": [ - { - "id": 897, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 450, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L450" - } - ], - "parameters": [ - { - "id": 898, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1078, - "name": "VerifyEmailOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1079, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 825, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L825" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1082, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 830, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L830" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1083, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1085, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 838, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L838" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1084, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 832, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L832" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1085, 1084] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 830, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L830" - } - ] - } - } - }, - { - "id": 1080, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 827, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L827" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1081, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 829, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L829" - } - ], - "type": { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1079, 1082, 1080, 1081] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 823, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L823" - } - ] - }, - { - "id": 1070, - "name": "VerifyMobileOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1074, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 811, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L811" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1075, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1077, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 820, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L820" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1076, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 813, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L813" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1077, 1076] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 811, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L811" - } - ] - } - } - }, - { - "id": 1071, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 806, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L806" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1072, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 808, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L808" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1073, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 810, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L810" - } - ], - "type": { - "type": "reference", - "target": 1089, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1074, 1071, 1072, 1073] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 804, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L804" - } - ] - }, - { - "id": 1086, - "name": "VerifyTokenHashParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1087, - "name": "token_hash", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token hash used in an email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 844, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L844" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1088, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 847, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L847" - } - ], - "type": { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1087, 1088] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 842, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L842" - } - ] - }, - { - "id": 862, - "name": "AMRMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 353, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L353" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMRMethods" - }, - "name": "AMRMethods", - "package": "@supabase/auth-js", - "preferValues": true - } - } - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 353, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L353" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 738, - "name": "AuthChangeEvent", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 54, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L54" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "reference", - "target": 737, - "name": "AuthChangeEventMFA", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 737, - "name": "AuthChangeEventMFA", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 52, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L52" - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 1201, - "name": "AuthenticatorAssuranceLevels", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1237, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1237" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1202, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1237, - "character": 71, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1237" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 993, - "name": "AuthFlowType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 685, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L685" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 994, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 685, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L685" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1269, - "name": "AuthMFAAdminDeleteFactorParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1703, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1703" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1270, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1271, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the MFA factor to delete." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1272, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user whose factor is being deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1708" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1271, 1272] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1703, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1703" - } - ] - } - } - }, - { - "id": 1266, - "name": "AuthMFAAdminDeleteFactorResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1696, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1696" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1267, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1268, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1698, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1698" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1268] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1696, - "character": 61, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1696" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1276, - "name": "AuthMFAAdminListFactorsParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1722, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1277, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1278, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1724, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1724" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1278] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1722, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1722" - } - ] - } - } - }, - { - "id": 1273, - "name": "AuthMFAAdminListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1714, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1714" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1274, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1275, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All factors attached to the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1716, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1716" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1275] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1714, - "character": 60, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1714" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1192, - "name": "AuthMFAChallengePhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1168, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1168" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponseFields" - }, - "name": "AuthMFAChallengePhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1196, - "name": "AuthMFAChallengeResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1219, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1219" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1191, - "name": "AuthMFAChallengeTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1192, - "name": "AuthMFAChallengePhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1193, - "name": "AuthMFAChallengeWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1191, - "name": "AuthMFAChallengeTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1160, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1160" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponseFields" - }, - "name": "AuthMFAChallengeTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1193, - "name": "AuthMFAChallengeWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn MFA challenge.\nContains credential creation or request options from the server." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Credential Creation", - "target": "https://w3c.github.io/webauthn/#sctn-credential-creation" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1189, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1189" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1194, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable version of WebAuthn challenge response.\nUsed for server communication with base64url-encoded binary fields." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1209, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1209" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFieldsJSON" - }, - "name": "AuthMFAChallengeWebauthnResponseFieldsJSON", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1195, - "name": "AuthMFAChallengeWebauthnServerResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server response type for WebAuthn MFA challenge.\nContains JSON-formatted WebAuthn options ready for browser API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1216, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1216" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1194, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1922, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1922" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponseFields" - }, - "name": "AuthMFAEnrollPhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1187, - "name": "AuthMFAEnrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1135, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1135" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1311, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1310, - "name": "AuthMFAEnrollTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1913, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1913" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponseFields" - }, - "name": "AuthMFAEnrollTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1312, - "name": "AuthMFAEnrollWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn factor enrollment.\nReturns the enrolled factor ID and metadata." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1935, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1935" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnFields" - }, - "name": "AuthMFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1203, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1239, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1239" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1204, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1207, - "name": "currentAuthenticationMethods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario.\n\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1260, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1260" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 864, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1205, - "name": "currentLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Current AAL level of the session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1241, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1241" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1206, - "name": "nextLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#challenge", - "target": 1218 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1249" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1207, 1205, 1206] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1239, - "character": 74, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1239" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1197, - "name": "AuthMFAListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "response of ListFactors, which should contain all the types of factors that are available, this ensures we always include all" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1225, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1225" - } - ], - "typeParameters": [ - { - "id": 1200, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - }, - "default": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1198, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1199, - "name": "all", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All available factors (verified and unverified)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1229, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1229" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1199] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1227, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1227" - } - ] - } - }, - { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "reference", - "target": 1200, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 880, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1188, - "name": "AuthMFAUnenrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1140, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1140" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1189, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1190, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1142" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1190] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1140, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1140" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1186, - "name": "AuthMFAVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for MFA verification operations.\nReturns session tokens on successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1133, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1133" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1179, - "name": "AuthMFAVerifyResponseData", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1179, - "name": "AuthMFAVerifyResponseData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data returned after successful MFA verification.\nContains new session tokens and updated user information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1112, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1112" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1181, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New access token (JWT) after successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1114, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1114" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1183, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of seconds in which the access token will expire." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1120, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1120" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1184, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Refresh token you can use to obtain new access tokens when expired." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1123" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of token, always " - }, - { - "kind": "code", - "text": "`bearer`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1117" - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 1185, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updated user profile." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1126, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1126" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1181, 1183, 1184, 1182, 1185] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1112, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1112" - } - ] - } - } - }, - { - "id": 1565, - "name": "AuthOAuthAuthorizationDetailsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for getting OAuth authorization details.\nReturns either full authorization details (if consent needed) or redirect URL (if already consented).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase.auth.oauth.getAuthorizationDetails(authorizationId)\n\nif (error) {\n console.error('Error:', error)\n} else if ('authorization_id' in data) {\n // User needs to provide consent - show consent page\n console.log('Client:', data.client.name)\n console.log('Scopes:', data.scope)\n console.log('Redirect URI:', data.redirect_uri)\n} else {\n // User already consented - redirect immediately\n window.location.href = data.redirect_url\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2550, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2550" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1552, - "name": "OAuthAuthorizationDetails", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1562, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1566, - "name": "AuthOAuthConsentResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth consent decision (approve/deny).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2558, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2558" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1562, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1572, - "name": "AuthOAuthGrantsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing user's OAuth grants.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2577, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2577" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1567, - "name": "OAuthGrant", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1573, - "name": "AuthOAuthRevokeGrantResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for revoking an OAuth grant.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2583, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2583" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1574, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2583, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2583" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 820, - "name": "AuthOtpResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AuthOtpResponse is returned when OTP is used.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "AuthResponse" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 256, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L256" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 821, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 824, - "name": "messageId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 259, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L259" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 823, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 258, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L258" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 822, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 257, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L257" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [824, 823, 822] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 256, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L256" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1671, - "name": "AuthPasskeyAdminDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2800, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2800" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1674, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2802, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2802" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1673, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2801" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1674, 1673] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2800, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2800" - } - ] - } - } - }, - { - "id": 1668, - "name": "AuthPasskeyAdminListParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2796, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2796" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1669, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1670, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2797, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2797" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1670] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2796, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2796" - } - ] - } - } - }, - { - "id": 1660, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2784, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2784" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1612, - "name": "PasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1661, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2786, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2786" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1662, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1663, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1664, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1663, 1664] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2787, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2787" - } - ] - } - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1667, - "name": "AuthPasskeyDeleteResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2792, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2792" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "literal", - "value": null - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1665, - "name": "AuthPasskeyListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2790, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2790" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1621, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1658, - "name": "AuthPasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2778, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2778" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "PasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1659, - "name": "AuthPasskeyRegistrationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2780, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2780" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1607, - "name": "PasskeyMetadata", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1666, - "name": "AuthPasskeyUpdateResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2791, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2791" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1621, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 811, - "name": "AuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 240, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L240" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 812, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 814, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 242, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L242" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 813, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 241, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L241" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [814, 813] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 240, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L240" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 815, - "name": "AuthResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 245, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L245" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 818, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 247, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L247" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 817, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L246" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 819, - "name": "weak_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 248, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L248" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 785, - "name": "WeakPassword", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [818, 817, 819] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 245, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L245" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 825, - "name": "AuthTokenResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 262, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L262" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 826, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 828, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 264, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L264" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 827, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 263, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L263" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [828, 827] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 262, - "character": 61, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L262" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 829, - "name": "AuthTokenResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 267, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L267" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 830, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 832, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 269, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L269" - } - ], - "type": { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 831, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 268, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L268" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - }, - { - "id": 833, - "name": "weakPassword", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 270, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L270" - } - ], - "type": { - "type": "reference", - "target": 785, - "name": "WeakPassword", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [832, 831, 833] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 267, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L267" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1292, - "name": "CallRefreshTokenResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1822, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1822" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 853, - "name": "Session", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1471, - "name": "CreateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new custom provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2288, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2288" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1472, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1478, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2300" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1481, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2306, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2306" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1482, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2308" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1488, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2320, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2320" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1476, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2296, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2296" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1477, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2298, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2298" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1486, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2316, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2316" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1484, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2312, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2312" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1483, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2310, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2310" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1474, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2292" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1485, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2314, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2314" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1491, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2326, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2326" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1475, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2294, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2294" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1480, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2304, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2304" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1473, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2290, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2290" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1479, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2302, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2302" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1487, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2318, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2318" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1489, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2322" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1490, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2324, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2324" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1478, 1481, 1482, 1488, 1476, 1477, 1486, 1484, 1483, 1474, 1485, 1491, 1475, 1480, - 1473, 1479, 1487, 1489, 1490 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2288, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2288" - } - ] - } - } - }, - { - "id": 1381, - "name": "CreateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2073, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2073" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1382, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1383, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2075, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2075" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1384, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2077, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2077" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1386, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2081, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2081" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1385, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2079" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1387, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types (optional, defaults to code)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2083, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2083" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1361, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1388, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2085, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2085" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1389, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method (defaults to server default if not specified)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2087, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2087" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1383, 1384, 1386, 1385, 1387, 1388, 1389] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2073, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2073" - } - ] - } - } - }, - { - "id": 1447, - "name": "CustomOAuthProvider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom OAuth/OIDC provider object returned from the admin API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2238, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2238" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1448, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1454, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2250, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2250" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1457, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2256, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2256" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1458, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2258, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2258" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1464, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2270, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2270" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1453, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2248, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2248" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1469, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2280" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1468, - "name": "discovery_document", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document (OIDC providers only)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2278, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2278" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1435, - "name": "OIDCDiscoveryDocument", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1462, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2266, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2266" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1460, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2262, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2262" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1459, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2260, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2260" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1449, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2240, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2240" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1451, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2244, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2244" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1461, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2264, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2264" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1467, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2276, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1452, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2246" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1456, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2254" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1450, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2242, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2242" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1455, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2252, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2252" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1463, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2268, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2268" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1465, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2272, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2272" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1470, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2282, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2282" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1466, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2274, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2274" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1454, 1457, 1458, 1464, 1453, 1469, 1468, 1462, 1460, 1459, 1449, 1451, 1461, 1467, - 1452, 1456, 1450, 1455, 1463, 1465, 1470, 1466 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2238, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2238" - } - ] - } - } - }, - { - "id": 1515, - "name": "CustomProviderListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2387, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2387" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1516, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1517, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1518, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1519, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1447, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1519] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2389, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2389" - } - ] - } - } - }, - { - "id": 1520, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2390, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2390" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1517, 1520] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2388, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2388" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1521, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1522, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1523, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1524, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1524] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2393, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2393" - } - ] - } - } - }, - { - "id": 1525, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2394, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2394" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1522, 1525] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2392, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2392" - } - ] - } - } - ] - } - }, - { - "id": 1514, - "name": "CustomProviderResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for custom provider operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2382, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2382" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1447, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1434, - "name": "CustomProviderType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of custom identity provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2205, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2205" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - } - }, - { - "id": 1091, - "name": "EmailOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 851, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L851" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1092, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 858, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L858" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1050, - "name": "EthereumWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 762, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L762" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "EIP1193Provider" - }, - "name": "EIP1193Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1051, - "name": "EthereumWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 764, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L764" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1052, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1053, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 766, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L766" - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1056, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 774, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L774" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1059, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 779, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L779" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1060, - "name": "signInWithEthereum", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 781, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L781" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "EthereumSignInInput" - }, - "name": "EthereumSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1058, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 776, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L776" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1059, 1060, 1058] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 774, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L774" - } - ] - } - } - }, - { - "id": 1055, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 772, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L772" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1054, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.ethereum`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 769, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L769" - } - ], - "type": { - "type": "reference", - "target": 1050, - "name": "EthereumWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1053, 1056, 1055, 1054] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 765, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L765" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1061, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1062, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 787, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L787" - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1063, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Ethereum compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 790, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L790" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1065, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 795, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L795" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1067, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 797, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L797" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1067] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 795, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L795" - } - ] - } - } - }, - { - "id": 1064, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ethereum curve (secp256k1) signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 793, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L793" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/ethereum.ts", - "qualifiedName": "Hex" - }, - "name": "Hex", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1062, 1063, 1065, 1064] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 786, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L786" - } - ] - } - } - ] - } - }, - { - "id": 781, - "name": "ExperimentalFeatureFlags", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 182, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L182" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 782, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 783, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enables passkey support:\n - " - }, - { - "kind": "code", - "text": "`auth.signInWithPasskey()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`auth.registerPasskey()`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.passkey.*`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.admin.passkey.*`" - }, - { - "kind": "text", - "text": "\n\nDefaults to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ". Calling any passkey method while this flag is\ndisabled throws a descriptive error at call time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L192" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [783] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 182, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L182" - } - ] - } - } - }, - { - "id": 880, - "name": "Factor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A MFA factor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 1209 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#listFactors", - "target": 1260 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAAdminApi#listFactors" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 412, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L412" - } - ], - "typeParameters": [ - { - "id": 889, - "name": "Type", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 879, - "name": "FactorType", - "package": "@supabase/auth-js" - }, - "default": { - "type": "reference", - "target": 879, - "name": "FactorType", - "package": "@supabase/auth-js" - } - }, - { - "id": 890, - "name": "Status", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorVerificationStatus" - }, - "name": "FactorVerificationStatus", - "package": "@supabase/auth-js" - }, - "default": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorVerificationStatuses" - }, - "name": "FactorVerificationStatuses", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 881, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 886, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 432, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L432" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 884, - "name": "factor_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 425, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L425" - } - ], - "type": { - "type": "reference", - "target": 889, - "name": "Type", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 883, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L420" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 882, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 417, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L417" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 888, - "name": "last_challenged_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 434, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L434" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 885, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification status of the factor, default is " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " after " - }, - { - "kind": "code", - "text": "`.enroll()`" - }, - { - "kind": "text", - "text": ", then " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " after the user verifies it with " - }, - { - "kind": "code", - "text": "`.verify()`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 430, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L430" - } - ], - "type": { - "type": "reference", - "target": 890, - "name": "Status", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 887, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 433, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L433" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [886, 884, 883, 882, 888, 885, 887] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 415, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L415" - } - ] - } - } - }, - { - "id": 879, - "name": "FactorType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 396, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L396" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1138, - "name": "GenerateEmailChangeLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 937, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L937" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1141, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 940, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L940" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1142, - "name": "newEmail", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 944, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L944" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1143, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 945, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L945" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1140, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 938, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L938" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1141, 1142, 1143, 1140] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 937, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L937" - } - ] - } - } - }, - { - "id": 1128, - "name": "GenerateInviteOrMagiclinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 923, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L923" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1129, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1131, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 926, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L926" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1132, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 927, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L927" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1130, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 924, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L924" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1131, 1132, 1130] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 923, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L923" - } - ] - } - } - }, - { - "id": 1147, - "name": "GenerateLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 959, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L959" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1122, - "name": "GenerateSignupLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1128, - "name": "GenerateInviteOrMagiclinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1133, - "name": "GenerateRecoveryLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1138, - "name": "GenerateEmailChangeLinkParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1152, - "name": "GenerateLinkProperties", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The properties related to the email link generated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 971, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L971" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1154, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 976, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L976" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1155, - "name": "email_otp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 981, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L981" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1156, - "name": "hashed_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The hashed token appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 985, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L985" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1157, - "name": "redirect_to", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 987, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L987" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1158, - "name": "verification_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification type that the email link is associated to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 989, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L989" - } - ], - "type": { - "type": "reference", - "target": 1159, - "name": "GenerateLinkType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1154, 1155, 1156, 1157, 1158] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 971, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L971" - } - ] - } - } - }, - { - "id": 1148, - "name": "GenerateLinkResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 965, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L965" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1149, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1150, - "name": "properties", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 966, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L966" - } - ], - "type": { - "type": "reference", - "target": 1152, - "name": "GenerateLinkProperties", - "package": "@supabase/auth-js" - } - }, - { - "id": 1151, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L967" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1150, 1151] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 965, - "character": 64, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L965" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1159, - "name": "GenerateLinkType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 992, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L992" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - }, - { - "id": 1133, - "name": "GenerateRecoveryLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 930, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L930" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1136, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 933, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L933" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1137, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 934, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L934" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1135, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 931, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L931" - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1136, 1137, 1135] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 930, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L930" - } - ] - } - } - }, - { - "id": 1122, - "name": "GenerateSignupLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 916, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L916" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1125, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 918, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L918" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1127, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 920, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L920" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1144, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1126, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 919, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L919" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1124, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 917, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L917" - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1125, 1127, 1126, 1124] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 916, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L916" - } - ] - } - } - }, - { - "id": 748, - "name": "GoTrueClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L80" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 749, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 764, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L109" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 770, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 127, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L127" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 771, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 127, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L127" - } - ], - "signatures": [ - { - "id": 772, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 773, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 774, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - }, - { - "id": 756, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if you want to automatically detect OAuth grants in the URL and sign in the user.\nSet to \"false\" to disable automatic detection.\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\nThe function receives the current URL and parsed parameters, and should return true if the URL\nshould be processed as a Supabase auth callback, or false to ignore it.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 757, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "signatures": [ - { - "id": 758, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 759, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 760, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 761, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "indexSignatures": [ - { - "id": 762, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 107, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L107" - } - ], - "parameters": [ - { - "id": 763, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 780, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 179, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L179" - } - ], - "type": { - "type": "reference", - "target": 781, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 768, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L123" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/fetch.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/auth-js" - } - }, - { - "id": 769, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L125" - } - ], - "type": { - "type": "reference", - "target": 993, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 776, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if there is a custom authorization header set globally." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L146" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 751, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "indexSignatures": [ - { - "id": 753, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 84, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L84" - } - ], - "parameters": [ - { - "id": 754, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 775, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe client coordinates refreshes itself (single-flight via\n" - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " + commit guard) and relies on the GoTrue server to\nresolve cross-tab refresh races. Passing a custom lock opts into a\nlegacy path that wraps every auth operation in your supplied lock — this\npath is preserved for backwards compatibility (typically React Native\n" - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": " or Node multi-process setups)." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\nconstructor options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L141" - } - ], - "type": { - "type": "reference", - "target": 739, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - }, - { - "id": 778, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option. Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is\npassed — the default lockless path doesn't use this timeout." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 162, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 765, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L111" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 779, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in constructor. Useful for SSR\ncontexts where initialization timing must be controlled to prevent race\nconditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 171, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L171" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 766, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "reference", - "target": 1286, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 755, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L86" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 777, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L151" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 750, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L82" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 767, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " - }, - { - "kind": "code", - "text": "`storage`" - }, - { - "kind": "text", - "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " - }, - { - "kind": "code", - "text": "`userStorage`" - }, - { - "kind": "text", - "text": " will only contain the user object under the key " - }, - { - "kind": "code", - "text": "`storageKey + '-user'`" - }, - { - "kind": "text", - "text": ".\n\nWhen this option is set and cookie storage is used, " - }, - { - "kind": "code", - "text": "`getSession()`" - }, - { - "kind": "text", - "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch a user object in those scenarios." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L121" - } - ], - "type": { - "type": "reference", - "target": 1286, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 764, 770, 756, 780, 768, 769, 776, 751, 775, 778, 765, 779, 766, 755, 777, 750, 767 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 80, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L80" - } - ] - } - } - }, - { - "id": 1289, - "name": "InitializeResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1290, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1291, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1291] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1820, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1820" - } - ] - } - } - }, - { - "id": 1313, - "name": "JwtHeader", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1939, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1939" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1314, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1315, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1940, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1940" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "RS256" - }, - { - "type": "literal", - "value": "ES256" - }, - { - "type": "literal", - "value": "HS256" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1316, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1940, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1940" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1317, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1941" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1318, - "name": "typ", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1942, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1942" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1315, 1317, 1318] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1939, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1939" - } - ] - } - } - }, - { - "id": 1511, - "name": "ListCustomProvidersParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2374, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2374" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1512, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1513, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2376" - } - ], - "type": { - "type": "reference", - "target": 1434, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1513] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2374, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2374" - } - ] - } - } - }, - { - "id": 739, - "name": "LockFunc", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": " async function, such that no other client instances will be able to\nhold it at the same time." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 740, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "signatures": [ - { - "id": 741, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameters": [ - { - "id": 747, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 742, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 743, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 744, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to execute when the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 78, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L78" - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 747, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 747, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1178, - "name": "MFAChallengeAndVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1106, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1106" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - }, - { - "id": 1177, - "name": "MFAChallengeParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1094, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1094" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1174, - "name": "MFAChallengeTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1175, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1176, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1175, - "name": "MFAChallengePhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1075, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1075" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParamFields" - }, - "name": "MFAChallengePhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1174, - "name": "MFAChallengeTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1068, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1068" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1176, - "name": "MFAChallengeWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for initiating a WebAuthn MFA challenge.\nIncludes Relying Party information needed for WebAuthn ceremonies." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Relying Party Operations", - "target": "https://w3c.github.io/webauthn/#sctn-rp-operations" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1092, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1092" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParamFields" - }, - "name": "MFAChallengeWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1160, - "name": "MFAEnrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1000, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1000" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1307, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1308, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1309, - "name": "MFAEnrollWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1308, - "name": "MFAEnrollPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1870, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1870" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParamFields" - }, - "name": "MFAEnrollPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1307, - "name": "MFAEnrollTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1864, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1864" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParamFields" - }, - "name": "MFAEnrollTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1309, - "name": "MFAEnrollWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for enrolling a WebAuthn factor.\nCreates an unverified WebAuthn factor that must be verified with a credential." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1881, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1881" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnFields" - }, - "name": "MFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1173, - "name": "MFATOTPChannel", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1066, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1066" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFATOTPChannels" - }, - "name": "MFATOTPChannels", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1161, - "name": "MFAUnenrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1002, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1002" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1162, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1163, - "name": "factorId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor being unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1004, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1004" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1163] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1002, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1002" - } - ] - } - } - }, - { - "id": 1172, - "name": "MFAVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1058, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1058" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1164, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1165, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1170, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1165, - "name": "MFAVerifyPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1023, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1023" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParamFields" - }, - "name": "MFAVerifyPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1164, - "name": "MFAVerifyTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1019, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1019" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParamFields" - }, - "name": "MFAVerifyTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1166, - "name": "MFAVerifyWebauthnParamFields", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "WebAuthn-specific fields for MFA verification.\nSupports both credential creation (registration) and request (authentication) flows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1045, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1045" - } - ], - "typeParameters": [ - { - "id": 1169, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1167, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1168, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1046, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1046" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFieldsBase" - }, - "name": "MFAVerifyWebauthnParamFieldsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnCredentialParamFields" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1169, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnCredentialParamFields", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1168] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1045, - "character": 98, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1045" - } - ] - } - } - }, - { - "id": 1170, - "name": "MFAVerifyWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for WebAuthn MFA verification.\nUsed to verify WebAuthn credentials after challenge." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Verifying an Authentication Assertion", - "target": "https://w3c.github.io/webauthn/#sctn-verifying-assertion" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1055, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1055" - } - ], - "typeParameters": [ - { - "id": 1171, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1166, - "typeArguments": [ - { - "type": "reference", - "target": 1171, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1089, - "name": "MobileOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 850, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L850" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1090, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 850, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L850" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1546, - "name": "OAuthAuthorizationClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client details in an authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2470, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2470" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1547, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1548, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2472" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1551, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1549, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2474, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2474" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1550, - "name": "uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's website" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2476, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2476" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1548, 1551, 1549, 1550] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2470, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2470" - } - ] - } - } - }, - { - "id": 1552, - "name": "OAuthAuthorizationDetails", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth authorization details when user needs to provide consent.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response includes all information needed to display a consent page:\nclient details, user info, requested scopes, and where the user will be redirected.\n\nNote: " - }, - { - "kind": "code", - "text": "`redirect_uri`" - }, - { - "kind": "text", - "text": " is the base URI (e.g., \"https://app.com/callback\") without\nquery parameters. After consent, you'll receive a complete " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " with\nthe authorization code and state parameters appended." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2492, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2492" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1553, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1554, - "name": "authorization_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID used to approve or deny the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2494, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2494" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1556, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client requesting authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2498, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2498" - } - ], - "type": { - "type": "reference", - "target": 1546, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 1555, - "name": "redirect_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client's registered redirect URI (base URI without query parameters)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2496, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2496" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1561, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Space-separated list of requested scopes (e.g., \"openid profile email\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2507" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1557, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User object associated with the authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2500, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2500" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1558, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1560, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2504, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2504" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1559, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User ID (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2502, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2502" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1560, 1559] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2500, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2500" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1554, 1556, 1555, 1561, 1557] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2492, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2492" - } - ] - } - } - }, - { - "id": 1365, - "name": "OAuthClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client object returned from the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2038, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2038" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1367, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2040, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2040" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1368, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2042, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2042" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1369, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client secret (only returned on registration and regeneration)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2044, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2044" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1370, - "name": "client_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2046, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2046" - } - ], - "type": { - "type": "reference", - "target": 1362, - "name": "OAuthClientType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1373, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2052, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2052" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1379, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2064, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2064" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1376, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2058, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2058" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1374, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2054, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2054" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1375, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2056, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2056" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1372, - "name": "registration_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registration type of the client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2050, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2050" - } - ], - "type": { - "type": "reference", - "target": 1363, - "name": "OAuthClientRegistrationType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1377, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2060, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2060" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1361, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1378, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2062, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2062" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1371, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2048, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2048" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 1380, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2066, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2066" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1367, 1368, 1369, 1370, 1373, 1379, 1376, 1374, 1375, 1372, 1377, 1378, 1371, 1380 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2038, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2038" - } - ] - } - } - }, - { - "id": 1359, - "name": "OAuthClientGrantType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client grant types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2005, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2005" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1360, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2005, - "character": 86, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2005" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1399, - "name": "OAuthClientListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing OAuth clients.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2120, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2120" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1400, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1401, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1404, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1403, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1365, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1404, 1403] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2122, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2122" - } - ] - } - }, - { - "type": "reference", - "target": 1293, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1405, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2123, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2123" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1401, 1405] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2121" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1406, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1407, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1408, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1409, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1409] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2126, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2126" - } - ] - } - } - }, - { - "id": 1410, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2127, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2127" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1407, 1410] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2125, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2125" - } - ] - } - } - ] - } - }, - { - "id": 1363, - "name": "OAuthClientRegistrationType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client registration type.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2023, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2023" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - } - }, - { - "id": 1398, - "name": "OAuthClientResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth client operations.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2114, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2114" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reference", - "target": 1365, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1361, - "name": "OAuthClientResponseType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client response types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2011, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2011" - } - ], - "type": { - "type": "literal", - "value": "code" - } - }, - { - "id": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client token endpoint authentication method.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2029, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2029" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - } - }, - { - "id": 1362, - "name": "OAuthClientType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client type indicating whether the client can keep credentials confidential.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2017, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2017" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - } - }, - { - "id": 1567, - "name": "OAuthGrant", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An OAuth grant representing a user's authorization of an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2564, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2564" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1568, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1569, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client information" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2566" - } - ], - "type": { - "type": "reference", - "target": 1546, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 1571, - "name": "granted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the grant was created (ISO 8601 date-time)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2570" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1570, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of scopes granted to this client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2568, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2568" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1569, 1571, 1570] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2564, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2564" - } - ] - } - } - }, - { - "id": 1562, - "name": "OAuthRedirect", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth redirect response when user has already consented or after consent decision.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response is returned in three scenarios:\n1. User already consented to these scopes (auto-approved)\n2. User just approved the authorization request\n3. User just denied the authorization request\n\nThe " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " is a complete URL ready for redirecting the user back to the\nOAuth client, including authorization code (on success) or error (on denial) in\nquery parameters, along with the state parameter if one was provided." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2523, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2523" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1563, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1564, - "name": "redirect_url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Complete redirect URL with authorization code and state parameters (e.g., \"https://app.com/callback?code=xxx&state=yyy\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2525, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2525" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1564] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2523, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2523" - } - ] - } - } - }, - { - "id": 834, - "name": "OAuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 273, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L273" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 835, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 836, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L275" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 837, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 838, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L276" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 839, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L277" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [838, 839] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 275, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L275" - } - ] - } - } - }, - { - "id": 840, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L279" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [836, 840] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 274, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L274" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 841, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 842, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 282, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L282" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 844, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 283, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L283" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 845, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 284, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L284" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [844, 845] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 282, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L282" - } - ] - } - } - }, - { - "id": 846, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 286, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L286" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [842, 846] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 281, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L281" - } - ] - } - } - ] - } - }, - { - "id": 1435, - "name": "OIDCDiscoveryDocument", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document fields.\nPopulated when the server successfully fetches and validates the\nprovider's OpenID Connect discovery document." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2212, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2212" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1436, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1438, - "name": "authorization_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the authorization endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2216" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1437, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The issuer identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2214, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2214" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1440, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the JSON Web Key Set" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2220, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2220" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1442, - "name": "revocation_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the revocation endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2224, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2224" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1446, - "name": "supported_id_token_signing_algs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported ID token signing algorithms" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2232, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2232" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1444, - "name": "supported_response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2228, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2228" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1443, - "name": "supported_scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported scopes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2226, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2226" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1445, - "name": "supported_subject_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported subject types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2230, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2230" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1439, - "name": "token_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the token endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2218, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2218" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1441, - "name": "userinfo_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the userinfo endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2222, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2222" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1438, 1437, 1440, 1442, 1446, 1444, 1443, 1445, 1439, 1441] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2212, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2212" - } - ] - } - } - }, - { - "id": 1300, - "name": "PageParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1831, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1831" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1301, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1302, - "name": "page", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The page number" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1833, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1833" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1303, - "name": "perPage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items returned per page" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1835, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1835" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1302, 1303] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1831, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1831" - } - ] - } - } - }, - { - "id": 1293, - "name": "Pagination", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1824, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1824" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1294, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1296, - "name": "lastPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1827, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1827" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1295, - "name": "nextPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1826, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1826" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1297, - "name": "total", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1828, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1828" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1296, 1295, 1297] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1824, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1824" - } - ], - "indexSignatures": [ - { - "id": 1298, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1825, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1825" - } - ], - "parameters": [ - { - "id": 1299, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 1612, - "name": "PasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/authentication/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2709, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2709" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1613, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1614, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2710, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2710" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1616, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2712, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2712" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1615, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2711, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2711" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialRequestOptions" - }, - "name": "ServerCredentialRequestOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1614, 1616, 1615] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2709, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2709" - } - ] - } - } - }, - { - "id": 1617, - "name": "PasskeyAuthenticationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/authentication/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2716, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2716" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1618, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1619, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2717, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2717" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1620, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2718, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2718" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.dom.ts", - "qualifiedName": "AuthenticationResponseJSON" - }, - "name": "AuthenticationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1619, 1620] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2716, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2716" - } - ] - } - } - }, - { - "id": 1655, - "name": "PasskeyDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2771, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2771" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1657, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to delete" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2773, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2773" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1657] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2771, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2771" - } - ] - } - } - }, - { - "id": 1621, - "name": "PasskeyListItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Item in the passkeys list (GET /passkeys/ and admin list)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2722, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1625, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2725, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2725" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1624, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2724, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2724" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1623, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2723, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2723" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1626, - "name": "last_used_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2726, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2726" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1625, 1624, 1623, 1626] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2722, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2722" - } - ] - } - } - }, - { - "id": 1607, - "name": "PasskeyMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2702, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2702" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1608, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1611, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1610, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2704, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2704" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1609, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2703, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2703" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1611, 1610, 1609] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2702, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2702" - } - ] - } - } - }, - { - "id": 1598, - "name": "PasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2689, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2689" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1599, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1600, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2690" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1602, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2692" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1601, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2691, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2691" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialCreationOptions" - }, - "name": "ServerCredentialCreationOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1600, 1602, 1601] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2689, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2689" - } - ] - } - } - }, - { - "id": 1603, - "name": "PasskeyRegistrationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2696, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2696" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1604, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1605, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2697, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2697" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1606, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2698, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2698" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.dom.ts", - "qualifiedName": "RegistrationResponseJSON" - }, - "name": "RegistrationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1605, 1606] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2696, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2696" - } - ] - } - } - }, - { - "id": 1651, - "name": "PasskeyUpdateParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2764, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2764" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1652, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1654, - "name": "friendlyName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New friendly name (max 120 chars)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2768, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2768" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1653, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2766, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2766" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1654, 1653] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2764, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2764" - } - ] - } - } - }, - { - "id": 789, - "name": "Prettify", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resolve mapped types and show the derived keys and their types when hovering in\nVS Code, instead of just showing the names those mapped types are defined with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 207, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L207" - } - ], - "typeParameters": [ - { - "id": 790, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 790, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - } - }, - { - "id": 736, - "name": "Provider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue. Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 24, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L24" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ], - "elementSummaries": [ - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [ - { - "kind": "text", - "text": "Uses OAuth 1.0a" - } - ], - [ - { - "kind": "text", - "text": "Uses OAuth 2.0" - } - ], - [], - [], - [], - [] - ] - } - }, - { - "id": 1633, - "name": "RegisterPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2738, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2738" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1634, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1635, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2739, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2739" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1636, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1637, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2740, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2740" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1637] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2739, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2739" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1635] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2738, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2738" - } - ] - } - } - }, - { - "id": 794, - "name": "RequestResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "a shared result type that encapsulates errors instead of throwing them, allows you to optionally specify the ErrorType" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 219, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L219" - } - ], - "typeParameters": [ - { - "id": 801, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 802, - "name": "ErrorType", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "default": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 795, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 796, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 221, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L221" - } - ], - "type": { - "type": "reference", - "target": 801, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 797, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 222, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [796, 797] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 220, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L220" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 798, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 799, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 225, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L225" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 800, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 226, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L226" - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "extendsType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "trueType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "falseType": { - "type": "reference", - "target": 802, - "name": "ErrorType", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [799, 800] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 224, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L224" - } - ] - } - } - ] - } - }, - { - "id": 803, - "name": "RequestResultSafeDestructure", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "similar to RequestResult except it allows you to destructure the possible shape of the success response\n " - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "RequestResult" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 233, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L233" - } - ], - "typeParameters": [ - { - "id": 810, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 804, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 805, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ], - "type": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 806, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [805, 806] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 234, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L234" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 807, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 808, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 236, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L236" - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "object" - }, - "trueType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 810, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "literal", - "value": null - } - }, - "falseType": { - "type": "literal", - "value": null - } - } - }, - { - "id": 809, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 237, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L237" - } - ], - "type": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [808, 809] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L235" - } - ] - } - } - ] - } - }, - { - "id": 1319, - "name": "RequiredClaims", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1945, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1945" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1320, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1327, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1952, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1952" - } - ], - "type": { - "type": "reference", - "target": 1201, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - } - }, - { - "id": 1323, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1948, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1948" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1324, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1949, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1949" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1325, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1950, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1950" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1321, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1946, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1946" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1326, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1951, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1951" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1328, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1953, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1953" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1322, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1947, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1947" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1327, 1323, 1324, 1325, 1321, 1326, 1328, 1322] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1945, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1945" - } - ] - } - }, - "extendedBy": [ - { - "type": "reference", - "target": 1329, - "name": "JwtPayload" - } - ] - }, - { - "id": 1093, - "name": "ResendParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 860, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L860" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1096, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 863, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1097, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 864, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L864" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1098, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1100, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 868, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L868" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1099, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 866, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L866" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1100, 1099] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 864, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L864" - } - ] - } - } - }, - { - "id": 1095, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 862, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L862" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1091, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1096, 1097, 1095] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L861" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1101, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1104, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 874, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L874" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1105, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1106, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 876, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L876" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1106] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 874, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L874" - } - ] - } - } - }, - { - "id": 1103, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 873, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L873" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1102, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 872, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L872" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1089, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1104, 1103, 1102] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 871, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L871" - } - ] - } - } - ] - } - }, - { - "id": 957, - "name": "SignInAnonymouslyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 615, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L615" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 958, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 959, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 616, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L616" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 960, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 962, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 624, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L624" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 961, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 622, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L622" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [962, 961] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 616, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L616" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [959] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 615, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L615" - } - ] - } - } - }, - { - "id": 1007, - "name": "SignInWithIdTokenCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 701, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L701" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1008, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1012, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 707, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L707" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1013, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L709" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1014, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 710, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L710" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1015, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1016, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 712, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L712" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1016] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 710, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L710" - } - ] - } - } - }, - { - "id": 1009, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider name or OIDC " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " value identifying which provider should be used to verify the provided token. Supported names: " - }, - { - "kind": "code", - "text": "`google`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`apple`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`azure`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`facebook`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`kakao`" - }, - { - "kind": "text", - "text": ". Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 703, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L703" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1010, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 703, - "character": 97, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L703" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1011, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC ID token issued by the specified provider. The " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " which require that you provide an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " value to be accepted properly. If the token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim you must supply the nonce used to obtain the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 705, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L705" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1012, 1013, 1014, 1009, 1011] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 701, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L701" - } - ] - } - } - }, - { - "id": 995, - "name": "SignInWithOAuthCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 686, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L686" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 996, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 998, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 689, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L689" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 999, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1002, - "name": "queryParams", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object of query params" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1003, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "indexSignatures": [ - { - "id": 1004, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 695, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L695" - } - ], - "parameters": [ - { - "id": 1005, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1000, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 691, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L691" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1001, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A space-separated list of scopes granted to the OAuth application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 693, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L693" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1006, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 697, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L697" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1002, 1000, 1001, 1006] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 689, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L689" - } - ] - } - } - }, - { - "id": 997, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 688, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L688" - } - ], - "type": { - "type": "reference", - "target": 736, - "name": "Provider", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [998, 997] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 686, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L686" - } - ] - } - } - }, - { - "id": 1627, - "name": "SignInWithPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2731, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2731" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1628, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1629, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2732, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2732" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1631, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2733, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2733" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1632, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2734, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2734" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1631, 1632] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2732, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2732" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1629] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2731, - "character": 43, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2731" - } - ] - } - } - }, - { - "id": 971, - "name": "SignInWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 641, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L641" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 972, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 973, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 642, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L642" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 975, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 643, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L643" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [975] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 642, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L642" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [973] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 641, - "character": 70, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L641" - } - ] - } - } - ] - } - }, - { - "id": 976, - "name": "SignInWithPasswordlessCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 647, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L647" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 977, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 978, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 650, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L650" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 979, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 651, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L651" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 980, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 984, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 663, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L663" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 983, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 661, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L661" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 981, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The redirect url embedded in the email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 653, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L653" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 982, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 655, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L655" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [984, 983, 981, 982] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 651, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L651" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [978, 979] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 648, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L648" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 985, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 987, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 669, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L669" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 988, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 991, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 679, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L679" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 992, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Messaging channel to use (e.g. whatsapp or sms)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 681, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L681" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 990, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 677, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L677" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 989, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 671, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L671" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [991, 992, 990, 989] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 669, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L669" - } - ] - } - } - }, - { - "id": 986, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 668, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L668" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [987, 986] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 666, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L666" - } - ] - } - } - ] - } - }, - { - "id": 1107, - "name": "SignInWithSSO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 880, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L880" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1110, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 885, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L885" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1113, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 889, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L889" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1112, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 887, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L887" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1114, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 895, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113, 1112, 1114] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 885, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L885" - } - ] - } - } - }, - { - "id": 1109, - "name": "providerId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the SSO provider to invoke single-sign on to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 883, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L883" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1110, 1109] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 881, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L881" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1116, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Domain name of the organization for which to invoke single-sign on." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 900, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L900" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1117, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 902, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L902" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1120, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 906, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L906" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1119, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 904, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L904" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1121, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 912, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L912" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1120, 1119, 1121] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 902, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L902" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1116, 1117] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 898, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L898" - } - ] - } - } - ] - } - }, - { - "id": 1304, - "name": "SignOut", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1838, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1838" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1305, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1306, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1849, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1849" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1306] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1838, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1838" - } - ] - } - } - }, - { - "id": 1358, - "name": "SignOutScope", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1999, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1999" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1357, - "name": "SIGN_OUT_SCOPES", - "package": "@supabase/auth-js" - } - } - } - }, - { - "id": 963, - "name": "SignUpWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 628, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L628" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 964, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 965, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 629, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L629" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 966, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 969, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 632, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L632" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 970, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 633, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L633" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 968, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 631, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L631" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 967, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 630, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L630" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [969, 970, 968, 967] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 629, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L629" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [965] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 628, - "character": 70, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L628" - } - ] - } - } - ] - } - }, - { - "id": 1017, - "name": "SolanaWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 716, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L716" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1018, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1023, - "name": "publicKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 718, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L718" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1024, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1025, - "name": "toBase58", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 719, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L719" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1026, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 719, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L719" - } - ], - "signatures": [ - { - "id": 1027, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1025] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 718, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L718" - } - ] - } - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1019, - "name": "signIn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 717, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L717" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1020, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 717, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L717" - } - ], - "signatures": [ - { - "id": 1021, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1022, - "name": "inputs", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1028, - "name": "signMessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 722, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L722" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 722, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L722" - } - ], - "signatures": [ - { - "id": 1030, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1031, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - }, - { - "id": 1032, - "name": "encoding", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "utf8" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1023, 1019, 1028] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 716, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L716" - } - ] - } - } - }, - { - "id": 1033, - "name": "SolanaWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 725, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L725" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1034, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1035, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 727, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L727" - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1038, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 735, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L735" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1039, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1041, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 740, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L740" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1042, - "name": "signInWithSolana", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 742, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L742" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "chain" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1040, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 737, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L737" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1041, 1042, 1040] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 735, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L735" - } - ] - } - } - }, - { - "id": 1037, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 733, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L733" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1036, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.solana`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 730, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L730" - } - ], - "type": { - "type": "reference", - "target": 1017, - "name": "SolanaWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1035, 1038, 1037, 1036] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 726, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L726" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1043, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1044, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 748, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L748" - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1045, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Solana compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 751, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L751" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1047, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 756, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L756" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1048, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1049, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 758, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L758" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1049] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 756, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L756" - } - ] - } - } - }, - { - "id": 1046, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ed25519 signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 754, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L754" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1044, 1045, 1047, 1046] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 747, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L747" - } - ] - } - } - ] - } - }, - { - "id": 847, - "name": "SSOResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 289, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L289" - } - ], - "type": { - "type": "reference", - "target": 794, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 848, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 849, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " - }, - { - "kind": "code", - "text": "`window.location.href`" - }, - { - "kind": "text", - "text": " to take\nthe user to the authentication flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L297" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [849] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 289, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L289" - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1642, - "name": "StartPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2751, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2751" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1643, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1644, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2752, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2752" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1645, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1646, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2753, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2753" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1646] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2752, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2752" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1644] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2751, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2751" - } - ] - } - } - }, - { - "id": 791, - "name": "StrictOmit", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A stricter version of TypeScript's Omit that only allows omitting keys that actually exist.\nThis prevents typos and ensures type safety at compile time.\nUnlike regular Omit, this will error if you try to omit a non-existent key." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 214, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L214" - } - ], - "typeParameters": [ - { - "id": 792, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 793, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 792, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 792, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 793, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1286, - "name": "SupportedStorage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1807, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1807" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PromisifyMethods" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "PromisifyMethods", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1287, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1288, - "name": "isServer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1817, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1817" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1288] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1809, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1809" - } - ] - } - } - ] - } - }, - { - "id": 1492, - "name": "UpdateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing custom provider.\nAll fields are optional. Only provided fields will be updated.\n" - }, - { - "kind": "code", - "text": "`provider_type`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " are immutable and cannot be changed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2334, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2334" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1493, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1497, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2342" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1500, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2348, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2348" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1501, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2350" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1507, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2362, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2362" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1495, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2338, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2338" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1496, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2340, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2340" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1505, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2358, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2358" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1503, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2354, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2354" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1502, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2352, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2352" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1504, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2356" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1510, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2368, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2368" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1494, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2336, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2336" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1499, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2346, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2346" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1498, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2344" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1506, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2360" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1508, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2364, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2364" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1509, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2366, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2366" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1497, 1500, 1501, 1507, 1495, 1496, 1505, 1503, 1502, 1504, 1510, 1494, 1499, 1498, - 1506, 1508, 1509 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2334, - "character": 41, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2334" - } - ] - } - } - }, - { - "id": 1390, - "name": "UpdateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing OAuth client.\nAll fields are optional. Only provided fields will be updated.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2095, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2095" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1392, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2097, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2097" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1393, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2099" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1396, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2105, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2105" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1359, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 1394, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2101, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2101" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1395, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2103, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2103" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1397, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2107, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2107" - } - ], - "type": { - "type": "reference", - "target": 1364, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1392, 1393, 1396, 1394, 1395, 1397] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2095, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2095" - } - ] - } - } - }, - { - "id": 850, - "name": "UserResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 300, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L300" - } - ], - "type": { - "type": "reference", - "target": 803, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 852, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "reference", - "target": 899, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [852] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 300, - "character": 56, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L300" - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1069, - "name": "VerifyOtpParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 803, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L803" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1070, - "name": "VerifyMobileOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1078, - "name": "VerifyEmailOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1086, - "name": "VerifyTokenHashParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1647, - "name": "VerifyPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2757, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2757" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1648, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1649, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startAuthentication" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2759, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2759" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1650, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.get()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2761, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2761" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1649, 1650] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2757, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2757" - } - ] - } - } - }, - { - "id": 1638, - "name": "VerifyPasskeyRegistrationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2744, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2744" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1639, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1640, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startRegistration" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2746, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2746" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1641, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.create()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2748, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2748" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1640, 1641] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 2744, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L2744" - } - ] - } - } - }, - { - "id": 785, - "name": "WeakPassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 198, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L198" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 786, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 788, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 200, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L200" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 787, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 784, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [788, 787] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 198, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L198" - } - ] - } - } - }, - { - "id": 784, - "name": "WeakPasswordReasons", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 197, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L197" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1068, - "name": "Web3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 801, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L801" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1033, - "name": "SolanaWeb3Credentials", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1051, - "name": "EthereumWeb3Credentials", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 710, - "name": "AuthAdminApi", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/AuthAdminApi.ts", - "line": 3, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/AuthAdminApi.ts#L3" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1, - "name": "default", - "package": "@supabase/auth-js" - } - }, - "defaultValue": "GoTrueAdminApi" - }, - { - "id": 711, - "name": "AuthClient", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/AuthClient.ts", - "line": 3, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/AuthClient.ts#L3" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 136, - "name": "default", - "package": "@supabase/auth-js" - } - }, - "defaultValue": "GoTrueClient" - }, - { - "id": 725, - "name": "lockInternals", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Debug flag for " - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": ". The auth\nclient ignores both, so this has no client-side effect." - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 17, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L17" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 726, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 727, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [727] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 17, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L17" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1357, - "name": "SIGN_OUT_SCOPES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/types.ts", - "line": 1998, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/types.ts#L1998" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1705, - "name": "isAuthApiError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 75, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L75" - } - ], - "signatures": [ - { - "id": 1706, - "name": "isAuthApiError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 75, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L75" - } - ], - "parameters": [ - { - "id": 1707, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1744, - "name": "AuthApiError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1702, - "name": "isAuthError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L50" - } - ], - "signatures": [ - { - "id": 1703, - "name": "isAuthError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L50" - } - ], - "parameters": [ - { - "id": 1704, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1726, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1711, - "name": "isAuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 210, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L210" - } - ], - "signatures": [ - { - "id": 1712, - "name": "isAuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 210, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L210" - } - ], - "parameters": [ - { - "id": 1713, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1849, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1714, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 274, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L274" - } - ], - "signatures": [ - { - "id": 1715, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 274, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L274" - } - ], - "parameters": [ - { - "id": 1716, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1907, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1720, - "name": "isAuthRefreshDiscardedError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 328, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L328" - } - ], - "signatures": [ - { - "id": 1721, - "name": "isAuthRefreshDiscardedError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 328, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L328" - } - ], - "parameters": [ - { - "id": 1722, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1941, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1717, - "name": "isAuthRetryableFetchError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 296, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L296" - } - ], - "signatures": [ - { - "id": 1718, - "name": "isAuthRetryableFetchError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 296, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L296" - } - ], - "parameters": [ - { - "id": 1719, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1923, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1708, - "name": "isAuthSessionMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 140, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L140" - } - ], - "signatures": [ - { - "id": 1709, - "name": "isAuthSessionMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 140, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L140" - } - ], - "parameters": [ - { - "id": 1710, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1800, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1723, - "name": "isAuthWeakPasswordError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 373, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L373" - } - ], - "signatures": [ - { - "id": 1724, - "name": "isAuthWeakPasswordError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/errors.ts", - "line": 373, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/errors.ts#L373" - } - ], - "parameters": [ - { - "id": 1725, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1958, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 712, - "name": "navigatorLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 86, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L86" - } - ], - "signatures": [ - { - "id": 713, - "name": "navigatorLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient", - "target": 136 - }, - { - "kind": "text", - "text": ".\n\nYou can turn on debugging by setting the " - }, - { - "kind": "code", - "text": "`supabase.gotrue-js.locks.debug`" - }, - { - "kind": "text", - "text": "\nlocal storage item to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " - }, - { - "kind": "code", - "text": "`request`" - }, - { - "kind": "text", - "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: navigatorLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 86, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L86" - } - ], - "typeParameters": [ - { - "id": 714, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 715, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 716, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 717, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 718, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 89, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L89" - } - ], - "signatures": [ - { - "id": 719, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 89, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L89" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 714, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 714, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 728, - "name": "processLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 325, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L325" - } - ], - "signatures": [ - { - "id": 729, - "name": "processLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#navigatorLock" - }, - { - "kind": "text", - "text": " in browser environments." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: processLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nawait processLock('migrate', 5000, async () => {\n await runMigration()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 325, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L325" - } - ], - "typeParameters": [ - { - "id": 730, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 731, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 732, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 733, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 734, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 328, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L328" - } - ], - "signatures": [ - { - "id": 735, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/src/lib/locks.ts", - "line": 328, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/auth-js/src/lib/locks.ts#L328" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 730, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 730, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [ - 1744, 1726, 1849, 1832, 1979, 1816, 1907, 1878, 1941, 1923, 1800, 1762, 1958, 1780, 1, 136, - 720 - ] - }, - { - "title": "Interfaces", - "children": [ - 933, 864, 1575, 1675, 1144, 1526, 1279, 1411, 1695, 1208, 1349, 1329, 853, 947, 899, 891, - 926, 867, 896, 1078, 1070, 1086 - ] - }, - { - "title": "Type Aliases", - "children": [ - 862, 738, 737, 1201, 993, 1269, 1266, 1276, 1273, 1192, 1196, 1191, 1193, 1194, 1195, 1311, - 1187, 1310, 1312, 1203, 1197, 1188, 1186, 1179, 1565, 1566, 1572, 1573, 820, 1671, 1668, - 1660, 1661, 1667, 1665, 1658, 1659, 1666, 811, 815, 825, 829, 1292, 1471, 1381, 1447, 1515, - 1514, 1434, 1091, 1050, 1051, 781, 880, 879, 1138, 1128, 1147, 1152, 1148, 1159, 1133, 1122, - 748, 1289, 1313, 1511, 739, 1178, 1177, 1175, 1174, 1176, 1160, 1308, 1307, 1309, 1173, - 1161, 1172, 1165, 1164, 1166, 1170, 1089, 1546, 1552, 1365, 1359, 1399, 1363, 1398, 1361, - 1364, 1362, 1567, 1562, 834, 1435, 1300, 1293, 1612, 1617, 1655, 1621, 1607, 1598, 1603, - 1651, 789, 736, 1633, 794, 803, 1319, 1093, 957, 1007, 995, 1627, 971, 976, 1107, 1304, - 1358, 963, 1017, 1033, 847, 1642, 791, 1286, 1492, 1390, 850, 1069, 1647, 1638, 785, 784, - 1068 - ] - }, - { - "title": "Variables", - "children": [710, 711, 725, 1357] - }, - { - "title": "Functions", - "children": [1705, 1702, 1711, 1714, 1720, 1717, 1708, 1723, 712, 728] - } - ], - "packageName": "@supabase/auth-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Auth JS SDK

    \n\n

    An isomorphic JavaScript SDK for the Supabase Auth API.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/auth-js)](https://www.npmjs.com/package/@supabase/auth-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/auth-js)](https://pkg.pr.new/~/supabase/auth-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Quick start\n\nInstall\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install --save @supabase/auth-js\n```" - }, - { - "kind": "text", - "text": "\n\nUsage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst GOTRUE_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: GOTRUE_URL })\n```" - }, - { - "kind": "text", - "text": "\n\n- " - }, - { - "kind": "code", - "text": "`signUp()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signup\n- " - }, - { - "kind": "code", - "text": "`signIn()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signin\n- " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": ": https://supabase.com/docs/reference/javascript/auth-signout\n\n### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`auth-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst AUTH_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: AUTH_URL, fetch: fetch })\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build auth-js\n\n# Build with watch mode for development\npnpm nx build auth-js --watch\n\n# Individual build targets\npnpm nx build:main auth-js # CommonJS build (dist/main/)\npnpm nx build:module auth-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx lint auth-js # Run ESLint\npnpm nx typecheck auth-js # TypeScript type checking\npnpm nx docs auth-js # Generate documentation\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\n### Testing\n\nThe auth-js package has two test suites:\n\n1. **CLI Tests** - Main test suite using Supabase CLI (331 tests)\n2. **Docker Tests** - Edge case tests requiring specific GoTrue configurations (11 tests)\n\n#### Prerequisites\n\n- **Supabase CLI** - Required for main test suite ([installation guide](https://supabase.com/docs/guides/cli))\n- **Docker** - Required for edge case tests\n\n#### Running Tests\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run main test suite with Supabase CLI (recommended)\npnpm nx test:auth auth-js\n\n# Run Docker-only edge case tests\npnpm nx test:docker auth-js\n\n# Run both test suites\npnpm nx test:auth auth-js && pnpm nx test:docker auth-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Main Test Suite (Supabase CLI)\n\nThe " - }, - { - "kind": "code", - "text": "`test:auth`" - }, - { - "kind": "text", - "text": " command automatically:\n\n1. Stops any existing Supabase instance\n2. Starts a local Supabase instance via CLI\n3. Runs the test suite (excludes " - }, - { - "kind": "code", - "text": "`docker-tests/`" - }, - { - "kind": "text", - "text": " folder)\n4. Cleans up after tests complete\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Individual commands for manual control\npnpm nx test:infra auth-js # Start Supabase CLI\npnpm nx test:suite auth-js # Run tests only\npnpm nx test:clean-post auth-js # Stop Supabase CLI\n```" - }, - { - "kind": "text", - "text": "\n\n#### Docker Tests (Edge Cases)\n\nThe " - }, - { - "kind": "code", - "text": "`test:docker`" - }, - { - "kind": "text", - "text": " target runs tests that require specific GoTrue configurations not possible with a single Supabase CLI instance:\n\n- **Signup disabled** - Tests for disabled signup functionality\n- **Asymmetric JWT (RS256)** - Tests for RS256 JWT verification\n- **Phone OTP / SMS** - Tests requiring Twilio SMS provider\n- **Anonymous sign-in disabled** - Tests for disabled anonymous auth\n\nThese tests are located in " - }, - { - "kind": "code", - "text": "`test/docker-tests/`" - }, - { - "kind": "text", - "text": " and use the Docker Compose setup in " - }, - { - "kind": "code", - "text": "`infra/docker-compose.yml`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Individual commands for manual control\npnpm nx test:docker:infra auth-js # Start Docker containers\npnpm nx test:docker:suite auth-js # Run Docker tests only\npnpm nx test:docker:clean-post auth-js # Stop Docker containers\n```" - }, - { - "kind": "text", - "text": "\n\n#### Development Testing\n\nFor actively developing and debugging tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Start Supabase CLI once\npnpm nx test:infra auth-js\n\n# Run tests multiple times (faster since instance stays up)\npnpm nx test:suite auth-js\n\n# Clean up when done\npnpm nx test:clean-post auth-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure\n\n| Suite | Infrastructure | Configuration |\n| ------------ | -------------- | --------------------------- |\n| CLI Tests | Supabase CLI | " - }, - { - "kind": "code", - "text": "`test/supabase/config.toml`" - }, - { - "kind": "text", - "text": " |\n| Docker Tests | Docker Compose | " - }, - { - "kind": "code", - "text": "`infra/docker-compose.yml`" - }, - { - "kind": "text", - "text": " |\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "2": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.__constructor" - }, - "3": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__0" - }, - "5": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "6": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.url" - }, - "7": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.headers" - }, - "8": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "9": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "11": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.fetch" - }, - "12": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "13": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "14": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "15": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "16": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "17": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "18": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "19": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.experimental" - }, - "20": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.mfa" - }, - "21": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.oauth" - }, - "22": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.customProviders" - }, - "23": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.passkey" - }, - "38": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "39": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "40": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "jwt" - }, - "41": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "scope" - }, - "42": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "43": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "44": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "45": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "46": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "47": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "email" - }, - "48": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "options" - }, - "49": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "50": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "51": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.redirectTo" - }, - "52": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "53": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "54": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "55": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "56": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "57": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "58": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "59": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "60": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "61": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "62": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "63": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "64": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "65": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.aud" - }, - "66": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "67": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "69": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "71": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "72": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "73": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "74": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "75": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "76": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "77": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "78": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "79": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "80": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "81": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "id" - }, - "82": { - "sourceFileName": "src/GoTrueAdminApi.ts", - "qualifiedName": "shouldSoftDelete" - }, - "136": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "138": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.__constructor" - }, - "139": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "140": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "142": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.admin" - }, - "143": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.mfa" - }, - "144": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.oauth" - }, - "145": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.passkey" - }, - "213": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "214": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "226": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "227": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "230": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "231": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "232": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "233": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "234": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "235": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "236": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "237": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "238": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "239": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "240": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "241": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "242": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "243": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "244": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "authCode" - }, - "245": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "246": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "247": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "248": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "249": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "250": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "251": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "252": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "253": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "254": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "255": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "256": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "257": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "258": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "259": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "298": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "299": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "300": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "301": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "302": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "303": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "304": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "305": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "306": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "307": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "308": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "309": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "310": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "311": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "314": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "315": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "316": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "317": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "318": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "319": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "320": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "321": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "322": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "323": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "324": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "325": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "326": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "327": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "328": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "329": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "330": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "331": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "332": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "333": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "380": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "381": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "382": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "386": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "387": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "388": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "389": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "390": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "391": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "398": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "399": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "400": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "401": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "402": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "403": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "410": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "411": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "412": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "413": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "414": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "451": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "452": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "453": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "454": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "455": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "461": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "462": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "463": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "464": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "465": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "466": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "467": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "468": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "469": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "470": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "471": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "472": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "473": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "474": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "475": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "476": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "477": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "478": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "479": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "480": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "481": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "485": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "486": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "487": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "email" - }, - "488": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "489": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "490": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.redirectTo" - }, - "491": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.captchaToken" - }, - "492": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "493": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "494": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "495": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "496": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "497": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "498": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "499": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "500": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "501": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "502": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "503": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "504": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.identities" - }, - "505": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "506": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "507": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "508": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "509": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "510": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "511": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "512": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "513": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "520": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "521": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "522": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "identity" - }, - "523": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "524": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "525": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "526": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "527": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "528": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "529": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "575": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "576": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "577": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "578": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "579": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "580": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "662": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "663": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "664": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "665": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "666": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "667": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "668": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.allowExpired" - }, - "669": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.jwks" - }, - "670": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "671": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "672": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "673": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "674": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "675": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.claims" - }, - "676": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.header" - }, - "677": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.signature" - }, - "678": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "679": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "680": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "681": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "682": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "683": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "684": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "685": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "686": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "687": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "688": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "689": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "690": { - "sourceFileName": "src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "710": { - "sourceFileName": "src/AuthAdminApi.ts", - "qualifiedName": "AuthAdminApi" - }, - "711": { - "sourceFileName": "src/AuthClient.ts", - "qualifiedName": "AuthClient" - }, - "712": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "713": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "714": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "R" - }, - "715": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "name" - }, - "716": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "717": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "fn" - }, - "718": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "719": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "720": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "721": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.__constructor" - }, - "722": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "723": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "message" - }, - "724": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.isAcquireTimeout" - }, - "725": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "internals" - }, - "726": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__object" - }, - "727": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__object.debug" - }, - "728": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "729": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "730": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "R" - }, - "731": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "name" - }, - "732": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "733": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "fn" - }, - "734": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "735": { - "sourceFileName": "src/lib/locks.ts", - "qualifiedName": "__type" - }, - "736": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Provider" - }, - "737": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthChangeEventMFA" - }, - "738": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthChangeEvent" - }, - "739": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "LockFunc" - }, - "740": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "741": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "742": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "name" - }, - "743": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "acquireTimeout" - }, - "744": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "fn" - }, - "745": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "746": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "747": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "R" - }, - "748": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueClientOptions" - }, - "749": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "750": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "751": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "752": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "753": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "755": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "756": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "757": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "758": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "url" - }, - "760": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "761": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "762": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "764": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "765": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "766": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "767": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "768": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "769": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "770": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "771": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "772": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "773": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "message" - }, - "774": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "args" - }, - "775": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "776": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.hasCustomAuthorizationHeader" - }, - "777": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "778": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "779": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "780": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "781": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ExperimentalFeatureFlags" - }, - "782": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "783": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkey" - }, - "784": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "785": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "WeakPassword" - }, - "786": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "787": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.reasons" - }, - "788": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "789": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Prettify" - }, - "790": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "791": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "StrictOmit" - }, - "792": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "793": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "794": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequestResult" - }, - "795": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "796": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "797": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "798": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "799": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "800": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "801": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "802": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorType" - }, - "803": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequestResultSafeDestructure" - }, - "804": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "805": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "806": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "807": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "808": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "809": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "810": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "811": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthResponse" - }, - "812": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "813": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "814": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "815": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthResponsePassword" - }, - "816": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "817": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "818": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "819": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.weak_password" - }, - "820": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOtpResponse" - }, - "821": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "822": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "823": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "824": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.messageId" - }, - "825": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthTokenResponse" - }, - "826": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "827": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "828": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "829": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthTokenResponsePassword" - }, - "830": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "831": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "832": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "833": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.weakPassword" - }, - "834": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthResponse" - }, - "835": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "836": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "837": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "838": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "839": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "840": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "841": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "842": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "843": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "844": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "845": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "846": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "847": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SSOResponse" - }, - "848": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "849": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "850": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserResponse" - }, - "851": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "852": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "853": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session" - }, - "854": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.provider_token" - }, - "855": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.provider_refresh_token" - }, - "856": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.access_token" - }, - "857": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.refresh_token" - }, - "858": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.expires_in" - }, - "859": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.expires_at" - }, - "860": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.token_type" - }, - "861": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Session.user" - }, - "862": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMRMethod" - }, - "863": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "864": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry" - }, - "865": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry.method" - }, - "866": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AMREntry.timestamp" - }, - "867": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity" - }, - "868": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.id" - }, - "869": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.user_id" - }, - "870": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_data" - }, - "871": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "874": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_id" - }, - "875": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.provider" - }, - "876": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.created_at" - }, - "877": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.last_sign_in_at" - }, - "878": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserIdentity.updated_at" - }, - "879": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FactorType" - }, - "880": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Factor" - }, - "881": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "882": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "883": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "884": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factor_type" - }, - "885": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.status" - }, - "886": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "887": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "888": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.last_challenged_at" - }, - "889": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Type" - }, - "890": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Status" - }, - "891": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata" - }, - "892": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.provider" - }, - "893": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.providers" - }, - "894": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAppMetadata.__index" - }, - "896": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserMetadata" - }, - "897": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserMetadata.__index" - }, - "899": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User" - }, - "900": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.id" - }, - "901": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.app_metadata" - }, - "902": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.user_metadata" - }, - "903": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.aud" - }, - "904": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.confirmation_sent_at" - }, - "905": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.recovery_sent_at" - }, - "906": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email_change_sent_at" - }, - "907": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.new_email" - }, - "908": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.new_phone" - }, - "909": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.invited_at" - }, - "910": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.action_link" - }, - "911": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email" - }, - "912": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.phone" - }, - "913": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.created_at" - }, - "914": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.confirmed_at" - }, - "915": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.email_confirmed_at" - }, - "916": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.phone_confirmed_at" - }, - "917": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.last_sign_in_at" - }, - "918": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.role" - }, - "919": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.updated_at" - }, - "920": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.identities" - }, - "921": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.is_anonymous" - }, - "922": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.is_sso_user" - }, - "923": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.factors" - }, - "924": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.deleted_at" - }, - "925": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "User.banned_until" - }, - "926": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes" - }, - "927": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.current_password" - }, - "928": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.email" - }, - "929": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.phone" - }, - "930": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.password" - }, - "931": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.nonce" - }, - "932": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UserAttributes.data" - }, - "933": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes" - }, - "934": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.user_metadata" - }, - "935": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.app_metadata" - }, - "936": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.email_confirm" - }, - "937": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.phone_confirm" - }, - "938": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.ban_duration" - }, - "939": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.role" - }, - "940": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.password_hash" - }, - "941": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.id" - }, - "942": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "nonce" - }, - "943": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "phone" - }, - "944": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "email" - }, - "945": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "password" - }, - "946": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "current_password" - }, - "947": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription" - }, - "948": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.id" - }, - "949": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.callback" - }, - "950": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "951": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "952": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "event" - }, - "953": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "session" - }, - "954": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Subscription.unsubscribe" - }, - "955": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "956": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "957": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInAnonymouslyCredentials" - }, - "958": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "959": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "960": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "961": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "962": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "963": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignUpWithPasswordCredentials" - }, - "964": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "965": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "966": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "967": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "968": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "969": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "970": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "971": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasswordCredentials" - }, - "972": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "973": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "974": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "975": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "976": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasswordlessCredentials" - }, - "977": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "978": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "979": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "980": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "981": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "982": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "983": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "984": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "985": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "986": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "987": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "988": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "989": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "990": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "991": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "992": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "993": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthFlowType" - }, - "994": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "995": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithOAuthCredentials" - }, - "996": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "997": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "998": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "999": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1000": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1001": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1002": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.queryParams" - }, - "1003": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1004": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1006": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1007": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithIdTokenCredentials" - }, - "1008": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1009": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1010": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1011": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token" - }, - "1012": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1013": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nonce" - }, - "1014": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1015": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1016": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1017": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SolanaWallet" - }, - "1018": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1019": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signIn" - }, - "1020": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1021": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1022": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "inputs" - }, - "1023": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.publicKey" - }, - "1024": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1025": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.toBase58" - }, - "1026": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1027": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1028": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signMessage" - }, - "1029": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1030": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1031": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "message" - }, - "1032": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "encoding" - }, - "1033": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SolanaWeb3Credentials" - }, - "1034": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1035": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1036": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1037": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1038": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1039": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1040": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1041": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1042": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signInWithSolana" - }, - "1043": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1044": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1045": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1046": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1047": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1048": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1049": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1050": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EthereumWallet" - }, - "1051": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EthereumWeb3Credentials" - }, - "1052": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1053": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1054": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1055": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1056": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1057": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1058": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1059": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1060": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signInWithEthereum" - }, - "1061": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1062": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1063": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1064": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1065": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1066": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1067": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1068": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Web3Credentials" - }, - "1069": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyOtpParams" - }, - "1070": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams" - }, - "1071": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.phone" - }, - "1072": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.token" - }, - "1073": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.type" - }, - "1074": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.options" - }, - "1075": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1076": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1077": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1078": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams" - }, - "1079": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.email" - }, - "1080": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.token" - }, - "1081": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.type" - }, - "1082": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.options" - }, - "1083": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1084": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1085": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1086": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams" - }, - "1087": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.token_hash" - }, - "1088": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.type" - }, - "1089": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MobileOtpType" - }, - "1090": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1091": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EmailOtpType" - }, - "1092": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1093": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ResendParams" - }, - "1094": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1095": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1096": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1097": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1098": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1099": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1100": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1101": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1102": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1103": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1104": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1105": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1106": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1107": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithSSO" - }, - "1108": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1109": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providerId" - }, - "1110": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1111": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1112": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1113": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1114": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1115": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1116": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.domain" - }, - "1117": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1118": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1119": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1120": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1121": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1122": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateSignupLinkParams" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1124": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1125": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1126": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.password" - }, - "1127": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1128": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateInviteOrMagiclinkParams" - }, - "1129": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1130": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1131": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1132": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1133": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateRecoveryLinkParams" - }, - "1134": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1135": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1136": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1137": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1138": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateEmailChangeLinkParams" - }, - "1139": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1140": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1141": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1142": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.newEmail" - }, - "1143": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1144": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions" - }, - "1145": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.data" - }, - "1146": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.redirectTo" - }, - "1147": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkParams" - }, - "1148": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkResponse" - }, - "1149": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1150": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.properties" - }, - "1151": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1152": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkProperties" - }, - "1153": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1154": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.action_link" - }, - "1155": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_otp" - }, - "1156": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.hashed_token" - }, - "1157": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_to" - }, - "1158": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.verification_type" - }, - "1159": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GenerateLinkType" - }, - "1160": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollParams" - }, - "1161": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAUnenrollParams" - }, - "1162": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1163": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factorId" - }, - "1164": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParams" - }, - "1165": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParams" - }, - "1166": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFields" - }, - "1167": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1168": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.webauthn" - }, - "1169": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1170": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParams" - }, - "1171": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1172": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAVerifyParams" - }, - "1173": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFATOTPChannel" - }, - "1174": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeTOTPParams" - }, - "1175": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParams" - }, - "1176": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParams" - }, - "1177": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeParams" - }, - "1178": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyParams" - }, - "1179": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponseData" - }, - "1180": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1181": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1182": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_type" - }, - "1183": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_in" - }, - "1184": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.refresh_token" - }, - "1185": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1186": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponse" - }, - "1187": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponse" - }, - "1188": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAUnenrollResponse" - }, - "1189": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1190": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1191": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponse" - }, - "1192": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponse" - }, - "1193": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponse" - }, - "1194": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseDataJSON" - }, - "1195": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnServerResponse" - }, - "1196": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponse" - }, - "1197": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAListFactorsResponse" - }, - "1198": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1199": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.all" - }, - "1200": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1201": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthenticatorAssuranceLevels" - }, - "1202": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1203": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - }, - "1204": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1205": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.currentLevel" - }, - "1206": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nextLevel" - }, - "1207": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.currentAuthenticationMethods" - }, - "1208": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi" - }, - "1209": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1210": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1211": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1212": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1213": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1214": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1215": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1216": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "1217": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1218": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1219": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1220": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1221": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1222": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1223": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1224": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1225": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1226": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1227": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1228": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1229": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1230": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1231": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1232": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1233": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1234": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1235": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1236": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1237": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1238": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1239": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1240": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1241": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "data" - }, - "1242": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "error" - }, - "1243": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "1244": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1245": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1246": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1247": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1248": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1249": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1250": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1251": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1252": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "1253": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1254": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "1255": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "1256": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1257": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "1258": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "1259": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1260": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "1261": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "1262": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "1263": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "1264": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "jwt" - }, - "1265": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.webauthn" - }, - "1266": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorResponse" - }, - "1267": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1268": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1269": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorParams" - }, - "1270": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1271": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1272": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1273": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsResponse" - }, - "1274": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1275": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.factors" - }, - "1276": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsParams" - }, - "1277": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1278": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1279": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi" - }, - "1280": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "1281": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "1282": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1283": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "1284": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "1285": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1286": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupportedStorage" - }, - "1287": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1288": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.isServer" - }, - "1289": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "InitializeResult" - }, - "1290": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1291": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1292": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CallRefreshTokenResult" - }, - "1293": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Pagination" - }, - "1294": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1295": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.nextPage" - }, - "1296": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lastPage" - }, - "1297": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.total" - }, - "1298": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1300": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PageParams" - }, - "1301": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1302": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.page" - }, - "1303": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.perPage" - }, - "1304": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignOut" - }, - "1305": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1306": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1307": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParams" - }, - "1308": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParams" - }, - "1309": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnParams" - }, - "1310": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponse" - }, - "1311": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponse" - }, - "1312": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnResponse" - }, - "1313": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtHeader" - }, - "1314": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1315": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.alg" - }, - "1316": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1317": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.kid" - }, - "1318": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.typ" - }, - "1319": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RequiredClaims" - }, - "1320": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1321": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "1322": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "1323": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1324": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "1325": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "1326": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "1327": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "1328": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "1329": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload" - }, - "1330": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.email" - }, - "1331": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.phone" - }, - "1332": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.is_anonymous" - }, - "1333": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.jti" - }, - "1334": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.nbf" - }, - "1335": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.app_metadata" - }, - "1336": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.user_metadata" - }, - "1337": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.amr" - }, - "1338": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.ref" - }, - "1339": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "1340": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "1341": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1342": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "1343": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "1344": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "1345": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "1346": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "1347": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JwtPayload.__index" - }, - "1349": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK" - }, - "1350": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.kty" - }, - "1351": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1352": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.key_ops" - }, - "1353": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.alg" - }, - "1354": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.kid" - }, - "1355": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "JWK.__index" - }, - "1357": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SIGN_OUT_SCOPES" - }, - "1358": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignOutScope" - }, - "1359": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientGrantType" - }, - "1360": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1361": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientResponseType" - }, - "1362": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientType" - }, - "1363": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientRegistrationType" - }, - "1364": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientTokenEndpointAuthMethod" - }, - "1365": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClient" - }, - "1366": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1368": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1369": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1370": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_type" - }, - "1371": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1372": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.registration_type" - }, - "1373": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1374": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1375": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1376": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1377": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "1378": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1379": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1380": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1381": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CreateOAuthClientParams" - }, - "1382": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1383": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1384": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1385": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1386": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1387": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "1388": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1389": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1390": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UpdateOAuthClientParams" - }, - "1391": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1392": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "1393": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "1394": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1395": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "1396": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "1397": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "1398": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientResponse" - }, - "1399": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthClientListResponse" - }, - "1400": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1401": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1402": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "1404": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "1405": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1406": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1407": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1408": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1409": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "1410": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1411": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi" - }, - "1412": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "1413": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "1414": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1415": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "1416": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "1417": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1418": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "1419": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "1420": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1421": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "1422": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "1423": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1424": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1425": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "1426": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "1427": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1428": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1429": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1430": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1431": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "1432": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "1433": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "clientId" - }, - "1434": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderType" - }, - "1435": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OIDCDiscoveryDocument" - }, - "1436": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1437": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1438": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_endpoint" - }, - "1439": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_endpoint" - }, - "1440": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1441": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_endpoint" - }, - "1442": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.revocation_endpoint" - }, - "1443": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_scopes" - }, - "1444": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_response_types" - }, - "1445": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_subject_types" - }, - "1446": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.supported_id_token_signing_algs" - }, - "1447": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomOAuthProvider" - }, - "1448": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1449": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1450": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "1451": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "1452": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1453": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1454": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1455": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1456": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1457": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1458": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1459": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1460": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1461": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1462": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1463": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1464": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1465": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1466": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1467": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1468": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_document" - }, - "1469": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1470": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1471": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CreateCustomProviderParams" - }, - "1472": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1473": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "1474": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "1475": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1476": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1477": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1478": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1479": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1480": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1481": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1482": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1483": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1484": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1485": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1486": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1487": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1488": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1489": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1490": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1491": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1492": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "UpdateCustomProviderParams" - }, - "1493": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1494": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1495": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "1496": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "1497": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "1498": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1499": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "1500": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "1501": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "1502": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "1503": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "1504": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "1505": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "1506": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "1507": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "1508": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "1509": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "1510": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "1511": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListCustomProvidersParams" - }, - "1512": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1513": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1514": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderResponse" - }, - "1515": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CustomProviderListResponse" - }, - "1516": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1517": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1518": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1519": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "1520": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1521": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1522": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1523": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1524": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "1525": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1526": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi" - }, - "1527": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "1528": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "1529": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1530": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "1531": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "1532": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1533": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "1534": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "1535": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1536": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "1537": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "1538": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1539": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1540": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "1541": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "1542": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "identifier" - }, - "1543": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1544": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1545": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1546": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationClient" - }, - "1547": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1548": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1549": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "1550": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.uri" - }, - "1551": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "1552": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationDetails" - }, - "1553": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1554": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.authorization_id" - }, - "1555": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_uri" - }, - "1556": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "1557": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1558": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1559": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1560": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1561": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "1562": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthRedirect" - }, - "1563": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1564": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.redirect_url" - }, - "1565": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthAuthorizationDetailsResponse" - }, - "1566": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthConsentResponse" - }, - "1567": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "OAuthGrant" - }, - "1568": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1569": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "1570": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1571": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.granted_at" - }, - "1572": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthGrantsResponse" - }, - "1573": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthRevokeGrantResponse" - }, - "1574": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1575": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi" - }, - "1576": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "1577": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "1578": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1579": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "1580": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "1581": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1582": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1583": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1584": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1585": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "1586": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "1587": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "1588": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1589": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1590": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1591": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "1592": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "1593": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "1594": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "1595": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "options" - }, - "1596": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1597": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.clientId" - }, - "1598": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationOptionsResponse" - }, - "1599": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1600": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1601": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1602": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "1603": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationVerifyParams" - }, - "1604": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1605": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1606": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1607": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyMetadata" - }, - "1608": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1609": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1610": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1611": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1612": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationOptionsResponse" - }, - "1613": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1614": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1615": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1616": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "1617": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationVerifyParams" - }, - "1618": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1619": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "1620": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1621": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyListItem" - }, - "1622": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1623": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1624": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1625": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1626": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.last_used_at" - }, - "1627": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SignInWithPasskeyCredentials" - }, - "1628": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1629": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1630": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1631": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1632": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "1633": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "RegisterPasskeyCredentials" - }, - "1634": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1635": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1636": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1637": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "1638": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyPasskeyRegistrationParams" - }, - "1639": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1640": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "1641": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1642": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "StartPasskeyAuthenticationParams" - }, - "1643": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1644": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1645": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1646": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1647": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VerifyPasskeyAuthenticationParams" - }, - "1648": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1649": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "1650": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "1651": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyUpdateParams" - }, - "1652": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1653": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1654": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.friendlyName" - }, - "1655": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PasskeyDeleteParams" - }, - "1656": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1657": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1658": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationOptionsResponse" - }, - "1659": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationVerifyResponse" - }, - "1660": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationOptionsResponse" - }, - "1661": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationVerifyResponse" - }, - "1662": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1663": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1664": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1665": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyListResponse" - }, - "1666": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyUpdateResponse" - }, - "1667": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyDeleteResponse" - }, - "1668": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminListParams" - }, - "1669": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1670": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1671": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminDeleteParams" - }, - "1672": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1673": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "1674": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "1675": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi" - }, - "1676": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "1677": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "1678": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "1679": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "1680": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1681": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "1682": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "1683": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1684": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "1685": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "1686": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1687": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "1688": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "1689": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "1690": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "1691": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1692": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "1693": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "1694": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1695": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi" - }, - "1696": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "1697": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "1698": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1699": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "1700": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "1701": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1702": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "1703": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "1704": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1705": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "1706": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "1707": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1708": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "1709": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "1710": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1711": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "1712": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "1713": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1714": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "1715": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "1716": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1717": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "1718": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "1719": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1720": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "1721": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "1722": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1723": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "1724": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "1725": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "error" - }, - "1726": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "1727": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.__constructor" - }, - "1728": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "1729": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1730": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1731": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1732": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1733": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1734": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "1736": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1737": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1738": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1739": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1740": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1741": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1742": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1743": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1744": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "1745": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError.__constructor" - }, - "1746": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "1747": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1748": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1749": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1750": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthApiError.status" - }, - "1751": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1752": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1754": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1755": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1756": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1757": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1758": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1759": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1760": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1761": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1762": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "1763": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.__constructor" - }, - "1764": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "1765": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1766": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "originalError" - }, - "1767": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.originalError" - }, - "1768": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1769": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1770": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "1772": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1773": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1774": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1775": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1776": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1777": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1778": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1779": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1780": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "1781": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.__constructor" - }, - "1782": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "1783": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1784": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "name" - }, - "1785": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1786": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "code" - }, - "1787": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1788": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1789": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1790": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1792": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1793": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1794": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1795": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1796": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1797": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1798": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1799": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1800": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "1801": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError.__constructor" - }, - "1802": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "1803": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1804": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1805": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1806": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1808": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1809": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1810": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1811": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1812": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1813": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1814": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1815": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1816": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "1817": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError.__constructor" - }, - "1818": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "1819": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1820": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1821": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1822": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1824": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1825": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1826": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1827": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1828": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1829": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1830": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1831": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1832": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "1833": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError.__constructor" - }, - "1834": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "1835": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1836": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1837": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1838": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1839": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1841": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1842": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1843": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1844": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1845": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1846": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1847": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1848": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1849": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "1850": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.__constructor" - }, - "1851": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "1852": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1853": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "details" - }, - "1854": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1855": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1856": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1857": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.details" - }, - "1858": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1859": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1860": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1861": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "1862": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "1863": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1864": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1865": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1866": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1867": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1868": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1869": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "1870": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1871": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1872": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1873": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1874": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1875": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1876": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1878": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "1879": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.__constructor" - }, - "1880": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "1881": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1882": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "details" - }, - "1883": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1884": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1885": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1886": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.details" - }, - "1887": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1888": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1889": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1890": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "1891": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "1892": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1893": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1894": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1895": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1896": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1897": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1898": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "1899": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1900": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "1901": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1902": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1903": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1904": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1905": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1907": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "1908": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError.__constructor" - }, - "1909": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "1910": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1911": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1912": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1913": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1915": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1916": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1917": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1918": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1919": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1920": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1921": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1922": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1923": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "1924": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError.__constructor" - }, - "1925": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "1926": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1927": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1928": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1929": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1930": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1931": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1933": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1934": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1935": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1936": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1937": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1938": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1939": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1940": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1941": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "1942": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError.__constructor" - }, - "1943": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "1944": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1945": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1946": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1947": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1948": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1950": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1951": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1952": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1953": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1954": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1955": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1956": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1957": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1958": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "1959": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.__constructor" - }, - "1960": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "1961": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1962": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "status" - }, - "1963": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "reasons" - }, - "1964": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.reasons" - }, - "1965": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "1966": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "1967": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1968": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1969": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1970": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1971": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1972": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1973": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.reasons" - }, - "1974": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1975": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1976": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1977": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1979": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "1980": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError.__constructor" - }, - "1981": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "1982": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "message" - }, - "1983": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "1984": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "1985": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "1986": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1988": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1989": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "1990": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type" - }, - "1991": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "1992": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "1993": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "1994": { - "sourceFileName": "src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "1995": { - "sourceFileName": "", - "qualifiedName": "__type" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json b/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json deleted file mode 100644 index 593622de84e..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/postgrest.json +++ /dev/null @@ -1,39675 +0,0 @@ -{ - "id": 0, - "name": "@supabase/postgrest-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 774, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 775, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 776, - "name": "PostgrestBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 777, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 778, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 779, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "parameters": [ - { - "id": 780, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 781, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 786, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 789, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 791, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 792, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 793, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 794, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 795, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 796, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 784, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 797, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 782, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 800, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 785, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 798, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 787, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 788, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 783, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 799, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [786, 789, 784, 797, 782, 800, 785, 798, 787, 788, 783, 799] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 805, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 808, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 809, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 810, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 811, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 812, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 813, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 814, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 815, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 803, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 816, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 801, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 819, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 804, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 817, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 806, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 807, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 802, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 818, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 856, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 857, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 858, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 859, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 861, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [861] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 862, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 863, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [863] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 828, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 829, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 830, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 853, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L565" - } - ], - "signatures": [ - { - "id": 854, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L565" - } - ], - "typeParameters": [ - { - "id": 855, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 855, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 824, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 825, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 826, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 827, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 822, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 823, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 831, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 832, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 833, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 834, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 835, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 836, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 837, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 838, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 839, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 840, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 841, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 842, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - }, - { - "id": 820, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 821, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [775] - }, - { - "title": "Properties", - "children": [805, 808, 803, 816, 801, 819, 804, 817, 806, 807, 802, 818] - }, - { - "title": "Methods", - "children": [856, 828, 853, 824, 822, 831, 820] - } - ], - "categories": [ - { - "title": "Database", - "children": [775, 856, 853, 824, 822, 820] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [828] - }, - { - "title": "Other", - "children": [805, 808, 803, 816, 801, 819, 804, 817, 806, 807, 802, 818, 831] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 68, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L68" - } - ], - "typeParameters": [ - { - "id": 864, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 865, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 866, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 604, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - }, - { - "id": 9, - "name": "PostgrestClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "PostgREST client." - } - ] - }, - "children": [ - { - "id": 10, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L86" - } - ], - "signatures": [ - { - "id": 11, - "name": "PostgrestClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a PostgREST client." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('profiles').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- A " - }, - { - "kind": "code", - "text": "`timeout`" - }, - { - "kind": "text", - "text": " option (in milliseconds) can be set to automatically abort requests that take too long.\n- A " - }, - { - "kind": "code", - "text": "`urlLengthLimit`" - }, - { - "kind": "text", - "text": " option (default: 8000) can be set to control when URL length warnings are included in error messages for aborted requests." - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {\n headers: { apikey: 'your-publishable-key' },\n schema: 'public',\n timeout: 30000, // 30 second timeout\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L86" - } - ], - "typeParameters": [ - { - "id": 12, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 13, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 14, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 15, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 19, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L19" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [15] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 18, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L18" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - }, - { - "id": 17, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 18, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 19, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the PostgREST endpoint" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 20, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 24, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 98, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L98" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 25, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 26, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 27, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 28, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 29, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 30, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 31, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 22, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 96, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L96" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 34, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\n When enabled, idempotent requests (GET, HEAD, OPTIONS) that fail with network\n errors or HTTP 503/520 responses will be automatically retried up to 3 times\n with exponential backoff (1s, 2s, 4s). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 101, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L101" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 23, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to switch to" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 97, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L97" - } - ], - "type": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - }, - { - "id": 32, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout in milliseconds for all requests. When set, requests will automatically abort after this duration to prevent indefinite hangs." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 99, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L99" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 33, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length in characters before warnings/errors are triggered. Defaults to 8000." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L100" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "8000" - } - ], - "groups": [ - { - "title": "Properties", - "children": [24, 22, 34, 23, 32, 33] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 95, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L95" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 9, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 38, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 40, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L40" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 40, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 41, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 42, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 43, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 44, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 45, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 36, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L38" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 47, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 37, - "name": "schemaName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L39" - } - ], - "type": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - }, - { - "id": 35, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 41, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L41" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 48, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a query on a table or a view." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "relation", - "content": [ - { - "kind": "text", - "text": "The table or view name to query" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L152" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L156" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L166" - } - ], - "signatures": [ - { - "id": 49, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L152" - } - ], - "typeParameters": [ - { - "id": 50, - "name": "TableName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 51, - "name": "Table", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 52, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 50, - "name": "TableName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 51, - "name": "Table", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 50, - "name": "TableName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - }, - { - "id": 53, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L156" - } - ], - "typeParameters": [ - { - "id": 54, - "name": "ViewName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 55, - "name": "View", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 56, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 54, - "name": "ViewName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 55, - "name": "View", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 54, - "name": "ViewName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 61, - "name": "rpc", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L374" - } - ], - "signatures": [ - { - "id": 62, - "name": "rpc", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a function call." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// For cross-schema functions where type inference fails, use overrideTypes:\nconst { data } = await supabase\n .schema('schema_b')\n .rpc('function_a', {})\n .overrideTypes<{ id: string; user_id: string }[]>()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function without arguments", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('hello_world')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function without arguments\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function hello_world() returns text as $$\n select 'Hello world';\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function without arguments\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"Hello world\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function with arguments", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('echo', { say: '👋' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with arguments\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function echo(say text) returns text as $$\n select say;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with arguments\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": \"👋\",\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk processing\nYou can process large payloads by passing in an array as an argument." - } - ] - }, - { - "tag": "@example", - "name": "Bulk processing", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('add_one_each', { arr: [1, 2, 3] })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk processing\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function add_one_each(arr int[]) returns int[] as $$\n select array_agg(n + 1) from unnest(arr) as n;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk processing\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n 2,\n 3,\n 4\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\nPostgres functions that return tables can also be combined with [Filters](/docs/reference/javascript/using-filters) and [Modifiers](/docs/reference/javascript/using-modifiers)." - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function with filters", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .rpc('list_stored_countries')\n .eq('id', 1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'),\n (2, 'The Shire');\n\ncreate function list_stored_countries() returns setof countries as $$\n select * from countries;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": 1,\n \"name\": \"Rohan\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Call a read-only Postgres function", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('hello_world', undefined, { get: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a read-only Postgres function\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function hello_world() returns text as $$\n select 'Hello world';\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a read-only Postgres function\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"Hello world\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L374" - } - ], - "typeParameters": [ - { - "id": 63, - "name": "FnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 64, - "name": "Args", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "default": { - "type": "intrinsic", - "name": "never" - } - }, - { - "id": 65, - "name": "FilterBuilder", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/rpc.ts", - "qualifiedName": "RpcFunctionNotFound" - }, - "typeArguments": [ - { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RpcFunctionNotFound", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/rpc.ts", - "qualifiedName": "GetRpcFunctionFilterBuilderByArgs" - }, - "typeArguments": [ - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 64, - "name": "Args", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "GetRpcFunctionFilterBuilderByArgs", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 66, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function name to call" - } - ] - }, - "type": { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 67, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The arguments to pass to the function call" - } - ] - }, - "type": { - "type": "reference", - "target": 64, - "name": "Args", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "defaultValue": "..." - }, - { - "id": 68, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 72, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 392, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L392" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 71, - "name": "get", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the function will be called with\nread-only access mode." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 391, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L391" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 70, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 390, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L390" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [72, 71, 70] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 389, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L389" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Result" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "RelationName" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Relationships" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "RPC" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 57, - "name": "schema", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L192" - } - ], - "signatures": [ - { - "id": 58, - "name": "schema", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L192" - } - ], - "typeParameters": [ - { - "id": 59, - "name": "DynamicSchema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 60, - "name": "schema", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema to query" - } - ] - }, - "type": { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 9, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [10] - }, - { - "title": "Properties", - "children": [38, 36, 47, 37, 35, 46] - }, - { - "title": "Methods", - "children": [48, 61, 57] - } - ], - "categories": [ - { - "title": "Database", - "children": [10, 48, 61, 57] - }, - { - "title": "Other", - "children": [38, 36, 47, 37, 35, 46] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 16, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L16" - } - ], - "typeParameters": [ - { - "id": 74, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)" - } - ] - }, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 75, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 77, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 19, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L19" - } - ], - "type": { - "type": "inferred", - "name": "I", - "constraint": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [77] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 18, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L18" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 22, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L22" - } - ] - } - } - } - }, - { - "id": 79, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n" - }, - { - "kind": "code", - "text": "`\"public\"`" - }, - { - "kind": "text", - "text": ", this must be supplied manually." - } - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 80, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 867, - "name": "PostgrestError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error format\n\nReturned by every PostgREST request that fails. When something fails, the\nsingle most useful field is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — Postgres often returns the\nactionable fix there, not in " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": ". Always log the full object (e.g.\n" - }, - { - "kind": "code", - "text": "`console.error(error)`" - }, - { - "kind": "text", - "text": "); logging only " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": " hides the hint.\n\nRead the fields in roughly this order of usefulness:\n\n- " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — actionable guidance from the database when available. For\n permission-denied errors (" - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "), this is the literal SQL to fix the\n problem, e.g.\n " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.users TO anon;\"`" - }, - { - "kind": "text", - "text": ".\n Missing column? " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " suggests the column you probably meant. Whenever\n Postgres knows the fix, it puts it in " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": " — stable error code from PostgREST (e.g. " - }, - { - "kind": "code", - "text": "`PGRST301`" - }, - { - "kind": "text", - "text": ") or Postgres\n (e.g. " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "). Branch on this rather than on " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " text.\n- " - }, - { - "kind": "code", - "text": "`details`" - }, - { - "kind": "text", - "text": " — extra context, often the offending value, key, or row.\n- " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " — human-readable summary. Useful in UI strings; less useful\n for debugging.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", - "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" - } - ] - }, - "children": [ - { - "id": 868, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "signatures": [ - { - "id": 869, - "name": "PostgrestError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport PostgrestError from '@supabase/postgrest-js'\n\nthrow new PostgrestError({\n message: 'Row level security prevented the request',\n details: 'RLS denied the insert',\n hint: 'Check your policies',\n code: 'PGRST301',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "parameters": [ - { - "id": 870, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 875, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 73, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 873, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 874, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 872, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [875, 873, 874, 872] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 867, - "name": "PostgrestError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 878, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L28" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 876, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 877, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L27" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 879, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "signatures": [ - { - "id": 880, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 881, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 886, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 76, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 884, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 885, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 62, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 883, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 882, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [886, 884, 885, 883, 882] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [868] - }, - { - "title": "Properties", - "children": [878, 876, 877] - }, - { - "title": "Methods", - "children": [879] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 25, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L25" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 186, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 187, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 188, - "name": "PostgrestFilterBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 189, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 190, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 191, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 192, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 193, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 194, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 195, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 196, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 197, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 202, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 205, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 206, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 207, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 208, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 209, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 210, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 211, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 212, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 200, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 213, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 198, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 216, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 201, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 203, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 204, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 199, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 215, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [202, 205, 200, 213, 198, 216, 201, 214, 203, 204, 199, 215] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 606, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 605, - "name": "default.constructor" - } - }, - { - "id": 551, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 721, - "name": "default.body" - } - }, - { - "id": 554, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 555, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 556, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 557, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 558, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 559, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 560, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 561, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 724, - "name": "default.fetch" - } - }, - { - "id": 549, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 719, - "name": "default.headers" - } - }, - { - "id": 562, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 732, - "name": "default.isMaybeSingle" - } - }, - { - "id": 547, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 717, - "name": "default.method" - } - }, - { - "id": 565, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": 735, - "name": "default.retryEnabled" - } - }, - { - "id": 550, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 720, - "name": "default.schema" - } - }, - { - "id": 563, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 733, - "name": "default.shouldStripNulls" - } - }, - { - "id": 552, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "target": 722, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 553, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 723, - "name": "default.signal" - } - }, - { - "id": 548, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 718, - "name": "default.url" - } - }, - { - "id": 564, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 734, - "name": "default.urlLengthLimit" - } - }, - { - "id": 516, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "signatures": [ - { - "id": 517, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "parameters": [ - { - "id": 518, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 687, - "name": "default.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 686, - "name": "default.abortSignal" - } - }, - { - "id": 355, - "name": "containedBy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is contained by " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('classes')\n .select('name')\n .containedBy('days', ['monday', 'tuesday', 'wednesday', 'friday'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n classes (\n id int8 primary key,\n name text,\n days text[]\n );\n\ninsert into\n classes (id, name, days)\nvalues\n (1, 'Chemistry', array['monday', 'friday']),\n (2, 'History', array['monday', 'wednesday', 'thursday']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Chemistry\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .containedBy('during', '[2000-01-01 00:00, 2000-01-01 23:59)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On `jsonb` columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select('name')\n .containedBy('address', {})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210, \"street\": \"Melrose Place\" }'),\n (2, 'Jane', '{}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Jane\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1003, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1003" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1007, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1007" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1138" - } - ], - "signatures": [ - { - "id": 356, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1003, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1003" - } - ], - "typeParameters": [ - { - "id": 357, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 358, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 357, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 359, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 357, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 360, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1007, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1007" - } - ], - "parameters": [ - { - "id": 361, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 362, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 347, - "name": "contains", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " contains every element appearing in " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('issues')\n .select()\n .contains('tags', ['is:open', 'priority:low'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n issues (\n id int8 primary key,\n title text,\n tags text[]\n );\n\ninsert into\n issues (id, title, tags)\nvalues\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"title\": \"Cache invalidation is not working\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .contains('during', '[2000-01-01 13:00, 2000-01-01 13:30)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On `jsonb` columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select('name')\n .contains('address', { postcode: 90210 })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210, \"street\": \"Melrose Place\" }'),\n (2, 'Jane', '{}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Michael\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 854, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L854" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 858, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L858" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 988, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L988" - } - ], - "signatures": [ - { - "id": 348, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 854, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L854" - } - ], - "typeParameters": [ - { - "id": 349, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 350, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 349, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 351, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 349, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 352, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 858, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L858" - } - ], - "parameters": [ - { - "id": 353, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 354, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 525, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "signatures": [ - { - "id": 526, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 696, - "name": "default.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 695, - "name": "default.csv" - } - }, - { - "id": 217, - "name": "eq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L158" - } - ], - "signatures": [ - { - "id": 218, - "name": "eq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nTo check if the value of " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL, you should use " - }, - { - "kind": "code", - "text": "`.is()`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L158" - } - ], - "typeParameters": [ - { - "id": 219, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 220, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 219, - "typeArguments": [ - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 219, - "typeArguments": [ - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 221, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "reflection", - "declaration": { - "id": 222, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 529, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "signatures": [ - { - "id": 530, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "parameters": [ - { - "id": 531, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 532, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 533, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 859, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L859" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 536, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 862, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L862" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 538, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 864, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L864" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "defaultValue": "'text'" - }, - { - "id": 535, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L861" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 534, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 860, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L860" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 537, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 863, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [533, 536, 538, 535, 534, 537] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 858, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L858" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 700, - "name": "default.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 699, - "name": "default.explain" - } - }, - { - "id": 455, - "name": "filter", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`opearator`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "operator", - "content": [ - { - "kind": "text", - "text": "The operator to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "filter() expects you to use the raw PostgREST syntax for the filter values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.filter('id', 'in', '(5,6,7)') // Use `()` for `in` filter\n.filter('arraycol', 'cs', '{\"a\",\"b\"}') // Use `cs` for `contains()`, `{}` for array values\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .filter('name', 'in', '(\"Han\",\"Yoda\")')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .filter('instruments.name', 'eq', 'flute')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2017, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2017" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2022, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2022" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2136, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2136" - } - ], - "signatures": [ - { - "id": 456, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2017, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2017" - } - ], - "typeParameters": [ - { - "id": 457, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 458, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 457, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 459, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - }, - { - "type": "literal", - "value": "not.match" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.isdistinct" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - }, - { - "type": "literal", - "value": "not.imatch" - } - ] - } - }, - { - "id": 460, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 461, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2022, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2022" - } - ], - "parameters": [ - { - "id": 462, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 463, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 464, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 527, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "signatures": [ - { - "id": 528, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 698, - "name": "default.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 697, - "name": "default.geojson" - } - }, - { - "id": 228, - "name": "gt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nWhen using [reserved words](https://www.postgresql.org/docs/current/sql-keywords-appendix.html) for column names you need\nto add double quotes e.g. " - }, - { - "kind": "code", - "text": "`.gt('\"order\"', 2)`" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .gt('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 245, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L245" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L246" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 295, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L295" - } - ], - "signatures": [ - { - "id": 229, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 245, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L245" - } - ], - "typeParameters": [ - { - "id": 230, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 231, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 230, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 232, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 230, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 233, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L246" - } - ], - "parameters": [ - { - "id": 234, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 235, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 236, - "name": "gte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than or equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .gte('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L300" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L301" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L350" - } - ], - "signatures": [ - { - "id": 237, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L300" - } - ], - "typeParameters": [ - { - "id": 238, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 239, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 238, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 240, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 238, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 241, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L301" - } - ], - "parameters": [ - { - "id": 242, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 243, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 284, - "name": "ilike", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The pattern to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .ilike('name', '%lu%')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L550" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L551" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 596, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L596" - } - ], - "signatures": [ - { - "id": 285, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L550" - } - ], - "typeParameters": [ - { - "id": 286, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 287, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 286, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 288, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 289, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L551" - } - ], - "parameters": [ - { - "id": 290, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 291, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 292, - "name": "ilikeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches all of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 601, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L601" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L605" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 615, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L615" - } - ], - "signatures": [ - { - "id": 293, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 601, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L601" - } - ], - "typeParameters": [ - { - "id": 294, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 295, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 296, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 297, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L605" - } - ], - "parameters": [ - { - "id": 298, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 299, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 300, - "name": "ilikeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches any of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 620, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L620" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 624, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L624" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 634, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L634" - } - ], - "signatures": [ - { - "id": 301, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 620, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L620" - } - ], - "typeParameters": [ - { - "id": 302, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 303, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 302, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 304, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 305, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 624, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L624" - } - ], - "parameters": [ - { - "id": 306, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 307, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 337, - "name": "in", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L801" - } - ], - "signatures": [ - { - "id": 338, - "name": "in", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .in('name', ['Leia', 'Han'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L801" - } - ], - "typeParameters": [ - { - "id": 339, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 340, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 341, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 324, - "name": "is", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL by setting " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\n\nFor boolean columns, you can also set " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " and it\nwill behave the same way as " - }, - { - "kind": "code", - "text": "`.eq()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\nUsing the " - }, - { - "kind": "code", - "text": "`eq()`" - }, - { - "kind": "text", - "text": " filter doesn't work when filtering for " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\n\nInstead, you need to use " - }, - { - "kind": "code", - "text": "`is()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Checking for nullness, true or false", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .select()\n .is('name', null)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'null'),\n (2, null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"null\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L667" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 671, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L671" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 726, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L726" - } - ], - "signatures": [ - { - "id": 325, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L667" - } - ], - "typeParameters": [ - { - "id": 326, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 327, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 326, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 328, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 326, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 329, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 671, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L671" - } - ], - "parameters": [ - { - "id": 330, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 331, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 332, - "name": "isDistinct", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 741, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L741" - } - ], - "signatures": [ - { - "id": 333, - "name": "isDistinct", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS DISTINCT FROM " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nUnlike " - }, - { - "kind": "code", - "text": "`.neq()`" - }, - { - "kind": "text", - "text": ", this treats " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " as a comparable value. Two " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " values\nare considered equal (not distinct), and comparing " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " with any non-NULL\nvalue returns true (distinct)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 741, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L741" - } - ], - "typeParameters": [ - { - "id": 334, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 335, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 336, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 260, - "name": "like", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The pattern to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .like('name', '%Lu%')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L461" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L462" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L507" - } - ], - "signatures": [ - { - "id": 261, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L461" - } - ], - "typeParameters": [ - { - "id": 262, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 263, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 262, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 264, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 265, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L462" - } - ], - "parameters": [ - { - "id": 266, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 267, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 268, - "name": "likeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches all of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L512" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L516" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 526, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L526" - } - ], - "signatures": [ - { - "id": 269, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L512" - } - ], - "typeParameters": [ - { - "id": 270, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 271, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 270, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 272, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 273, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L516" - } - ], - "parameters": [ - { - "id": 274, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 275, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 276, - "name": "likeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches any of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 531, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L531" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 535, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L535" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 545, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L545" - } - ], - "signatures": [ - { - "id": 277, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 531, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L531" - } - ], - "typeParameters": [ - { - "id": 278, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 279, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 278, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 280, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 281, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 535, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L535" - } - ], - "parameters": [ - { - "id": 282, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 283, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 501, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "signatures": [ - { - "id": 502, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "parameters": [ - { - "id": 503, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 504, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 505, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 506, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 507, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [506, 507] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 672, - "name": "default.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 671, - "name": "default.limit" - } - }, - { - "id": 244, - "name": "lt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .lt('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 355, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L355" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L356" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 401, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L401" - } - ], - "signatures": [ - { - "id": 245, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 355, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L355" - } - ], - "typeParameters": [ - { - "id": 246, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 247, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 246, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 248, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 246, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 249, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L356" - } - ], - "parameters": [ - { - "id": 250, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 251, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 252, - "name": "lte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than or equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .lte('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L406" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 407, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L407" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L456" - } - ], - "signatures": [ - { - "id": 253, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L406" - } - ], - "typeParameters": [ - { - "id": 254, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 255, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 254, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 256, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 254, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 257, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 407, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L407" - } - ], - "parameters": [ - { - "id": 258, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 259, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 427, - "name": "match", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where each column in " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": " keys is equal to its\nassociated value. Shorthand for multiple " - }, - { - "kind": "code", - "text": "`.eq()`" - }, - { - "kind": "text", - "text": "s." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "query", - "content": [ - { - "kind": "text", - "text": "The object to filter with, with column names as keys mapped\nto their filter values" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .match({ id: 2, name: 'Leia' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1708" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1709" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1754, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1754" - } - ], - "signatures": [ - { - "id": 428, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1708" - } - ], - "typeParameters": [ - { - "id": 429, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 430, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "reference", - "target": 429, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 429, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 431, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1709" - } - ], - "parameters": [ - { - "id": 432, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 544, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "signatures": [ - { - "id": 545, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "parameters": [ - { - "id": 546, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/feature-flags.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 715, - "name": "default.maxAffected" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 714, - "name": "default.maxAffected" - } - }, - { - "id": 522, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "signatures": [ - { - "id": 523, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "typeParameters": [ - { - "id": 524, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 524, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 693, - "name": "default.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 692, - "name": "default.maybeSingle" - } - }, - { - "id": 223, - "name": "neq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L227" - } - ], - "signatures": [ - { - "id": 224, - "name": "neq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is not equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nThis filter does not include rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": ". To match null\nvalues, use " - }, - { - "kind": "code", - "text": "`.is(column, null)`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .neq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L227" - } - ], - "typeParameters": [ - { - "id": 225, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 226, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 225, - "typeArguments": [ - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 225, - "typeArguments": [ - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 227, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 433, - "name": "not", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`opearator`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "operator", - "content": [ - { - "kind": "text", - "text": "The operator to be negated to filter with, following\nPostgREST syntax" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "not() expects you to use the raw PostgREST syntax for the filter values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.not('id', 'in', '(5,6,7)') // Use `()` for `in` filter\n.not('arraycol', 'cs', '{\"a\",\"b\"}') // Use `cs` for `contains()`, `{}` for array values\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .select()\n .not('name', 'is', null)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'null'),\n (2, null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"null\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1765, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1765" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1779, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1779" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1784, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1784" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1844, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1844" - } - ], - "signatures": [ - { - "id": 434, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1765, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1765" - } - ], - "typeParameters": [ - { - "id": 435, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 436, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 437, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "is" - } - }, - { - "id": 438, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": null - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "NonNullableColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullableColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "NarrowResultColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NarrowResultColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - }, - { - "id": 439, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1779, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1779" - } - ], - "typeParameters": [ - { - "id": 440, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 441, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 440, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 442, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 443, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 440, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 444, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1784, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1784" - } - ], - "parameters": [ - { - "id": 445, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 446, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 447, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 342, - "name": "notIn", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 832, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L832" - } - ], - "signatures": [ - { - "id": 343, - "name": "notIn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NOT included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 832, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L832" - } - ], - "typeParameters": [ - { - "id": 344, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 345, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 346, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 448, - "name": "or", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2005, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2005" - } - ], - "signatures": [ - { - "id": 449, - "name": "or", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`filters`" - }, - { - "kind": "text", - "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " - }, - { - "kind": "code", - "text": "`.or()`" - }, - { - "kind": "text", - "text": " filter across multiple tables." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.or('id.in.(5,6,7), arraycol.cs.{\"a\",\"b\"}') // Use `()` for `in` filter, `{}` for array values and `cs` for `contains()`.\n.or('id.in.(5,6,7), arraycol.cd.{\"a\",\"b\"}') // Use `cd` for `containedBy()`\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.eq.2,name.eq.Han')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n },\n {\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` with `and`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` on referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2005, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2005" - } - ], - "parameters": [ - { - "id": 450, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filters to use, following PostgREST syntax" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " instead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 454, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to filter on referenced tables\ninstead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [453, 454] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 470, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order the query result by " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": ".\n\nYou 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 " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " in the query." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to order by" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.ascending", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the result will be in ascending order" - } - ] - }, - { - "tag": "@param", - "name": "options.nullsFirst", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear first. If " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear last." - } - ] - }, - { - "tag": "@param", - "name": "options.referencedTable", - "content": [ - { - "kind": "text", - "text": "Set this to order a referenced table by\nits columns" - } - ] - }, - { - "tag": "@param", - "name": "options.foreignTable", - "content": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('id, name')\n .order('id', { ascending: false })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " doesn't affect the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .order('name', { referencedTable: 'instruments', ascending: false })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n },\n {\n \"name\": \"harp\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": []\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referenced_table(col)`" - }, - { - "kind": "text", - "text": " affects the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "Order parent table by a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('instruments')\n .select(`\n name,\n section:orchestral_sections (\n name\n )\n `)\n .order('section(name)', { ascending: true })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"violin\",\n \"orchestral_sections\": {\"name\": \"strings\"}\n },\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L322" - } - ], - "signatures": [ - { - "id": 471, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - } - ], - "typeParameters": [ - { - "id": 472, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 473, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 472, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 474, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 475, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 476, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 477, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 478, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [476, 477, 478] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 641, - "name": "default.order" - } - }, - { - "id": 479, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - } - ], - "parameters": [ - { - "id": 480, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 481, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 482, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 483, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 484, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 485, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [483, 484, 485] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 649, - "name": "default.order" - } - }, - { - "id": 486, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - } - ], - "typeParameters": [ - { - "id": 487, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 488, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 487, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 489, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 490, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 491, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 493, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 492, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [491, 493, 492] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 656, - "name": "default.order" - } - }, - { - "id": 494, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - } - ], - "parameters": [ - { - "id": 495, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 496, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 497, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 498, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 500, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 499, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [498, 500, 499] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 664, - "name": "default.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 640, - "name": "default.order" - } - }, - { - "id": 403, - "name": "overlaps", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for array and range columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " have an element in common." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The array or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The array or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('issues')\n .select('title')\n .overlaps('tags', ['is:closed', 'severity:high'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n issues (\n id int8 primary key,\n title text,\n tags text[]\n );\n\ninsert into\n issues (id, title, tags)\nvalues\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"title\": \"Cache invalidation is not working\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .overlaps('during', '[2000-01-01 12:45, 2000-01-01 13:15)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1468" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1472" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1565" - } - ], - "signatures": [ - { - "id": 404, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1468" - } - ], - "typeParameters": [ - { - "id": 405, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 406, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 405, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 407, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 405, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 408, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1472" - } - ], - "parameters": [ - { - "id": 409, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 410, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 589, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 590, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 591, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 592, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 593, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 594, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [594] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 595, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 596, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [596] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 760, - "name": "default.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 759, - "name": "default.overrideTypes" - } - }, - { - "id": 508, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "signatures": [ - { - "id": 509, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "parameters": [ - { - "id": 510, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 511, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 512, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 513, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 514, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 515, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [514, 515] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 679, - "name": "default.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 678, - "name": "default.range" - } - }, - { - "id": 395, - "name": "rangeAdjacent", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is\nmutually exclusive to " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " and there can be no element between the two\nranges." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeAdjacent('during', '[2000-01-01 12:00, 2000-01-01 13:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1405, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1405" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1406" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1463" - } - ], - "signatures": [ - { - "id": 396, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1405, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1405" - } - ], - "typeParameters": [ - { - "id": 397, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 398, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 397, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 399, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 400, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1406" - } - ], - "parameters": [ - { - "id": 401, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 402, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 363, - "name": "rangeGt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than any element in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeGt('during', '[2000-01-02 08:00, 2000-01-02 09:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 2,\n \"room_name\": \"Topaz\",\n \"during\": \"[\\\"2000-01-02 09:00:00\\\",\\\"2000-01-02 10:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1152" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1153" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1210" - } - ], - "signatures": [ - { - "id": 364, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1152" - } - ], - "typeParameters": [ - { - "id": 365, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 366, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 365, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 367, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 368, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1153" - } - ], - "parameters": [ - { - "id": 369, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 370, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 371, - "name": "rangeGte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is either contained in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " or greater than any element in\n" - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeGte('during', '[2000-01-02 08:30, 2000-01-02 09:30)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 2,\n \"room_name\": \"Topaz\",\n \"during\": \"[\\\"2000-01-02 09:00:00\\\",\\\"2000-01-02 10:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1215, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1215" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1216" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1274, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1274" - } - ], - "signatures": [ - { - "id": 372, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1215, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1215" - } - ], - "typeParameters": [ - { - "id": 373, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 374, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 373, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 375, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 376, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1216" - } - ], - "parameters": [ - { - "id": 377, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 378, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 379, - "name": "rangeLt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than any element in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeLt('during', '[2000-01-01 15:00, 2000-01-01 16:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1279, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1279" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1280" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1336, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1336" - } - ], - "signatures": [ - { - "id": 380, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1279, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1279" - } - ], - "typeParameters": [ - { - "id": 381, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 382, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 381, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 383, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 384, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1280" - } - ], - "parameters": [ - { - "id": 385, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 386, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 387, - "name": "rangeLte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is either contained in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " or less than any element in\n" - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeLte('during', '[2000-01-01 14:00, 2000-01-01 16:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1341, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1341" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1342" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1400, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1400" - } - ], - "signatures": [ - { - "id": 388, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1341, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1341" - } - ], - "typeParameters": [ - { - "id": 389, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 390, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 389, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 391, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 392, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1342" - } - ], - "parameters": [ - { - "id": 393, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 394, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 316, - "name": "regexIMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the PostgreSQL regex " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": "\ncase-insensitively (using the " - }, - { - "kind": "code", - "text": "`~*`" - }, - { - "kind": "text", - "text": " operator)." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The PostgreSQL regular expression pattern to match with" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L653" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 654, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L654" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 662, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L662" - } - ], - "signatures": [ - { - "id": 317, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L653" - } - ], - "typeParameters": [ - { - "id": 318, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 319, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 318, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 320, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 321, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 654, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L654" - } - ], - "parameters": [ - { - "id": 322, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 323, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 308, - "name": "regexMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the PostgreSQL regex " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": "\ncase-sensitively (using the " - }, - { - "kind": "code", - "text": "`~`" - }, - { - "kind": "text", - "text": " operator)." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The PostgreSQL regular expression pattern to match with" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 639, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L639" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 640, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 648, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L648" - } - ], - "signatures": [ - { - "id": 309, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 639, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L639" - } - ], - "typeParameters": [ - { - "id": 310, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 311, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 310, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 312, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 313, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 640, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640" - } - ], - "parameters": [ - { - "id": 314, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 315, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 574, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 575, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 576, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 745, - "name": "default.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 744, - "name": "default.retry" - } - }, - { - "id": 541, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "signatures": [ - { - "id": 542, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "typeParameters": [ - { - "id": 543, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 543, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 712, - "name": "default.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 711, - "name": "default.returns" - } - }, - { - "id": 539, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "signatures": [ - { - "id": 540, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 710, - "name": "default.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 709, - "name": "default.rollback" - } - }, - { - "id": 465, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "signatures": [ - { - "id": 466, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "typeParameters": [ - { - "id": 467, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 468, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 469, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 636, - "name": "default.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 635, - "name": "default.select" - } - }, - { - "id": 570, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 571, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 572, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 573, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 741, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 740, - "name": "default.setHeader" - } - }, - { - "id": 519, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "signatures": [ - { - "id": 520, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "typeParameters": [ - { - "id": 521, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 521, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 690, - "name": "default.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 689, - "name": "default.single" - } - }, - { - "id": 568, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 569, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 739, - "name": "default.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 738, - "name": "default.stripNulls" - } - }, - { - "id": 411, - "name": "textSearch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for text and tsvector columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the query string in " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The text or tsvector column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "query", - "content": [ - { - "kind": "text", - "text": "The query text to match with" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.config", - "content": [ - { - "kind": "text", - "text": "The text search configuration to use" - } - ] - }, - { - "tag": "@param", - "name": "options.type", - "content": [ - { - "kind": "text", - "text": "Change how the " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": " text is interpreted" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- For more information, see [Postgres full text search](/docs/guides/database/full-text-search)." - } - ] - }, - { - "tag": "@example", - "name": "Text search", - "content": [ - { - "kind": "code", - "text": "```ts\nconst result = await supabase\n .from(\"texts\")\n .select(\"content\")\n .textSearch(\"content\", `'eggs' & 'ham'`, {\n config: \"english\",\n });\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Text search\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table texts (\n id bigint\n primary key\n generated always as identity,\n content text\n);\n\ninsert into texts (content) values\n ('Four score and seven years ago'),\n ('The road goes ever on and on'),\n ('Green eggs and ham')\n;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Text search\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"content\": \"Green eggs and ham\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Basic normalization\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`plainto_tsquery`" - }, - { - "kind": "text", - "text": " function." - } - ] - }, - { - "tag": "@example", - "name": "Basic normalization", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat' & 'cat'`, {\n type: 'plain',\n config: 'english'\n })\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Full normalization\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`phraseto_tsquery`" - }, - { - "kind": "text", - "text": " function." - } - ] - }, - { - "tag": "@example", - "name": "Full normalization", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat' & 'cat'`, {\n type: 'phrase',\n config: 'english'\n })\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Websearch\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`websearch_to_tsquery`" - }, - { - "kind": "text", - "text": " function.\nThis function will never raise syntax errors, which makes it possible to use raw user-supplied input for search, and can be used\nwith advanced operators.\n\n- " - }, - { - "kind": "code", - "text": "`unquoted text`" - }, - { - "kind": "text", - "text": ": text not inside quote marks will be converted to terms separated by & operators, as if processed by plainto_tsquery.\n- " - }, - { - "kind": "code", - "text": "`\"quoted text\"`" - }, - { - "kind": "text", - "text": ": text inside quote marks will be converted to terms separated by " - }, - { - "kind": "code", - "text": "`<->`" - }, - { - "kind": "text", - "text": " operators, as if processed by phraseto_tsquery.\n- " - }, - { - "kind": "code", - "text": "`OR`" - }, - { - "kind": "text", - "text": ": the word “or” will be converted to the | operator.\n- " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": ": a dash will be converted to the ! operator." - } - ] - }, - { - "tag": "@example", - "name": "Websearch", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat or cat'`, {\n type: 'websearch',\n config: 'english'\n })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1576, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1576" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1581, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1581" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1690" - } - ], - "signatures": [ - { - "id": 412, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1576, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1576" - } - ], - "typeParameters": [ - { - "id": 413, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 414, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 413, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 415, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 416, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 417, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 418, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 419, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [418, 419] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 420, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1581, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1581" - } - ], - "parameters": [ - { - "id": 421, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 423, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 424, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 425, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 426, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [425, 426] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 577, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 578, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 579, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 580, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 581, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 582, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 583, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 584, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 585, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 586, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 587, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 588, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 748, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 747, - "name": "default.then" - } - }, - { - "id": 566, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 567, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 737, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 736, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [187] - }, - { - "title": "Properties", - "children": [551, 554, 549, 562, 547, 565, 550, 563, 552, 553, 548, 564] - }, - { - "title": "Methods", - "children": [ - 516, 355, 347, 525, 217, 529, 455, 527, 228, 236, 284, 292, 300, 337, 324, 332, 260, - 268, 276, 501, 244, 252, 427, 544, 522, 223, 433, 342, 448, 470, 403, 589, 508, 395, - 363, 371, 379, 387, 316, 308, 574, 541, 539, 465, 570, 519, 568, 411, 577, 566 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 187, 516, 355, 347, 525, 217, 529, 455, 527, 228, 236, 284, 292, 300, 337, 324, 260, - 268, 276, 501, 244, 252, 427, 544, 522, 223, 433, 448, 470, 403, 589, 508, 395, 363, - 371, 379, 387, 541, 539, 465, 570, 519, 568, 411, 566 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [574] - }, - { - "title": "Other", - "children": [ - 551, 554, 549, 562, 547, 565, 550, 563, 552, 553, 548, 564, 332, 342, 316, 308, 577 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 95, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L95" - } - ], - "typeParameters": [ - { - "id": 597, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 598, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 599, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 600, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 601, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 602, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 603, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "default", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 81, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 82, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L65" - } - ], - "signatures": [ - { - "id": 83, - "name": "PostgrestQueryBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a query builder scoped to a Postgres table or view." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst query = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: { apikey: 'your-publishable-key' }, retry: true }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L65" - } - ], - "typeParameters": [ - { - "id": 84, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 85, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 86, - "name": "Relation", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 87, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 88, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 89, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 90, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [90] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "parameters": [ - { - "id": 91, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL for the query" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 92, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 96, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L76" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 97, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 98, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 99, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 100, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 101, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 102, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 103, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 94, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 74, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L74" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 105, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable automatic retries for transient errors (default: true)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 78, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 95, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to use" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 104, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length before warning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 77, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L77" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "8000" - } - ], - "groups": [ - { - "title": "Properties", - "children": [96, 94, 105, 95, 104] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 73, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L73" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 110, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L23" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 112, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 113, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 114, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 115, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 116, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 117, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 107, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L20" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 119, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\nWhen enabled, idempotent requests (GET/HEAD/OPTIONS) that fail with network\nerrors or HTTP 503/520 responses are automatically retried with exponential\nbackoff (1s, 2s, 4s, up to 3 attempts). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " when not specified." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 108, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 109, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L22" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 106, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L19" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 118, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 173, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1736, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1736" - } - ], - "signatures": [ - { - "id": 174, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\n- If you use " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " with filters and you have\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\n rows visible through " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": " policies are deleted. Note that by default\n no rows are visible, so you need at least one " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": "/" - }, - { - "kind": "code", - "text": "`ALL`" - }, - { - "kind": "text", - "text": " policy that\n makes the rows visible.\n- When using " - }, - { - "kind": "code", - "text": "`delete().in()`" - }, - { - "kind": "text", - "text": ", specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal." - } - ] - }, - { - "tag": "@example", - "name": "Delete a single record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete multiple records", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .in('id', [1, 2, 3])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1736, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1736" - } - ], - "parameters": [ - { - "id": 175, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 176, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 177, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count deleted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1739, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1739" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 178, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [177] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1738, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1738" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 135, - "name": "insert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1086, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1086" - } - ], - "signatures": [ - { - "id": 136, - "name": "insert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Create a record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk create\nA bulk create operation is handled in a single transaction.\nIf any of the inserts fail, none of the rows are inserted." - } - ] - }, - { - "tag": "@example", - "name": "Bulk create", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert([\n { id: 1, name: 'Mordor' },\n { id: 1, name: 'The Shire' },\n ])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (id)=(1) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"countries_pkey\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1086, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1086" - } - ], - "typeParameters": [ - { - "id": 137, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 138, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 140, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1089, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1089" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [140] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1089, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1089" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 137, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 142, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1093, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1093" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [142] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1093, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1093" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 137, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 143, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 144, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 145, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count inserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1100" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 147, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1101, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1101" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - } - ], - "groups": [ - { - "title": "Properties", - "children": [145, 147] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1099, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1099" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 125, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L905" - } - ], - "signatures": [ - { - "id": 126, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT query on the table or view." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "When using " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`.range()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`.limit()`" - }, - { - "kind": "text", - "text": ", the returned " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " is the total number of rows\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\n\n- By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use " - }, - { - "kind": "code", - "text": "`range()`" - }, - { - "kind": "text", - "text": " queries to paginate through your data.\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Filters](/docs/reference/javascript/using-filters)\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\n- " - }, - { - "kind": "code", - "text": "`apikey`" - }, - { - "kind": "text", - "text": " is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Getting your data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Harry'),\n (2, 'Frodo'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Harry\"\n },\n {\n \"id\": 2,\n \"name\": \"Frodo\"\n },\n {\n \"id\": 3,\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nThe most useful field on a Postgres error is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (" - }, - { - "kind": "code", - "text": "`code: '42501'`" - }, - { - "kind": "text", - "text": ") arrives with a " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " like " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\"`" - }, - { - "kind": "text", - "text": ". Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so the hint isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('characters').select()\nif (error) {\n // Logs the full error: message, code, details, and hint.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"42501\",\n \"details\": null,\n \"hint\": \"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\",\n \"message\": \"permission denied for table characters\"\n },\n \"status\": 401,\n \"statusText\": \"Unauthorized\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Selecting specific columns", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Frodo'),\n (2, 'Harry'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Frodo\"\n },\n {\n \"name\": \"Harry\"\n },\n {\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\nIf your database has foreign key relationships, you can query related tables too." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\nIf your table name contains spaces, you must use double quotes in the " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " statement to reference the table." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables with spaces in their names", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral sections')\n .select(`\n name,\n \"musical instruments\" (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n \"orchestral sections\" (id int8 primary key, name text);\ncreate table\n \"musical instruments\" (\n id int8 primary key,\n section_id int8 not null references \"orchestral sections\",\n name text\n );\n\ninsert into\n \"orchestral sections\" (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n \"musical instruments\" (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"musical instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"musical instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\nIf you're in a situation where your tables are **NOT** directly\nrelated, but instead are joined by a _join table_, you can still use\nthe " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " method to query the related data. The join table needs\nto have the foreign keys as part of its composite primary key." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables through a join table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n name,\n teams (\n name\n )\n `)\n \n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n -- both foreign keys must be part of a composite primary key\n primary key (user_id, team_id)\n );\n\ninsert into\n users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Kiran\",\n \"teams\": [\n {\n \"name\": \"Green\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Evan\",\n \"teams\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n \n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\nIf you need to query the same referenced table twice, use the name of the\njoined column to identify which join to use. You can also give each\ncolumn an alias." - } - ] - }, - { - "tag": "@example", - "name": "Query the same referenced table multiple times", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:sender_id(name),\n to:receiver_id(name)\n `)\n\n// To infer types, use the name of the table (in this case `users`) and\n// the name of the foreign key constraint.\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:users!messages_sender_id_fkey(name),\n to:users!messages_receiver_id_fkey(name)\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\n" - }, - { - "kind": "code", - "text": "```sql\n create table\n users (id int8 primary key, name text);\n\n create table\n messages (\n sender_id int8 not null references users,\n receiver_id int8 not null references users,\n content text\n );\n\n insert into\n users (id, name)\n values\n (1, 'Kiran'),\n (2, 'Evan');\n\n insert into\n messages (sender_id, receiver_id, content)\n values\n (1, 2, '👋');\n ```" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleResponse Query the same referenced table multiple times\n```" - }, - { - "kind": "text", - "text": "json\n{\n \"data\": [\n {\n \"content\": \"👋\",\n \"from\": {\n \"name\": \"Kiran\"\n },\n \"to\": {\n \"name\": \"Evan\"\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleDescription Query nested foreign tables through a join table\nYou can use the result of a joined table to gather data in\nanother foreign table. With multiple references to the same foreign\ntable you must specify the column on which to conduct the join.\n\n@example Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "ts\n const { data, error } = await supabase\n .from('games')\n .select(" - }, - { - "kind": "code", - "text": "`\n game_id:id,\n away_team:teams!games_away_team_fkey (\n users (\n id,\n name\n )\n )\n `" - }, - { - "kind": "text", - "text": ")\n \n" - }, - { - "kind": "code", - "text": "```\n\n@exampleSql Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "sql\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n\n primary key (user_id, team_id)\n );\ncreate table\n games (\n id int8 primary key,\n home_team int8 not null references teams,\n away_team int8 not null references teams,\n name text\n );\n\ninsert into users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\ninsert into\n games (id, home_team, away_team, name)\nvalues\n (1, 1, 2, 'Green vs Blue'),\n (2, 2, 1, 'Blue vs Green');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query nested foreign tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"game_id\": 1,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n },\n {\n \"id\": 2,\n \"name\": \"Evan\"\n }\n ]\n }\n },\n {\n \"game_id\": 2,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n }\n ]\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n \n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\nIf the filter on a referenced table's column is not satisfied, the referenced\ntable returns " - }, - { - "kind": "code", - "text": "`[]`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " but the parent table is not filtered out.\nIf you want to filter out the parent table rows, use the " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " hint" - } - ] - }, - { - "tag": "@example", - "name": "Filtering through referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections(*)')\n .eq('orchestral_sections.name', 'percussion')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": null\n },\n {\n \"name\": \"violin\",\n \"orchestral_sections\": null\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\nYou can get the number of rows in a related table by using the\n**count** property." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with count", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`*, instruments(count)`)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table characters (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('strings') returning id\n)\ninsert into instruments (name, section_id) values\n('violin', (select id from section)),\n('viola', (select id from section)),\n('cello', (select id from section)),\n('double bass', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```json\n[\n {\n \"id\": \"693694e7-d993-4360-a6d7-6294e325d9b6\",\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"count\": 4\n }\n ]\n }\n]\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying with count option\nYou can get the number of rows by using the\n[count](/docs/reference/javascript/select#parameters) option." - } - ] - }, - { - "tag": "@example", - "name": "Querying with count option", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { count, error } = await supabase\n .from('characters')\n .select('*', { count: 'exact', head: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"count\": 3,\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\nYou can select and filter data inside of\n[JSON](/docs/guides/database/json) columns. Postgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nquerying JSON data." - } - ] - }, - { - "tag": "@example", - "name": "Querying JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n id, name,\n address->city\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Frodo', '{\"city\":\"Hobbiton\"}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Frodo\",\n \"city\": \"Hobbiton\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\nIf you don't want to return the referenced table contents, you can leave the parenthesis empty.\nLike " - }, - { - "kind": "code", - "text": "`.select('name, orchestral_sections!inner()')`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with inner join", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections!inner(name)')\n .eq('orchestral_sections.name', 'woodwinds')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table instruments (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('woodwinds') returning id\n)\ninsert into instruments (name, section_id) values\n('flute', (select id from section)),\n('clarinet', (select id from section)),\n('bassoon', (select id from section)),\n('piccolo', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\nIn addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas)." - } - ] - }, - { - "tag": "@example", - "name": "Switching schemas per query", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .schema('myschema')\n .from('mytable')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```sql\ncreate schema myschema;\n\ncreate table myschema.mytable (\n id uuid primary key default gen_random_uuid(),\n data text\n);\n\ninsert into myschema.mytable (data) values ('mydata');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": \"4162e008-27b0-4c0f-82dc-ccaeee9a624d\",\n \"data\": \"mydata\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L905" - } - ], - "typeParameters": [ - { - "id": 127, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 128, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 127, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 129, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " - }, - { - "kind": "code", - "text": "`customName:columnName`" - } - ] - }, - "type": { - "type": "reference", - "target": 127, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 130, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 133, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows in the table or view.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 919, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L919" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 132, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 918, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L918" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [133, 132] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 917, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L917" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 128, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "GET" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 163, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1571" - } - ], - "signatures": [ - { - "id": 164, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update." - } - ] - }, - { - "tag": "@example", - "name": "Updating your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\nPostgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nworking with JSON data. Currently, it is only possible to update the entire JSON document." - } - ] - }, - { - "tag": "@example", - "name": "Updating JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .update({\n address: {\n street: 'Melrose Place',\n postcode: 90210\n }\n })\n .eq('address->postcode', 90210)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210 }');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Michael\",\n \"address\": {\n \"street\": \"Melrose Place\",\n \"postcode\": 90210\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1571" - } - ], - "typeParameters": [ - { - "id": 165, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 166, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to update with" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 167, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 168, - "name": "Update", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1573, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1573" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [168] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1573, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1573" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Update" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 165, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 169, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 170, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 171, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count updated rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1579, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1579" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [171] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1578, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1578" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "PATCH" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 148, - "name": "upsert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1360" - } - ], - "signatures": [ - { - "id": 149, - "name": "upsert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": " allows you to perform the equivalent of\n" - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": " if a row with the corresponding " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates`" - }, - { - "kind": "text", - "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Upsert a single row using a unique key", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting a single row, overwriting based on the 'username' unique column\nconst { data, error } = await supabase\n .from('users')\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\n\n// Example response:\n// {\n// data: [\n// { id: 4, message: 'bar', username: 'supabot' }\n// ],\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upsert with conflict resolution and exact row counting", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting and returning exact count\nconst { data, error, count } = await supabase\n .from('users')\n .upsert(\n {\n id: 3,\n message: 'foo',\n username: 'supabot'\n },\n {\n onConflict: 'username',\n count: 'exact'\n }\n )\n\n// Example response:\n// {\n// data: [\n// {\n// id: 42,\n// handle: \"saoirse\",\n// display_name: \"Saoirse\"\n// }\n// ],\n// count: 1,\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Primary keys must be included in " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " to use upsert." - } - ] - }, - { - "tag": "@example", - "name": "Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert({ id: 1, name: 'piano' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Bulk Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert([\n { id: 1, name: 'piano' },\n { id: 2, name: 'harp' },\n ])\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n },\n {\n \"id\": 2,\n \"name\": \"harp\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\nIn the following query, " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " implicitly uses the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": "\n(primary key) column to determine conflicts. If there is no existing\nrow with the same " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " inserts a new row, which\nwill fail in this case as there is already a row with " - }, - { - "kind": "code", - "text": "`handle`" - }, - { - "kind": "text", - "text": " " - }, - { - "kind": "code", - "text": "`\"saoirse\"`" - }, - { - "kind": "text", - "text": ".\nUsing the " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " option, you can instruct " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " to use\nanother column with a unique constraint to determine conflicts." - } - ] - }, - { - "tag": "@example", - "name": "Upserting into tables with constraints", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 generated by default as identity primary key,\n handle text not null unique,\n display_name text\n );\n\ninsert into\n users (id, handle, display_name)\nvalues\n (1, 'saoirse', null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (handle)=(saoirse) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"users_handle_key\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1360" - } - ], - "typeParameters": [ - { - "id": 150, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 151, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 153, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1363, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1363" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [153] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1363, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1363" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 150, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 154, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 155, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1367, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1367" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [155] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1367, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1367" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 150, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 156, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 157, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 160, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count upserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1378, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1378" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 162, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates: false`" - }, - { - "kind": "text", - "text": ". This also only applies when doing bulk upserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1379" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 159, - "name": "ignoreDuplicates", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", duplicate rows are ignored. If\n" - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", duplicate rows are merged with existing rows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1377, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1377" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 158, - "name": "onConflict", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns are equal." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1376, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1376" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [160, 162, 159, 158] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1375, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1375" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [82] - }, - { - "title": "Properties", - "children": [110, 107, 119, 108, 109, 106, 118] - }, - { - "title": "Methods", - "children": [173, 135, 125, 163, 148] - } - ], - "categories": [ - { - "title": "Database", - "children": [82, 173, 135, 125, 163, 148] - }, - { - "title": "Other", - "children": [110, 107, 119, 108, 109, 106, 118] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 12, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L12" - } - ], - "typeParameters": [ - { - "id": 179, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 180, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 181, - "name": "Relation", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 182, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 183, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 184, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 185, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ], - "type": { - "type": "inferred", - "name": "R" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [185] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - }, - { - "id": 604, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 605, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 606, - "name": "PostgrestTransformBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 607, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 608, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 609, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 610, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 611, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 612, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 613, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 614, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 620, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 623, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 624, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 625, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 626, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 627, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 628, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 629, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 630, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 618, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 631, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 616, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 634, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 619, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 632, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 621, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 622, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 617, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 633, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [620, 623, 618, 631, 616, 634, 619, 632, 621, 622, 617, 633] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 776, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 775, - "name": "default.constructor" - } - }, - { - "id": 721, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 805, - "name": "default.body" - } - }, - { - "id": 724, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 725, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 726, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 727, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 728, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 729, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 730, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 731, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 808, - "name": "default.fetch" - } - }, - { - "id": 719, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 803, - "name": "default.headers" - } - }, - { - "id": 732, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 816, - "name": "default.isMaybeSingle" - } - }, - { - "id": 717, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 801, - "name": "default.method" - } - }, - { - "id": 735, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": 819, - "name": "default.retryEnabled" - } - }, - { - "id": 720, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 804, - "name": "default.schema" - } - }, - { - "id": 733, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 817, - "name": "default.shouldStripNulls" - } - }, - { - "id": 722, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "target": 806, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 723, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 807, - "name": "default.signal" - } - }, - { - "id": 718, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 802, - "name": "default.url" - } - }, - { - "id": 734, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 818, - "name": "default.urlLengthLimit" - } - }, - { - "id": 686, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "signatures": [ - { - "id": 687, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "parameters": [ - { - "id": 688, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 695, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "signatures": [ - { - "id": 696, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 699, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "signatures": [ - { - "id": 700, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "parameters": [ - { - "id": 701, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 702, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 703, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 859, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L859" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 706, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 862, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L862" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 708, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 864, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L864" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "defaultValue": "'text'" - }, - { - "id": 705, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L861" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 704, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 860, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L860" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 707, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 863, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [703, 706, 708, 705, 704, 707] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 858, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L858" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - } - ] - }, - { - "id": 697, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "signatures": [ - { - "id": 698, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 671, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "signatures": [ - { - "id": 672, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "parameters": [ - { - "id": 673, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 674, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 675, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 676, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 677, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [676, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 714, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "signatures": [ - { - "id": 715, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "parameters": [ - { - "id": 716, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/feature-flags.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - } - } - ] - }, - { - "id": 692, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "signatures": [ - { - "id": 693, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "typeParameters": [ - { - "id": 694, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 524, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 640, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order the query result by " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": ".\n\nYou 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 " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " in the query." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to order by" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.ascending", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the result will be in ascending order" - } - ] - }, - { - "tag": "@param", - "name": "options.nullsFirst", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear first. If " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear last." - } - ] - }, - { - "tag": "@param", - "name": "options.referencedTable", - "content": [ - { - "kind": "text", - "text": "Set this to order a referenced table by\nits columns" - } - ] - }, - { - "tag": "@param", - "name": "options.foreignTable", - "content": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('id, name')\n .order('id', { ascending: false })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " doesn't affect the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .order('name', { referencedTable: 'instruments', ascending: false })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n },\n {\n \"name\": \"harp\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": []\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referenced_table(col)`" - }, - { - "kind": "text", - "text": " affects the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "Order parent table by a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('instruments')\n .select(`\n name,\n section:orchestral_sections (\n name\n )\n `)\n .order('section(name)', { ascending: true })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"violin\",\n \"orchestral_sections\": {\"name\": \"strings\"}\n },\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L322" - } - ], - "signatures": [ - { - "id": 641, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - } - ], - "typeParameters": [ - { - "id": 642, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 643, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 472, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 644, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 645, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 646, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 647, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 648, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [646, 647, 648] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 649, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - } - ], - "parameters": [ - { - "id": 650, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 651, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 652, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 653, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 654, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 655, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [653, 654, 655] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 656, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - } - ], - "typeParameters": [ - { - "id": 657, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 658, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 487, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 659, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 660, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 661, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 663, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 662, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [661, 663, 662] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 664, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - } - ], - "parameters": [ - { - "id": 665, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 666, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 667, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 668, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 670, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [668, 670, 669] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 759, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 760, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 761, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 762, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 763, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 764, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [764] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 765, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 766, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [766] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 857, - "name": "default.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 856, - "name": "default.overrideTypes" - } - }, - { - "id": 678, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "signatures": [ - { - "id": 679, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "parameters": [ - { - "id": 680, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 681, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 682, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 684, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 685, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [684, 685] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 744, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 745, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 746, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 829, - "name": "default.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 828, - "name": "default.retry" - } - }, - { - "id": 711, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "signatures": [ - { - "id": 712, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "typeParameters": [ - { - "id": 713, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 543, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": 854, - "name": "default.returns" - } - } - ], - "overwrites": { - "type": "reference", - "target": 853, - "name": "default.returns" - } - }, - { - "id": 709, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "signatures": [ - { - "id": 710, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 635, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "signatures": [ - { - "id": 636, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "typeParameters": [ - { - "id": 637, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 638, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 639, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 740, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 741, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 742, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 743, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 825, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 824, - "name": "default.setHeader" - } - }, - { - "id": 689, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "signatures": [ - { - "id": 690, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "typeParameters": [ - { - "id": 691, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 521, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 738, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 739, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 823, - "name": "default.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 822, - "name": "default.stripNulls" - } - }, - { - "id": 747, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 748, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 749, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 750, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 751, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 753, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 754, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 755, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 756, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 757, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 758, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 832, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 831, - "name": "default.then" - } - }, - { - "id": 736, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 737, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 821, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 820, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [605] - }, - { - "title": "Properties", - "children": [721, 724, 719, 732, 717, 735, 720, 733, 722, 723, 718, 734] - }, - { - "title": "Methods", - "children": [ - 686, 695, 699, 697, 671, 714, 692, 640, 759, 678, 744, 711, 709, 635, 740, 689, 738, - 747, 736 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 605, 686, 695, 699, 697, 671, 714, 692, 640, 759, 678, 711, 709, 635, 740, 689, 738, 736 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [744] - }, - { - "title": "Other", - "children": [721, 724, 719, 732, 717, 735, 720, 733, 722, 723, 718, 734, 747] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 8, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L8" - } - ], - "typeParameters": [ - { - "id": 767, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 768, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 769, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 770, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 771, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 772, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 773, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "default", - "package": "@supabase/postgrest-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 186, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 889, - "name": "PostgrestResponseFailure", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 893, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L25" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 892, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L24" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 891, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L23" - } - ], - "type": { - "type": "reference", - "target": 867, - "name": "PostgrestError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - }, - { - "id": 894, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 895, - "name": "statusText", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.statusText" - } - }, - { - "id": 890, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L22" - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [893, 892, 891, 894, 895, 890] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 21, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L21" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase" - }, - "name": "PostgrestResponseBase", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 896, - "name": "PostgrestResponseSuccess", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 900, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L19" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 899, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L18" - } - ], - "type": { - "type": "reference", - "target": 903, - "name": "T", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestResponseSuccess.T", - "refersToTypeParameter": true - } - }, - { - "id": 898, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L17" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 901, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 902, - "name": "statusText", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.statusText" - } - }, - { - "id": 897, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 16, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L16" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [900, 899, 898, 901, 902, 897] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 15, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L15" - } - ], - "typeParameters": [ - { - "id": 903, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase" - }, - "name": "PostgrestResponseBase", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 908, - "name": "PostgrestClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L81" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 910, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L82" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [910] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 81, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L81" - } - ] - } - } - }, - { - "id": 906, - "name": "PostgrestMaybeSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 32, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L32" - } - ], - "typeParameters": [ - { - "id": 907, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 907, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 887, - "name": "PostgrestResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 33, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L33" - } - ], - "typeParameters": [ - { - "id": 888, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 888, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 904, - "name": "PostgrestSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 31, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L31" - } - ], - "typeParameters": [ - { - "id": 905, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 905, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 889, - "name": "PostgrestResponseFailure", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 911, - "name": "UnstableGetResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Main entry point for constructing the result type of a PostgREST query." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/select-query-parser/result.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/select-query-parser/result.ts#L38" - } - ], - "typeParameters": [ - { - "id": 912, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Database schema." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 913, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of a row in the current table." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 914, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the current table or view." - } - ] - } - }, - { - "id": 915, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Relationships of the current table." - } - ] - } - }, - { - "id": 916, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The select query string literal to parse." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 917, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "IsAny" - }, - "typeArguments": [ - { - "type": "reference", - "target": 912, - "name": "Schema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "IsAny", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ProcessNodesWithoutSchema" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ProcessNodesWithoutSchema", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": null - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "RPCCallNodes" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "literal", - "value": "rpc_call" - } - }, - { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RPCCallNodes", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericRelationship" - }, - "name": "GenericRelationship", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ProcessNodes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 917, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 912, - "name": "Schema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ProcessNodes", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "SelectQueryError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "Invalid Relationships cannot infer result type" - } - ], - "name": "SelectQueryError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "SelectQueryError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "Invalid RelationName cannot infer result type" - } - ], - "name": "SelectQueryError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - }, - { - "id": 1, - "name": "default", - "variant": "declaration", - "kind": 32, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 16, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L16" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 7, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L21" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 774, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 3, - "name": "PostgrestClient", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L17" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 9, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 8, - "name": "PostgrestError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L22" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 867, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 5, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L19" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 186, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 4, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L18" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 81, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 6, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L20" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 604, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [7, 3, 8, 5, 4, 6] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 16, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L16" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Classes", - "children": [774, 9, 867, 186, 81, 604] - }, - { - "title": "Interfaces", - "children": [889, 896] - }, - { - "title": "Type Aliases", - "children": [908, 906, 887, 904, 911] - }, - { - "title": "Variables", - "children": [1] - } - ], - "packageName": "@supabase/postgrest-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase PostgREST JS SDK

    \n\n

    Isomorphic JavaScript SDK for PostgREST with an ORM-like interface.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/postgrest-js)](https://www.npmjs.com/package/@supabase/postgrest-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js)\n\n
    \n\n### Quick start\n\nInstall\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nUsage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst REST_URL = 'http://localhost:3000'\nconst postgrest = new PostgrestClient(REST_URL)\n```" - }, - { - "kind": "text", - "text": "\n\n- [select()](https://supabase.com/docs/reference/javascript/select)\n- [insert()](https://supabase.com/docs/reference/javascript/insert)\n- [update()](https://supabase.com/docs/reference/javascript/update)\n- [delete()](https://supabase.com/docs/reference/javascript/delete)\n\n#### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`postgrest-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst REST_URL = 'http://localhost:3000'\nconst postgrest = new PostgrestClient(REST_URL, {\n fetch: (...args) => fetch(...args),\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Build (from monorepo root)\npnpm nx build postgrest-js\n\n# Build with watch mode for development\npnpm nx build:watch postgrest-js\n\n# TypeScript type checking\npnpm nx type-check postgrest-js\n\n# Generate documentation\npnpm nx docs postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\n**Supabase CLI Required!** The " - }, - { - "kind": "code", - "text": "`postgrest-js`" - }, - { - "kind": "text", - "text": " tests use the [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started) to run a local PostgreSQL database and PostgREST server.\n\n#### Quick Start\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run all tests (from monorepo root)\npnpm nx test:ci:postgrest postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis single command automatically:\n\n1. Stops any existing Supabase CLI containers\n2. Starts PostgreSQL database and PostgREST server via Supabase CLI\n3. Resets and seeds the database\n4. Runs all Jest unit tests with coverage\n5. Cleans up containers\n\n#### Individual Test Commands\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run Jest tests with coverage (requires infrastructure running)\npnpm nx test:run postgrest-js\n\n# Run type tests with tstyche\npnpm nx test:types postgrest-js\n\n# Run smoke tests (CommonJS and ESM imports)\npnpm nx test:smoke postgrest-js\n\n# Format code\npnpm nx format postgrest-js\n\n# Check formatting\npnpm nx format:check postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure\n\nThe tests use Supabase CLI to spin up:\n\n- **PostgreSQL** - Database with test schema and seed data (port 54322)\n- **PostgREST** - REST API server that the client connects to (port 54321)\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Manually manage test infrastructure (from monorepo root)\npnpm nx test:infra postgrest-js # Start containers\npnpm nx test:clean-pre postgrest-js # Stop and remove containers\n```" - }, - { - "kind": "text", - "text": "\n\nOr directly via Supabase CLI:\n\n" - }, - { - "kind": "code", - "text": "```bash\ncd packages/core/postgrest-js\nnpx supabase --workdir ./test start # Start all services\nnpx supabase --workdir ./test db reset # Reset and seed database\nnpx supabase --workdir ./test stop # Stop all services\n```" - }, - { - "kind": "text", - "text": "\n\n#### Regenerating TypeScript Types\n\nWhen the database schema changes, regenerate TypeScript types from the actual database:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From the monorepo root\npnpm run codegen:postgrest\n```" - }, - { - "kind": "text", - "text": "\n\nThis command automatically:\n\n1. Cleans up any existing Supabase containers\n2. Starts Supabase (PostgreSQL, PostgREST, and all services)\n3. Generates TypeScript types from the database schema\n4. Post-processes the generated types (updates JSON type definitions)\n5. Formats the generated file with Prettier\n6. Cleans up Supabase containers\n\nThe generated types are written to " - }, - { - "kind": "code", - "text": "`test/types.generated.ts`" - }, - { - "kind": "text", - "text": ".\n\n#### Test Types Explained\n\n- **Unit Tests** - Jest tests covering all client functionality (" - }, - { - "kind": "code", - "text": "`pnpm nx test:run postgrest-js`" - }, - { - "kind": "text", - "text": ")\n- **Type Tests** - Validates TypeScript types using tstyche (" - }, - { - "kind": "code", - "text": "`pnpm nx test:types postgrest-js`" - }, - { - "kind": "text", - "text": ")\n- **Smoke Tests** - Basic import/require tests for CommonJS and ESM (" - }, - { - "kind": "code", - "text": "`pnpm nx test:smoke postgrest-js`" - }, - { - "kind": "text", - "text": ")\n\n#### Prerequisites\n\n- **Supabase CLI** must be installed ([instructions](https://supabase.com/docs/guides/local-development/cli/getting-started)) or can be used through " - }, - { - "kind": "code", - "text": "`npx`" - }, - { - "kind": "text", - "text": " (" - }, - { - "kind": "code", - "text": "`npx supabase`" - }, - { - "kind": "text", - "text": ")\n- **Docker** must be installed and running (Supabase CLI uses Docker under the hood)\n- **Port 54321** - PostgREST API\n- **Port 54322** - PostgreSQL database\n- **Port 54323** - Supabase Studio (used for type generation)\n\n#### PostgREST v12 Backward Compatibility Tests\n\nWe maintain backward compatibility tests for PostgREST v12 (the current Supabase CLI uses v14+). These tests ensure the SDK works correctly for users still running older PostgREST versions.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run v12 compatibility tests (requires Docker)\npnpm nx test:ci:v12 postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command:\n\n1. Starts PostgREST v12 + PostgreSQL in Docker (ports 3012/5433)\n2. Runs runtime tests that verify v12-specific behavior\n3. Cleans up containers\n\n**Type-only tests** for v12 compatibility also run as part of the regular type tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\npnpm nx test:types postgrest-js # Includes v12-compat.test-d.ts\n```" - }, - { - "kind": "text", - "text": "\n\n**Note:** These v12 tests will be removed when v3 ships (sometime in 2026).\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n## License\n\nThis repo is licensed under MIT License." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "default" - }, - "2": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object" - }, - "3": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestClient" - }, - "4": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestQueryBuilder" - }, - "5": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestFilterBuilder" - }, - "6": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestTransformBuilder" - }, - "7": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestBuilder" - }, - "8": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestError" - }, - "9": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default" - }, - "10": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.__constructor" - }, - "11": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default" - }, - "12": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Database" - }, - "13": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "14": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "15": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "16": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "17": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.SchemaName" - }, - "18": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Schema" - }, - "19": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "url" - }, - "20": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__1" - }, - "21": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "22": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.headers" - }, - "23": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.schema" - }, - "24": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.fetch" - }, - "25": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "26": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "27": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "28": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "29": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "30": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "31": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "32": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.timeout" - }, - "33": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "34": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.retry" - }, - "35": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.url" - }, - "36": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.headers" - }, - "37": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schemaName" - }, - "38": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.fetch" - }, - "39": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "40": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "41": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "42": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "43": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "44": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "45": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "46": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "47": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.retry" - }, - "48": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "49": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "50": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "TableName" - }, - "51": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "Table" - }, - "52": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "relation" - }, - "53": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "54": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "ViewName" - }, - "55": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "View" - }, - "56": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "relation" - }, - "57": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schema" - }, - "58": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schema" - }, - "59": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "DynamicSchema" - }, - "60": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "schema" - }, - "61": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.rpc" - }, - "62": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.rpc" - }, - "63": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "FnName" - }, - "64": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "Args" - }, - "65": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "FilterBuilder" - }, - "66": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "fn" - }, - "67": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "args" - }, - "68": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__2" - }, - "69": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.head" - }, - "71": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.get" - }, - "72": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.count" - }, - "73": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "74": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Database" - }, - "75": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "76": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "77": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "78": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "79": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.SchemaName" - }, - "80": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Schema" - }, - "81": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default" - }, - "82": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "83": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default" - }, - "84": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "85": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Schema" - }, - "86": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relation" - }, - "87": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "88": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "89": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "90": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Relationships" - }, - "91": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "url" - }, - "92": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "93": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.headers" - }, - "95": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.schema" - }, - "96": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "97": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "98": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "99": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "100": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "101": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "102": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "103": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "104": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "105": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.retry" - }, - "106": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.url" - }, - "107": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.headers" - }, - "108": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.schema" - }, - "109": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.signal" - }, - "110": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.fetch" - }, - "111": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "112": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "113": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "114": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "115": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "116": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "117": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "118": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "119": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.retry" - }, - "125": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.select" - }, - "126": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.select" - }, - "127": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Query" - }, - "128": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "ResultOne" - }, - "129": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "columns" - }, - "130": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "options" - }, - "131": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "132": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.head" - }, - "133": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "134": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "135": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.insert" - }, - "136": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.insert" - }, - "137": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "138": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "139": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "140": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "141": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "142": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "143": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "144": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "145": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "146": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "147": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.defaultToNull" - }, - "148": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.upsert" - }, - "149": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.upsert" - }, - "150": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "151": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "152": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "153": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "154": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "155": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "156": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "157": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "158": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.onConflict" - }, - "159": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.ignoreDuplicates" - }, - "160": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "161": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "162": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.defaultToNull" - }, - "163": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.update" - }, - "164": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.update" - }, - "165": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "166": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "167": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "168": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Update" - }, - "169": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "170": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "171": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "172": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "173": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.delete" - }, - "174": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.delete" - }, - "175": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__0" - }, - "176": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "177": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "178": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "179": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "180": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Schema" - }, - "181": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relation" - }, - "182": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "183": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "184": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "185": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Relationships" - }, - "186": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default" - }, - "187": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "188": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "189": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "190": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Schema" - }, - "191": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Row" - }, - "192": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Result" - }, - "193": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "194": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "195": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Method" - }, - "196": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "197": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "198": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "199": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "200": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "201": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "202": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "203": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "204": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "205": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "206": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "207": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "208": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "209": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "210": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "211": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "212": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "213": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "214": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "215": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "216": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "217": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.eq" - }, - "218": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.eq" - }, - "219": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "220": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "221": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "222": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "223": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.neq" - }, - "224": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.neq" - }, - "225": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "226": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "227": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "228": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "229": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "230": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "231": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "232": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "233": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "234": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "235": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "236": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "237": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "238": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "239": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "240": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "241": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "242": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "243": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "244": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "245": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "246": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "247": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "248": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "249": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "250": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "251": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "252": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "253": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "254": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "255": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "256": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "257": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "258": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "259": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "260": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "261": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "262": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "263": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "264": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "265": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "266": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "267": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "268": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "269": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "270": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "271": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "272": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "273": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "274": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "275": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "276": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "277": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "278": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "279": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "280": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "281": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "282": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "283": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "284": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "285": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "286": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "287": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "288": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "289": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "290": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "291": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "292": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "293": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "294": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "295": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "296": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "297": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "298": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "299": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "300": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "301": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "302": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "303": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "304": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "305": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "306": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "307": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "308": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "309": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "310": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "311": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "312": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "313": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "314": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "315": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "316": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "317": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "318": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "319": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "320": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "321": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "322": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "323": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "324": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "325": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "326": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "327": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "328": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "329": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "330": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "331": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "332": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.isDistinct" - }, - "333": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.isDistinct" - }, - "334": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "335": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "336": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "337": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.in" - }, - "338": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.in" - }, - "339": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "340": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "341": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "values" - }, - "342": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.notIn" - }, - "343": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.notIn" - }, - "344": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "345": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "346": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "values" - }, - "347": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "348": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "349": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "350": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "351": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "352": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "353": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "354": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "355": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "356": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "357": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "358": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "359": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "360": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "361": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "362": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "363": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "364": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "365": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "366": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "367": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "368": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "369": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "370": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "371": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "372": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "373": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "374": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "375": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "376": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "377": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "378": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "379": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "380": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "381": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "382": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "383": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "384": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "385": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "386": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "387": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "388": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "389": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "390": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "391": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "392": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "393": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "394": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "395": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "396": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "397": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "398": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "399": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "400": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "401": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "402": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "403": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "404": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "405": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "406": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "407": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "408": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "409": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "410": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "411": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "412": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "413": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "414": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "415": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "416": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "options" - }, - "417": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "418": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.config" - }, - "419": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.type" - }, - "420": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "421": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "422": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "423": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "options" - }, - "424": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "425": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.config" - }, - "426": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.type" - }, - "427": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "428": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "429": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "430": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "431": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "432": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "433": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "434": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "435": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "436": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "437": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "438": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "439": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "440": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "441": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "442": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "443": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "444": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "445": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "446": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "447": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "448": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.or" - }, - "449": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.or" - }, - "450": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "filters" - }, - "451": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__1" - }, - "452": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "454": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "455": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "456": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "457": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "458": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "459": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "460": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "461": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "462": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "463": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "464": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "465": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "466": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "467": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "Query" - }, - "468": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResultOne" - }, - "469": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "columns" - }, - "470": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "471": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "472": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "473": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "474": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "475": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "476": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "477": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "478": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "479": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "480": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "481": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "482": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "483": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "484": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "485": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "486": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "487": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "488": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "489": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "490": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "491": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "492": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "493": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "494": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "495": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "496": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "497": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "498": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "499": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "500": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "501": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "502": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "503": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "count" - }, - "504": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__1" - }, - "505": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "506": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "507": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "508": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "509": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "510": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "from" - }, - "511": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "to" - }, - "512": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__2" - }, - "513": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "514": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "515": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "516": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "517": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "518": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "signal" - }, - "519": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "520": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "521": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "522": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "523": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "524": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "525": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "526": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "527": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "528": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "529": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "530": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "531": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__0" - }, - "532": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "533": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.analyze" - }, - "534": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.verbose" - }, - "535": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.settings" - }, - "536": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.buffers" - }, - "537": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.wal" - }, - "538": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.format" - }, - "539": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "540": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "541": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "542": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "543": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResult" - }, - "544": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "545": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "546": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "value" - }, - "547": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "548": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "549": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "550": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "551": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "552": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "553": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "554": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "555": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "556": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "557": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "558": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "559": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "560": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "561": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "562": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "563": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "564": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "565": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "566": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "567": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "568": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "569": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "570": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "571": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "572": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "573": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "574": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "575": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "576": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "577": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "578": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "579": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "580": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "581": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "582": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "583": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "584": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "585": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "586": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "587": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "588": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "589": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "590": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "591": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "592": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "593": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "594": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "595": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "596": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "597": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "598": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Schema" - }, - "599": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Row" - }, - "600": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Result" - }, - "601": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "602": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "603": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Method" - }, - "604": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default" - }, - "605": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "606": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "607": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "608": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Schema" - }, - "609": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Row" - }, - "610": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Result" - }, - "611": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "612": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "613": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Method" - }, - "614": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "615": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "617": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "618": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "619": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "620": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "621": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "622": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "623": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "624": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "625": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "626": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "627": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "628": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "629": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "630": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "631": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "632": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "633": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "634": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "635": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "636": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "637": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "Query" - }, - "638": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResultOne" - }, - "639": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "columns" - }, - "640": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "641": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "642": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "643": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "644": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "645": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "646": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "647": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "648": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "649": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "650": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "651": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "652": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "653": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "654": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "655": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "656": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "657": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "658": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "659": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "660": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "661": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "662": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "663": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "664": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "665": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "666": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "667": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "668": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "669": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "670": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "671": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "672": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "673": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "count" - }, - "674": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__1" - }, - "675": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "676": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "677": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "678": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "679": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "680": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "from" - }, - "681": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "to" - }, - "682": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__2" - }, - "683": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "684": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "685": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "686": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "687": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "688": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "signal" - }, - "689": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "690": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "691": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "692": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "693": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "694": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "695": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "696": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "697": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "698": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "699": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "700": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "701": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__0" - }, - "702": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "703": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.analyze" - }, - "704": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.verbose" - }, - "705": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.settings" - }, - "706": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.buffers" - }, - "707": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.wal" - }, - "708": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.format" - }, - "709": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "710": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "711": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "712": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "713": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResult" - }, - "714": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "715": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "716": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "value" - }, - "717": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "718": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "719": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "720": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "721": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "722": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "723": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "724": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "725": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "726": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "727": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "728": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "729": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "730": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "731": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "732": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "733": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "734": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "735": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "736": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "737": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "738": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "739": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "740": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "741": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "742": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "743": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "744": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "745": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "746": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "747": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "748": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "749": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "750": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "751": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "752": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "753": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "754": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "755": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "756": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "757": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "758": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "759": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "760": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "761": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "762": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "763": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "765": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "766": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "767": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "768": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Schema" - }, - "769": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Row" - }, - "770": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Result" - }, - "771": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "772": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "773": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Method" - }, - "774": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "775": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "776": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "777": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "778": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.Result" - }, - "779": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ThrowOnError" - }, - "780": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "781": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "782": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "783": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "784": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "785": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "786": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "787": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "788": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "789": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "790": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "791": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "792": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "793": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "794": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "795": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "796": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "797": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "798": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "799": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "800": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "801": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "802": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "803": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "804": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "805": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "806": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "807": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "808": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "809": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "810": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "811": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "812": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "813": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "814": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "815": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "816": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "817": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "818": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "819": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "820": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "821": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "822": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "823": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "824": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "825": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "826": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "827": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "828": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "829": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "830": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "831": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "832": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "833": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "834": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "835": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "836": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "837": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "838": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "839": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "840": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "841": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "842": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "853": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.returns" - }, - "854": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.returns" - }, - "855": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "856": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "857": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "858": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "859": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "860": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "861": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "862": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "863": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "864": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "865": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.Result" - }, - "866": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ThrowOnError" - }, - "867": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default" - }, - "868": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.__constructor" - }, - "869": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default" - }, - "870": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "context" - }, - "871": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "873": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "874": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "875": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "876": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.details" - }, - "877": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.hint" - }, - "878": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.code" - }, - "879": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.toJSON" - }, - "880": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.toJSON" - }, - "881": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "882": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.name" - }, - "883": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "884": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "885": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "886": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "887": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponse" - }, - "888": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "889": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure" - }, - "890": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.success" - }, - "891": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.error" - }, - "892": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.data" - }, - "893": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.count" - }, - "894": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.status" - }, - "895": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.statusText" - }, - "896": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "897": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.success" - }, - "898": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.error" - }, - "899": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.data" - }, - "900": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.count" - }, - "901": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.status" - }, - "902": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.statusText" - }, - "903": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.T" - }, - "904": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestSingleResponse" - }, - "905": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "906": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestMaybeSingleResponse" - }, - "907": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "908": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "ClientServerOptions" - }, - "909": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "__type" - }, - "910": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "911": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "GetResult" - }, - "912": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Schema" - }, - "913": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Row" - }, - "914": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "RelationName" - }, - "915": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Relationships" - }, - "916": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Query" - }, - "917": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ClientOptions" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json deleted file mode 100644 index 593622de84e..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json +++ /dev/null @@ -1,39675 +0,0 @@ -{ - "id": 0, - "name": "@supabase/postgrest-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 774, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 775, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 776, - "name": "PostgrestBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 777, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 778, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 779, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "parameters": [ - { - "id": 780, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 781, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 786, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 789, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 791, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 792, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 793, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 794, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 795, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 796, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 784, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 797, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 782, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 800, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 785, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 798, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 787, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 788, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 783, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 799, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [786, 789, 784, 797, 782, 800, 785, 798, 787, 788, 783, 799] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 805, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 808, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 809, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 810, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 811, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 812, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 813, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 814, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 815, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 803, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 816, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 801, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 819, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 804, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 817, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 806, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 807, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 802, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 818, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 856, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 857, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 858, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 859, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 861, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [861] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 862, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 863, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [863] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 828, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 829, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 830, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 853, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L565" - } - ], - "signatures": [ - { - "id": 854, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L565" - } - ], - "typeParameters": [ - { - "id": 855, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 855, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 824, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 825, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 826, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 827, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 822, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 823, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 831, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 832, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 833, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 834, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 835, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 836, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 837, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 838, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 839, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 840, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 841, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 842, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - }, - { - "id": 820, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 821, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 777, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [775] - }, - { - "title": "Properties", - "children": [805, 808, 803, 816, 801, 819, 804, 817, 806, 807, 802, 818] - }, - { - "title": "Methods", - "children": [856, 828, 853, 824, 822, 831, 820] - } - ], - "categories": [ - { - "title": "Database", - "children": [775, 856, 853, 824, 822, 820] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [828] - }, - { - "title": "Other", - "children": [805, 808, 803, 816, 801, 819, 804, 817, 806, 807, 802, 818, 831] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 68, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L68" - } - ], - "typeParameters": [ - { - "id": 864, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 865, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 866, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 604, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 779, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 778, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - }, - { - "id": 9, - "name": "PostgrestClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "PostgREST client." - } - ] - }, - "children": [ - { - "id": 10, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L86" - } - ], - "signatures": [ - { - "id": 11, - "name": "PostgrestClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a PostgREST client." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('profiles').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- A " - }, - { - "kind": "code", - "text": "`timeout`" - }, - { - "kind": "text", - "text": " option (in milliseconds) can be set to automatically abort requests that take too long.\n- A " - }, - { - "kind": "code", - "text": "`urlLengthLimit`" - }, - { - "kind": "text", - "text": " option (default: 8000) can be set to control when URL length warnings are included in error messages for aborted requests." - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {\n headers: { apikey: 'your-publishable-key' },\n schema: 'public',\n timeout: 30000, // 30 second timeout\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 86, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L86" - } - ], - "typeParameters": [ - { - "id": 12, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 13, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 14, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 15, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 19, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L19" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [15] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 18, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L18" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - }, - { - "id": 17, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 18, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "parameters": [ - { - "id": 19, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the PostgREST endpoint" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 20, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 24, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 98, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L98" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 25, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 26, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 27, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 28, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 29, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 30, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 31, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 22, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 96, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L96" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 34, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\n When enabled, idempotent requests (GET, HEAD, OPTIONS) that fail with network\n errors or HTTP 503/520 responses will be automatically retried up to 3 times\n with exponential backoff (1s, 2s, 4s). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 101, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L101" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 23, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to switch to" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 97, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L97" - } - ], - "type": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - }, - { - "id": 32, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout in milliseconds for all requests. When set, requests will automatically abort after this duration to prevent indefinite hangs." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 99, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L99" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 33, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length in characters before warnings/errors are triggered. Defaults to 8000." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L100" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "8000" - } - ], - "groups": [ - { - "title": "Properties", - "children": [24, 22, 34, 23, 32, 33] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 95, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L95" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 9, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 38, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 40, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L40" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 40, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 41, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 42, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 43, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 44, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 45, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 36, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L38" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 47, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 37, - "name": "schemaName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 39, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L39" - } - ], - "type": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - }, - { - "id": 35, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 41, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L41" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 48, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a query on a table or a view." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "relation", - "content": [ - { - "kind": "text", - "text": "The table or view name to query" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L152" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L156" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 166, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L166" - } - ], - "signatures": [ - { - "id": 49, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L152" - } - ], - "typeParameters": [ - { - "id": 50, - "name": "TableName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 51, - "name": "Table", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 52, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 50, - "name": "TableName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 51, - "name": "Table", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 50, - "name": "TableName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - }, - { - "id": 53, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L156" - } - ], - "typeParameters": [ - { - "id": 54, - "name": "ViewName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 55, - "name": "View", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 56, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 54, - "name": "ViewName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 55, - "name": "View", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 54, - "name": "ViewName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 61, - "name": "rpc", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L374" - } - ], - "signatures": [ - { - "id": 62, - "name": "rpc", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a function call." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// For cross-schema functions where type inference fails, use overrideTypes:\nconst { data } = await supabase\n .schema('schema_b')\n .rpc('function_a', {})\n .overrideTypes<{ id: string; user_id: string }[]>()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function without arguments", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('hello_world')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function without arguments\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function hello_world() returns text as $$\n select 'Hello world';\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function without arguments\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"Hello world\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function with arguments", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('echo', { say: '👋' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with arguments\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function echo(say text) returns text as $$\n select say;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with arguments\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": \"👋\",\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk processing\nYou can process large payloads by passing in an array as an argument." - } - ] - }, - { - "tag": "@example", - "name": "Bulk processing", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('add_one_each', { arr: [1, 2, 3] })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk processing\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function add_one_each(arr int[]) returns int[] as $$\n select array_agg(n + 1) from unnest(arr) as n;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk processing\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n 2,\n 3,\n 4\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\nPostgres functions that return tables can also be combined with [Filters](/docs/reference/javascript/using-filters) and [Modifiers](/docs/reference/javascript/using-modifiers)." - } - ] - }, - { - "tag": "@example", - "name": "Call a Postgres function with filters", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .rpc('list_stored_countries')\n .eq('id', 1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'),\n (2, 'The Shire');\n\ncreate function list_stored_countries() returns setof countries as $$\n select * from countries;\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a Postgres function with filters\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": 1,\n \"name\": \"Rohan\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Call a read-only Postgres function", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase.rpc('hello_world', undefined, { get: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Call a read-only Postgres function\n" - }, - { - "kind": "code", - "text": "```sql\ncreate function hello_world() returns text as $$\n select 'Hello world';\n$$ language sql;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Call a read-only Postgres function\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"Hello world\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L374" - } - ], - "typeParameters": [ - { - "id": 63, - "name": "FnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 64, - "name": "Args", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "default": { - "type": "intrinsic", - "name": "never" - } - }, - { - "id": 65, - "name": "FilterBuilder", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/rpc.ts", - "qualifiedName": "RpcFunctionNotFound" - }, - "typeArguments": [ - { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RpcFunctionNotFound", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/rpc.ts", - "qualifiedName": "GetRpcFunctionFilterBuilderByArgs" - }, - "typeArguments": [ - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 64, - "name": "Args", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "GetRpcFunctionFilterBuilderByArgs", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 66, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function name to call" - } - ] - }, - "type": { - "type": "reference", - "target": 63, - "name": "FnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 67, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The arguments to pass to the function call" - } - ] - }, - "type": { - "type": "reference", - "target": 64, - "name": "Args", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "defaultValue": "..." - }, - { - "id": 68, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 72, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 392, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L392" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 71, - "name": "get", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the function will be called with\nread-only access mode." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 391, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L391" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 70, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 390, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L390" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [72, 71, 70] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 389, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L389" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 18, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Result" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "RelationName" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Relationships" - }, - "objectType": { - "type": "reference", - "target": 65, - "name": "FilterBuilder", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "RPC" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 57, - "name": "schema", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L192" - } - ], - "signatures": [ - { - "id": 58, - "name": "schema", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 192, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L192" - } - ], - "typeParameters": [ - { - "id": 59, - "name": "DynamicSchema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 60, - "name": "schema", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema to query" - } - ] - }, - "type": { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 9, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 13, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 59, - "name": "DynamicSchema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [10] - }, - { - "title": "Properties", - "children": [38, 36, 47, 37, 35, 46] - }, - { - "title": "Methods", - "children": [48, 61, 57] - } - ], - "categories": [ - { - "title": "Database", - "children": [10, 48, 61, 57] - }, - { - "title": "Other", - "children": [38, 36, 47, 37, 35, 46] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 16, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L16" - } - ], - "typeParameters": [ - { - "id": 74, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)" - } - ] - }, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 75, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 77, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 19, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L19" - } - ], - "type": { - "type": "inferred", - "name": "I", - "constraint": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [77] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 18, - "character": 63, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L18" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "I" - }, - "name": "I", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 78, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", - "line": 22, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestClient.ts#L22" - } - ] - } - } - } - }, - { - "id": 79, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n" - }, - { - "kind": "code", - "text": "`\"public\"`" - }, - { - "kind": "text", - "text": ", this must be supplied manually." - } - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 80, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 17, - "name": "SchemaName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 12, - "name": "Database", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - } - ] - }, - { - "id": 867, - "name": "PostgrestError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error format\n\nReturned by every PostgREST request that fails. When something fails, the\nsingle most useful field is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — Postgres often returns the\nactionable fix there, not in " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": ". Always log the full object (e.g.\n" - }, - { - "kind": "code", - "text": "`console.error(error)`" - }, - { - "kind": "text", - "text": "); logging only " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": " hides the hint.\n\nRead the fields in roughly this order of usefulness:\n\n- " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — actionable guidance from the database when available. For\n permission-denied errors (" - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "), this is the literal SQL to fix the\n problem, e.g.\n " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.users TO anon;\"`" - }, - { - "kind": "text", - "text": ".\n Missing column? " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " suggests the column you probably meant. Whenever\n Postgres knows the fix, it puts it in " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": " — stable error code from PostgREST (e.g. " - }, - { - "kind": "code", - "text": "`PGRST301`" - }, - { - "kind": "text", - "text": ") or Postgres\n (e.g. " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "). Branch on this rather than on " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " text.\n- " - }, - { - "kind": "code", - "text": "`details`" - }, - { - "kind": "text", - "text": " — extra context, often the offending value, key, or row.\n- " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " — human-readable summary. Useful in UI strings; less useful\n for debugging.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", - "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" - } - ] - }, - "children": [ - { - "id": 868, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "signatures": [ - { - "id": 869, - "name": "PostgrestError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport PostgrestError from '@supabase/postgrest-js'\n\nthrow new PostgrestError({\n message: 'Row level security prevented the request',\n details: 'RLS denied the insert',\n hint: 'Check your policies',\n code: 'PGRST301',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "parameters": [ - { - "id": 870, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 875, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 73, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 873, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 874, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 872, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [875, 873, 874, 872] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 43, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L43" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 867, - "name": "PostgrestError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 878, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L28" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 876, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 877, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L27" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 879, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "signatures": [ - { - "id": 880, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 881, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 886, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 76, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 884, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 885, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 62, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 883, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 882, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [886, 884, 885, 883, 882] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 51, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L51" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [868] - }, - { - "title": "Properties", - "children": [878, 876, 877] - }, - { - "title": "Methods", - "children": [879] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", - "line": 25, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestError.ts#L25" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 186, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 187, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 188, - "name": "PostgrestFilterBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 189, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 190, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 191, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 192, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 193, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 194, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 195, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 196, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 197, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 202, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 205, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 206, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 207, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 208, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 209, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 210, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 211, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 212, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 200, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 213, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 198, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 216, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 201, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 203, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 204, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 199, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 215, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [202, 205, 200, 213, 198, 216, 201, 214, 203, 204, 199, 215] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 606, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 605, - "name": "default.constructor" - } - }, - { - "id": 551, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 721, - "name": "default.body" - } - }, - { - "id": 554, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 555, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 556, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 557, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 558, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 559, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 560, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 561, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 724, - "name": "default.fetch" - } - }, - { - "id": 549, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 719, - "name": "default.headers" - } - }, - { - "id": 562, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 732, - "name": "default.isMaybeSingle" - } - }, - { - "id": 547, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 717, - "name": "default.method" - } - }, - { - "id": 565, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": 735, - "name": "default.retryEnabled" - } - }, - { - "id": 550, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 720, - "name": "default.schema" - } - }, - { - "id": 563, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 733, - "name": "default.shouldStripNulls" - } - }, - { - "id": 552, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "target": 722, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 553, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 723, - "name": "default.signal" - } - }, - { - "id": 548, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 718, - "name": "default.url" - } - }, - { - "id": 564, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 734, - "name": "default.urlLengthLimit" - } - }, - { - "id": 516, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "signatures": [ - { - "id": 517, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "parameters": [ - { - "id": 518, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 687, - "name": "default.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 686, - "name": "default.abortSignal" - } - }, - { - "id": 355, - "name": "containedBy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is contained by " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('classes')\n .select('name')\n .containedBy('days', ['monday', 'tuesday', 'wednesday', 'friday'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n classes (\n id int8 primary key,\n name text,\n days text[]\n );\n\ninsert into\n classes (id, name, days)\nvalues\n (1, 'Chemistry', array['monday', 'friday']),\n (2, 'History', array['monday', 'wednesday', 'thursday']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Chemistry\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .containedBy('during', '[2000-01-01 00:00, 2000-01-01 23:59)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On `jsonb` columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select('name')\n .containedBy('address', {})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210, \"street\": \"Melrose Place\" }'),\n (2, 'Jane', '{}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Jane\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1003, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1003" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1007, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1007" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1138" - } - ], - "signatures": [ - { - "id": 356, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1003, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1003" - } - ], - "typeParameters": [ - { - "id": 357, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 358, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 357, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 359, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 357, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 360, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1007, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1007" - } - ], - "parameters": [ - { - "id": 361, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 362, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 347, - "name": "contains", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " contains every element appearing in " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The jsonb, array, or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('issues')\n .select()\n .contains('tags', ['is:open', 'priority:low'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n issues (\n id int8 primary key,\n title text,\n tags text[]\n );\n\ninsert into\n issues (id, title, tags)\nvalues\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"title\": \"Cache invalidation is not working\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .contains('during', '[2000-01-01 13:00, 2000-01-01 13:30)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On `jsonb` columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select('name')\n .contains('address', { postcode: 90210 })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210, \"street\": \"Melrose Place\" }'),\n (2, 'Jane', '{}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On " - }, - { - "kind": "code", - "text": "`jsonb`" - }, - { - "kind": "text", - "text": " columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Michael\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 854, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L854" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 858, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L858" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 988, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L988" - } - ], - "signatures": [ - { - "id": 348, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 854, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L854" - } - ], - "typeParameters": [ - { - "id": 349, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 350, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 349, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 351, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 349, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 352, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 858, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L858" - } - ], - "parameters": [ - { - "id": 353, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 354, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 525, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "signatures": [ - { - "id": 526, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 696, - "name": "default.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 695, - "name": "default.csv" - } - }, - { - "id": 217, - "name": "eq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L158" - } - ], - "signatures": [ - { - "id": 218, - "name": "eq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nTo check if the value of " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL, you should use " - }, - { - "kind": "code", - "text": "`.is()`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L158" - } - ], - "typeParameters": [ - { - "id": 219, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 220, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 219, - "typeArguments": [ - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 219, - "typeArguments": [ - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 221, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "reflection", - "declaration": { - "id": 222, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 219, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 529, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "signatures": [ - { - "id": 530, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "parameters": [ - { - "id": 531, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 532, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 533, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 859, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L859" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 536, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 862, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L862" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 538, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 864, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L864" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "defaultValue": "'text'" - }, - { - "id": 535, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L861" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 534, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 860, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L860" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 537, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 863, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [533, 536, 538, 535, 534, 537] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 858, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L858" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 700, - "name": "default.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 699, - "name": "default.explain" - } - }, - { - "id": 455, - "name": "filter", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`opearator`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "operator", - "content": [ - { - "kind": "text", - "text": "The operator to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "filter() expects you to use the raw PostgREST syntax for the filter values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.filter('id', 'in', '(5,6,7)') // Use `()` for `in` filter\n.filter('arraycol', 'cs', '{\"a\",\"b\"}') // Use `cs` for `contains()`, `{}` for array values\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .filter('name', 'in', '(\"Han\",\"Yoda\")')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .filter('instruments.name', 'eq', 'flute')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2017, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2017" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2022, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2022" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2136, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2136" - } - ], - "signatures": [ - { - "id": 456, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2017, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2017" - } - ], - "typeParameters": [ - { - "id": 457, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 458, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 457, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 459, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - }, - { - "type": "literal", - "value": "not.match" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.isdistinct" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - }, - { - "type": "literal", - "value": "not.imatch" - } - ] - } - }, - { - "id": 460, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 461, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2022, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2022" - } - ], - "parameters": [ - { - "id": 462, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 463, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 464, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 527, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "signatures": [ - { - "id": 528, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 698, - "name": "default.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 697, - "name": "default.geojson" - } - }, - { - "id": 228, - "name": "gt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nWhen using [reserved words](https://www.postgresql.org/docs/current/sql-keywords-appendix.html) for column names you need\nto add double quotes e.g. " - }, - { - "kind": "code", - "text": "`.gt('\"order\"', 2)`" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .gt('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 245, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L245" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L246" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 295, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L295" - } - ], - "signatures": [ - { - "id": 229, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 245, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L245" - } - ], - "typeParameters": [ - { - "id": 230, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 231, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 230, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 232, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 230, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 233, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 246, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L246" - } - ], - "parameters": [ - { - "id": 234, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 235, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 236, - "name": "gte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than or equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .gte('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L300" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L301" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 350, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L350" - } - ], - "signatures": [ - { - "id": 237, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 300, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L300" - } - ], - "typeParameters": [ - { - "id": 238, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 239, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 238, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 240, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 238, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 241, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L301" - } - ], - "parameters": [ - { - "id": 242, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 243, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 284, - "name": "ilike", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The pattern to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .ilike('name', '%lu%')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L550" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L551" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 596, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L596" - } - ], - "signatures": [ - { - "id": 285, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L550" - } - ], - "typeParameters": [ - { - "id": 286, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 287, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 286, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 288, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 289, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 551, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L551" - } - ], - "parameters": [ - { - "id": 290, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 291, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 292, - "name": "ilikeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches all of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 601, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L601" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L605" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 615, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L615" - } - ], - "signatures": [ - { - "id": 293, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 601, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L601" - } - ], - "typeParameters": [ - { - "id": 294, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 295, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 296, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 297, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L605" - } - ], - "parameters": [ - { - "id": 298, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 299, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 300, - "name": "ilikeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches any of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-insensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 620, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L620" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 624, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L624" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 634, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L634" - } - ], - "signatures": [ - { - "id": 301, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 620, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L620" - } - ], - "typeParameters": [ - { - "id": 302, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 303, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 302, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 304, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 305, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 624, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L624" - } - ], - "parameters": [ - { - "id": 306, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 307, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 337, - "name": "in", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L801" - } - ], - "signatures": [ - { - "id": 338, - "name": "in", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .in('name', ['Leia', 'Han'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 801, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L801" - } - ], - "typeParameters": [ - { - "id": 339, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 340, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 341, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 339, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 324, - "name": "is", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL by setting " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\n\nFor boolean columns, you can also set " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " and it\nwill behave the same way as " - }, - { - "kind": "code", - "text": "`.eq()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\nUsing the " - }, - { - "kind": "code", - "text": "`eq()`" - }, - { - "kind": "text", - "text": " filter doesn't work when filtering for " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\n\nInstead, you need to use " - }, - { - "kind": "code", - "text": "`is()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Checking for nullness, true or false", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .select()\n .is('name', null)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'null'),\n (2, null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Checking for nullness, true or false\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"null\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L667" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 671, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L671" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 726, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L726" - } - ], - "signatures": [ - { - "id": 325, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 667, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L667" - } - ], - "typeParameters": [ - { - "id": 326, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 327, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 326, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 328, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 326, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 329, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 671, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L671" - } - ], - "parameters": [ - { - "id": 330, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 331, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 332, - "name": "isDistinct", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 741, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L741" - } - ], - "signatures": [ - { - "id": 333, - "name": "isDistinct", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS DISTINCT FROM " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nUnlike " - }, - { - "kind": "code", - "text": "`.neq()`" - }, - { - "kind": "text", - "text": ", this treats " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " as a comparable value. Two " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " values\nare considered equal (not distinct), and comparing " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " with any non-NULL\nvalue returns true (distinct)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 741, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L741" - } - ], - "typeParameters": [ - { - "id": 334, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 335, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 336, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 334, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 260, - "name": "like", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The pattern to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .like('name', '%Lu%')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L461" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L462" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 507, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L507" - } - ], - "signatures": [ - { - "id": 261, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 461, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L461" - } - ], - "typeParameters": [ - { - "id": 262, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 263, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 262, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 264, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 265, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 462, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L462" - } - ], - "parameters": [ - { - "id": 266, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 267, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 268, - "name": "likeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches all of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L512" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L516" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 526, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L526" - } - ], - "signatures": [ - { - "id": 269, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 512, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L512" - } - ], - "typeParameters": [ - { - "id": 270, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 271, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 270, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 272, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 273, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L516" - } - ], - "parameters": [ - { - "id": 274, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 275, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 276, - "name": "likeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches any of " - }, - { - "kind": "code", - "text": "`patterns`" - }, - { - "kind": "text", - "text": " case-sensitively." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "patterns", - "content": [ - { - "kind": "text", - "text": "The patterns to match with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 531, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L531" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 535, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L535" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 545, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L545" - } - ], - "signatures": [ - { - "id": 277, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 531, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L531" - } - ], - "typeParameters": [ - { - "id": 278, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 279, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 278, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 280, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 281, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 535, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L535" - } - ], - "parameters": [ - { - "id": 282, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 283, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 501, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "signatures": [ - { - "id": 502, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "parameters": [ - { - "id": 503, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 504, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 505, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 506, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 507, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [506, 507] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 672, - "name": "default.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 671, - "name": "default.limit" - } - }, - { - "id": 244, - "name": "lt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .lt('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 355, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L355" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L356" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 401, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L401" - } - ], - "signatures": [ - { - "id": 245, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 355, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L355" - } - ], - "typeParameters": [ - { - "id": 246, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 247, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 246, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 248, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 246, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 249, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 356, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L356" - } - ], - "parameters": [ - { - "id": 250, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 251, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 252, - "name": "lte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than or equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .lte('id', 2)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L406" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 407, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L407" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L456" - } - ], - "signatures": [ - { - "id": 253, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L406" - } - ], - "typeParameters": [ - { - "id": 254, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 255, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 254, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 256, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 254, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 257, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 407, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L407" - } - ], - "parameters": [ - { - "id": 258, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 259, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 427, - "name": "match", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where each column in " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": " keys is equal to its\nassociated value. Shorthand for multiple " - }, - { - "kind": "code", - "text": "`.eq()`" - }, - { - "kind": "text", - "text": "s." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "query", - "content": [ - { - "kind": "text", - "text": "The object to filter with, with column names as keys mapped\nto their filter values" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .match({ id: 2, name: 'Leia' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1708" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1709" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1754, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1754" - } - ], - "signatures": [ - { - "id": 428, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1708, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1708" - } - ], - "typeParameters": [ - { - "id": 429, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 430, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "reference", - "target": 429, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 429, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 431, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1709, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1709" - } - ], - "parameters": [ - { - "id": 432, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 544, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "signatures": [ - { - "id": 545, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "parameters": [ - { - "id": 546, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/feature-flags.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 715, - "name": "default.maxAffected" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 714, - "name": "default.maxAffected" - } - }, - { - "id": 522, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "signatures": [ - { - "id": 523, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "typeParameters": [ - { - "id": 524, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 524, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 693, - "name": "default.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 692, - "name": "default.maybeSingle" - } - }, - { - "id": 223, - "name": "neq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L227" - } - ], - "signatures": [ - { - "id": 224, - "name": "neq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is not equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nThis filter does not include rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": ". To match null\nvalues, use " - }, - { - "kind": "code", - "text": "`.is(column, null)`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .neq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 227, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L227" - } - ], - "typeParameters": [ - { - "id": 225, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 226, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 225, - "typeArguments": [ - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 225, - "typeArguments": [ - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 227, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 433, - "name": "not", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`opearator`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "operator", - "content": [ - { - "kind": "text", - "text": "The operator to be negated to filter with, following\nPostgREST syntax" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The value to filter with, following PostgREST syntax" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "not() expects you to use the raw PostgREST syntax for the filter values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.not('id', 'in', '(5,6,7)') // Use `()` for `in` filter\n.not('arraycol', 'cs', '{\"a\",\"b\"}') // Use `cs` for `contains()`, `{}` for array values\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .select()\n .not('name', 'is', null)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'null'),\n (2, null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"null\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1765, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1765" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1779, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1779" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1784, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1784" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1844, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1844" - } - ], - "signatures": [ - { - "id": 434, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1765, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1765" - } - ], - "typeParameters": [ - { - "id": 435, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 436, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 437, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "is" - } - }, - { - "id": 438, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": null - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "NonNullableColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullableColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "NarrowResultColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 435, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NarrowResultColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - }, - { - "id": 439, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1779, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1779" - } - ], - "typeParameters": [ - { - "id": 440, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 441, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 440, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 442, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 443, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 440, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 444, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1784, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1784" - } - ], - "parameters": [ - { - "id": 445, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 446, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 447, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 342, - "name": "notIn", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 832, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L832" - } - ], - "signatures": [ - { - "id": 343, - "name": "notIn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NOT included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 832, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L832" - } - ], - "typeParameters": [ - { - "id": 344, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 345, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 346, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 448, - "name": "or", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2005, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2005" - } - ], - "signatures": [ - { - "id": 449, - "name": "or", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`filters`" - }, - { - "kind": "text", - "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " - }, - { - "kind": "code", - "text": "`.or()`" - }, - { - "kind": "text", - "text": " filter across multiple tables." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.or('id.in.(5,6,7), arraycol.cs.{\"a\",\"b\"}') // Use `()` for `in` filter, `{}` for array values and `cs` for `contains()`.\n.or('id.in.(5,6,7), arraycol.cd.{\"a\",\"b\"}') // Use `cd` for `containedBy()`\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.eq.2,name.eq.Han')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n },\n {\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` with `and`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` on referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2005, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2005" - } - ], - "parameters": [ - { - "id": 450, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filters to use, following PostgREST syntax" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " instead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 454, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to filter on referenced tables\ninstead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [453, 454] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 2010, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 470, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order the query result by " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": ".\n\nYou 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 " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " in the query." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to order by" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.ascending", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the result will be in ascending order" - } - ] - }, - { - "tag": "@param", - "name": "options.nullsFirst", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear first. If " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear last." - } - ] - }, - { - "tag": "@param", - "name": "options.referencedTable", - "content": [ - { - "kind": "text", - "text": "Set this to order a referenced table by\nits columns" - } - ] - }, - { - "tag": "@param", - "name": "options.foreignTable", - "content": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('id, name')\n .order('id', { ascending: false })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " doesn't affect the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .order('name', { referencedTable: 'instruments', ascending: false })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n },\n {\n \"name\": \"harp\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": []\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referenced_table(col)`" - }, - { - "kind": "text", - "text": " affects the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "Order parent table by a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('instruments')\n .select(`\n name,\n section:orchestral_sections (\n name\n )\n `)\n .order('section(name)', { ascending: true })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"violin\",\n \"orchestral_sections\": {\"name\": \"strings\"}\n },\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L322" - } - ], - "signatures": [ - { - "id": 471, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - } - ], - "typeParameters": [ - { - "id": 472, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 473, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 472, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 474, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 475, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 476, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 477, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 478, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [476, 477, 478] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 641, - "name": "default.order" - } - }, - { - "id": 479, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - } - ], - "parameters": [ - { - "id": 480, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 481, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 482, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 483, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 484, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 485, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [483, 484, 485] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 649, - "name": "default.order" - } - }, - { - "id": 486, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - } - ], - "typeParameters": [ - { - "id": 487, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 488, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 487, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 489, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 490, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 491, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 493, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 492, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [491, 493, 492] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 656, - "name": "default.order" - } - }, - { - "id": 494, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - } - ], - "parameters": [ - { - "id": 495, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 496, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 497, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 498, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 500, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 499, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [498, 500, 499] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 664, - "name": "default.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 640, - "name": "default.order" - } - }, - { - "id": 403, - "name": "overlaps", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for array and range columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " have an element in common." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The array or range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "value", - "content": [ - { - "kind": "text", - "text": "The array or range value to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "On array columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('issues')\n .select('title')\n .overlaps('tags', ['is:closed', 'severity:high'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n issues (\n id int8 primary key,\n title text,\n tags text[]\n );\n\ninsert into\n issues (id, title, tags)\nvalues\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On array columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"title\": \"Cache invalidation is not working\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "On range columns", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .overlaps('during', '[2000-01-01 12:45, 2000-01-01 13:15)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On range columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1468" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1472" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1565, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1565" - } - ], - "signatures": [ - { - "id": 404, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1468" - } - ], - "typeParameters": [ - { - "id": 405, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 406, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 405, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 407, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 405, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 408, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1472, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1472" - } - ], - "parameters": [ - { - "id": 409, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 410, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 589, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 590, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 591, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 592, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 593, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 594, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [594] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 595, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 596, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [596] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 760, - "name": "default.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 759, - "name": "default.overrideTypes" - } - }, - { - "id": 508, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "signatures": [ - { - "id": 509, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "parameters": [ - { - "id": 510, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 511, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 512, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 513, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 514, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 515, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [514, 515] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 679, - "name": "default.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 678, - "name": "default.range" - } - }, - { - "id": 395, - "name": "rangeAdjacent", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is\nmutually exclusive to " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " and there can be no element between the two\nranges." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeAdjacent('during', '[2000-01-01 12:00, 2000-01-01 13:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1405, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1405" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1406" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1463" - } - ], - "signatures": [ - { - "id": 396, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1405, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1405" - } - ], - "typeParameters": [ - { - "id": 397, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 398, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 397, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 399, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 400, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1406, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1406" - } - ], - "parameters": [ - { - "id": 401, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 402, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 363, - "name": "rangeGt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is greater than any element in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeGt('during', '[2000-01-02 08:00, 2000-01-02 09:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 2,\n \"room_name\": \"Topaz\",\n \"during\": \"[\\\"2000-01-02 09:00:00\\\",\\\"2000-01-02 10:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1152" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1153" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1210" - } - ], - "signatures": [ - { - "id": 364, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1152, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1152" - } - ], - "typeParameters": [ - { - "id": 365, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 366, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 365, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 367, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 368, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1153" - } - ], - "parameters": [ - { - "id": 369, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 370, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 371, - "name": "rangeGte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is either contained in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " or greater than any element in\n" - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeGte('during', '[2000-01-02 08:30, 2000-01-02 09:30)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 2,\n \"room_name\": \"Topaz\",\n \"during\": \"[\\\"2000-01-02 09:00:00\\\",\\\"2000-01-02 10:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1215, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1215" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1216" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1274, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1274" - } - ], - "signatures": [ - { - "id": 372, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1215, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1215" - } - ], - "typeParameters": [ - { - "id": 373, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 374, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 373, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 375, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 376, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1216, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1216" - } - ], - "parameters": [ - { - "id": 377, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 378, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 379, - "name": "rangeLt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is less than any element in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeLt('during', '[2000-01-01 15:00, 2000-01-01 16:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1279, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1279" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1280" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1336, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1336" - } - ], - "signatures": [ - { - "id": 380, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1279, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1279" - } - ], - "typeParameters": [ - { - "id": 381, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 382, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 381, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 383, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 384, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1280, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1280" - } - ], - "parameters": [ - { - "id": 385, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 386, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 387, - "name": "rangeLte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for range columns. Match only rows where every element in\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is either contained in " - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": " or less than any element in\n" - }, - { - "kind": "code", - "text": "`range`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The range column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "range", - "content": [ - { - "kind": "text", - "text": "The range to filter with" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeLte('during', '[2000-01-01 14:00, 2000-01-01 16:00)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1341, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1341" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1342" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1400, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1400" - } - ], - "signatures": [ - { - "id": 388, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1341, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1341" - } - ], - "typeParameters": [ - { - "id": 389, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 390, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 389, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 391, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 392, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1342, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1342" - } - ], - "parameters": [ - { - "id": 393, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 394, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 316, - "name": "regexIMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the PostgreSQL regex " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": "\ncase-insensitively (using the " - }, - { - "kind": "code", - "text": "`~*`" - }, - { - "kind": "text", - "text": " operator)." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The PostgreSQL regular expression pattern to match with" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L653" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 654, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L654" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 662, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L662" - } - ], - "signatures": [ - { - "id": 317, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 653, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L653" - } - ], - "typeParameters": [ - { - "id": 318, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 319, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 318, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 320, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 321, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 654, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L654" - } - ], - "parameters": [ - { - "id": 322, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 323, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 308, - "name": "regexMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the PostgreSQL regex " - }, - { - "kind": "code", - "text": "`pattern`" - }, - { - "kind": "text", - "text": "\ncase-sensitively (using the " - }, - { - "kind": "code", - "text": "`~`" - }, - { - "kind": "text", - "text": " operator)." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "pattern", - "content": [ - { - "kind": "text", - "text": "The PostgreSQL regular expression pattern to match with" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 639, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L639" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 640, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 648, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L648" - } - ], - "signatures": [ - { - "id": 309, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 639, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L639" - } - ], - "typeParameters": [ - { - "id": 310, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 311, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 310, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 312, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 313, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 640, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640" - } - ], - "parameters": [ - { - "id": 314, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 315, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 574, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 575, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 576, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 745, - "name": "default.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 744, - "name": "default.retry" - } - }, - { - "id": 541, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "signatures": [ - { - "id": 542, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "typeParameters": [ - { - "id": 543, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 543, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 712, - "name": "default.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 711, - "name": "default.returns" - } - }, - { - "id": 539, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "signatures": [ - { - "id": 540, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 710, - "name": "default.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 709, - "name": "default.rollback" - } - }, - { - "id": 465, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "signatures": [ - { - "id": 466, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "typeParameters": [ - { - "id": 467, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 468, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 469, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 636, - "name": "default.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 635, - "name": "default.select" - } - }, - { - "id": 570, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 571, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 572, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 573, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 741, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 740, - "name": "default.setHeader" - } - }, - { - "id": 519, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "signatures": [ - { - "id": 520, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "typeParameters": [ - { - "id": 521, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 521, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 690, - "name": "default.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 689, - "name": "default.single" - } - }, - { - "id": 568, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 569, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 739, - "name": "default.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 738, - "name": "default.stripNulls" - } - }, - { - "id": 411, - "name": "textSearch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only relevant for text and tsvector columns. Match only rows where\n" - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " matches the query string in " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The text or tsvector column to filter on" - } - ] - }, - { - "tag": "@param", - "name": "query", - "content": [ - { - "kind": "text", - "text": "The query text to match with" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.config", - "content": [ - { - "kind": "text", - "text": "The text search configuration to use" - } - ] - }, - { - "tag": "@param", - "name": "options.type", - "content": [ - { - "kind": "text", - "text": "Change how the " - }, - { - "kind": "code", - "text": "`query`" - }, - { - "kind": "text", - "text": " text is interpreted" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- For more information, see [Postgres full text search](/docs/guides/database/full-text-search)." - } - ] - }, - { - "tag": "@example", - "name": "Text search", - "content": [ - { - "kind": "code", - "text": "```ts\nconst result = await supabase\n .from(\"texts\")\n .select(\"content\")\n .textSearch(\"content\", `'eggs' & 'ham'`, {\n config: \"english\",\n });\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Text search\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table texts (\n id bigint\n primary key\n generated always as identity,\n content text\n);\n\ninsert into texts (content) values\n ('Four score and seven years ago'),\n ('The road goes ever on and on'),\n ('Green eggs and ham')\n;\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Text search\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"content\": \"Green eggs and ham\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Basic normalization\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`plainto_tsquery`" - }, - { - "kind": "text", - "text": " function." - } - ] - }, - { - "tag": "@example", - "name": "Basic normalization", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat' & 'cat'`, {\n type: 'plain',\n config: 'english'\n })\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Full normalization\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`phraseto_tsquery`" - }, - { - "kind": "text", - "text": " function." - } - ] - }, - { - "tag": "@example", - "name": "Full normalization", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat' & 'cat'`, {\n type: 'phrase',\n config: 'english'\n })\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Websearch\nUses PostgreSQL's " - }, - { - "kind": "code", - "text": "`websearch_to_tsquery`" - }, - { - "kind": "text", - "text": " function.\nThis function will never raise syntax errors, which makes it possible to use raw user-supplied input for search, and can be used\nwith advanced operators.\n\n- " - }, - { - "kind": "code", - "text": "`unquoted text`" - }, - { - "kind": "text", - "text": ": text not inside quote marks will be converted to terms separated by & operators, as if processed by plainto_tsquery.\n- " - }, - { - "kind": "code", - "text": "`\"quoted text\"`" - }, - { - "kind": "text", - "text": ": text inside quote marks will be converted to terms separated by " - }, - { - "kind": "code", - "text": "`<->`" - }, - { - "kind": "text", - "text": " operators, as if processed by phraseto_tsquery.\n- " - }, - { - "kind": "code", - "text": "`OR`" - }, - { - "kind": "text", - "text": ": the word “or” will be converted to the | operator.\n- " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": ": a dash will be converted to the ! operator." - } - ] - }, - { - "tag": "@example", - "name": "Websearch", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat or cat'`, {\n type: 'websearch',\n config: 'english'\n })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1576, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1576" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1581, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1581" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1690, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1690" - } - ], - "signatures": [ - { - "id": 412, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1576, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1576" - } - ], - "typeParameters": [ - { - "id": 413, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 414, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 413, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 415, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 416, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 417, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 418, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 419, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [418, 419] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1579, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 420, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1581, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1581" - } - ], - "parameters": [ - { - "id": 421, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 423, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 424, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 425, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 426, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [425, 426] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 1584, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 577, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 578, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 579, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 580, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 581, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 582, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 583, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 584, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 585, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 586, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 587, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 588, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 748, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 747, - "name": "default.then" - } - }, - { - "id": 566, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 567, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 737, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 736, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [187] - }, - { - "title": "Properties", - "children": [551, 554, 549, 562, 547, 565, 550, 563, 552, 553, 548, 564] - }, - { - "title": "Methods", - "children": [ - 516, 355, 347, 525, 217, 529, 455, 527, 228, 236, 284, 292, 300, 337, 324, 332, 260, - 268, 276, 501, 244, 252, 427, 544, 522, 223, 433, 342, 448, 470, 403, 589, 508, 395, - 363, 371, 379, 387, 316, 308, 574, 541, 539, 465, 570, 519, 568, 411, 577, 566 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 187, 516, 355, 347, 525, 217, 529, 455, 527, 228, 236, 284, 292, 300, 337, 324, 260, - 268, 276, 501, 244, 252, 427, 544, 522, 223, 433, 448, 470, 403, 589, 508, 395, 363, - 371, 379, 387, 541, 539, 465, 570, 519, 568, 411, 566 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [574] - }, - { - "title": "Other", - "children": [ - 551, 554, 549, 562, 547, 565, 550, 563, 552, 553, 548, 564, 332, 342, 316, 308, 577 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", - "line": 95, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L95" - } - ], - "typeParameters": [ - { - "id": 597, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 598, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 599, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 600, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 601, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 602, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 603, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 189, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 190, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 191, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 192, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 193, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 194, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 195, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "default", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 81, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 82, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L65" - } - ], - "signatures": [ - { - "id": 83, - "name": "PostgrestQueryBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a query builder scoped to a Postgres table or view." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst query = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: { apikey: 'your-publishable-key' }, retry: true }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L65" - } - ], - "typeParameters": [ - { - "id": 84, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 85, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 86, - "name": "Relation", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 87, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 88, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 89, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 90, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [90] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "parameters": [ - { - "id": 91, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL for the query" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 92, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 96, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L76" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 97, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 98, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 99, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 100, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 101, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 102, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 103, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 94, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 74, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L74" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 105, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable automatic retries for transient errors (default: true)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 78, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 95, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to use" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 104, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length before warning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 77, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L77" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "8000" - } - ], - "groups": [ - { - "title": "Properties", - "children": [96, 94, 105, 95, 104] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 73, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L73" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 81, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 110, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L23" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 112, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 113, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 114, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 115, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 116, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 117, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 107, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L20" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 119, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\nWhen enabled, idempotent requests (GET/HEAD/OPTIONS) that fail with network\nerrors or HTTP 503/520 responses are automatically retried with exponential\nbackoff (1s, 2s, 4s, up to 3 attempts). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " when not specified." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 108, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L21" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 109, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L22" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 106, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L19" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 118, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 173, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1736, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1736" - } - ], - "signatures": [ - { - "id": 174, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\n- If you use " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " with filters and you have\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\n rows visible through " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": " policies are deleted. Note that by default\n no rows are visible, so you need at least one " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": "/" - }, - { - "kind": "code", - "text": "`ALL`" - }, - { - "kind": "text", - "text": " policy that\n makes the rows visible.\n- When using " - }, - { - "kind": "code", - "text": "`delete().in()`" - }, - { - "kind": "text", - "text": ", specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal." - } - ] - }, - { - "tag": "@example", - "name": "Delete a single record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete multiple records", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .in('id', [1, 2, 3])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1736, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1736" - } - ], - "parameters": [ - { - "id": 175, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 176, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 177, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count deleted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1739, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1739" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 178, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [177] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1738, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1738" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 135, - "name": "insert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1086, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1086" - } - ], - "signatures": [ - { - "id": 136, - "name": "insert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Create a record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk create\nA bulk create operation is handled in a single transaction.\nIf any of the inserts fail, none of the rows are inserted." - } - ] - }, - { - "tag": "@example", - "name": "Bulk create", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert([\n { id: 1, name: 'Mordor' },\n { id: 1, name: 'The Shire' },\n ])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (id)=(1) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"countries_pkey\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1086, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1086" - } - ], - "typeParameters": [ - { - "id": 137, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 138, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 140, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1089, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1089" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [140] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1089, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1089" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 137, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 142, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1093, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1093" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [142] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1093, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1093" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 137, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 143, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 144, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 145, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count inserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1100" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 146, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 147, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1101, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1101" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - } - ], - "groups": [ - { - "title": "Properties", - "children": [145, 147] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1099, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1099" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 125, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L905" - } - ], - "signatures": [ - { - "id": 126, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT query on the table or view." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "When using " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`.range()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`.limit()`" - }, - { - "kind": "text", - "text": ", the returned " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " is the total number of rows\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\n\n- By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use " - }, - { - "kind": "code", - "text": "`range()`" - }, - { - "kind": "text", - "text": " queries to paginate through your data.\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Filters](/docs/reference/javascript/using-filters)\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\n- " - }, - { - "kind": "code", - "text": "`apikey`" - }, - { - "kind": "text", - "text": " is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Getting your data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Harry'),\n (2, 'Frodo'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Harry\"\n },\n {\n \"id\": 2,\n \"name\": \"Frodo\"\n },\n {\n \"id\": 3,\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nThe most useful field on a Postgres error is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (" - }, - { - "kind": "code", - "text": "`code: '42501'`" - }, - { - "kind": "text", - "text": ") arrives with a " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " like " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\"`" - }, - { - "kind": "text", - "text": ". Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so the hint isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('characters').select()\nif (error) {\n // Logs the full error: message, code, details, and hint.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"42501\",\n \"details\": null,\n \"hint\": \"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\",\n \"message\": \"permission denied for table characters\"\n },\n \"status\": 401,\n \"statusText\": \"Unauthorized\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Selecting specific columns", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Frodo'),\n (2, 'Harry'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Frodo\"\n },\n {\n \"name\": \"Harry\"\n },\n {\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\nIf your database has foreign key relationships, you can query related tables too." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\nIf your table name contains spaces, you must use double quotes in the " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " statement to reference the table." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables with spaces in their names", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral sections')\n .select(`\n name,\n \"musical instruments\" (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n \"orchestral sections\" (id int8 primary key, name text);\ncreate table\n \"musical instruments\" (\n id int8 primary key,\n section_id int8 not null references \"orchestral sections\",\n name text\n );\n\ninsert into\n \"orchestral sections\" (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n \"musical instruments\" (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"musical instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"musical instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\nIf you're in a situation where your tables are **NOT** directly\nrelated, but instead are joined by a _join table_, you can still use\nthe " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " method to query the related data. The join table needs\nto have the foreign keys as part of its composite primary key." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables through a join table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n name,\n teams (\n name\n )\n `)\n \n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n -- both foreign keys must be part of a composite primary key\n primary key (user_id, team_id)\n );\n\ninsert into\n users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Kiran\",\n \"teams\": [\n {\n \"name\": \"Green\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Evan\",\n \"teams\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n \n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\nIf you need to query the same referenced table twice, use the name of the\njoined column to identify which join to use. You can also give each\ncolumn an alias." - } - ] - }, - { - "tag": "@example", - "name": "Query the same referenced table multiple times", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:sender_id(name),\n to:receiver_id(name)\n `)\n\n// To infer types, use the name of the table (in this case `users`) and\n// the name of the foreign key constraint.\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:users!messages_sender_id_fkey(name),\n to:users!messages_receiver_id_fkey(name)\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\n" - }, - { - "kind": "code", - "text": "```sql\n create table\n users (id int8 primary key, name text);\n\n create table\n messages (\n sender_id int8 not null references users,\n receiver_id int8 not null references users,\n content text\n );\n\n insert into\n users (id, name)\n values\n (1, 'Kiran'),\n (2, 'Evan');\n\n insert into\n messages (sender_id, receiver_id, content)\n values\n (1, 2, '👋');\n ```" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleResponse Query the same referenced table multiple times\n```" - }, - { - "kind": "text", - "text": "json\n{\n \"data\": [\n {\n \"content\": \"👋\",\n \"from\": {\n \"name\": \"Kiran\"\n },\n \"to\": {\n \"name\": \"Evan\"\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleDescription Query nested foreign tables through a join table\nYou can use the result of a joined table to gather data in\nanother foreign table. With multiple references to the same foreign\ntable you must specify the column on which to conduct the join.\n\n@example Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "ts\n const { data, error } = await supabase\n .from('games')\n .select(" - }, - { - "kind": "code", - "text": "`\n game_id:id,\n away_team:teams!games_away_team_fkey (\n users (\n id,\n name\n )\n )\n `" - }, - { - "kind": "text", - "text": ")\n \n" - }, - { - "kind": "code", - "text": "```\n\n@exampleSql Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "sql\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n\n primary key (user_id, team_id)\n );\ncreate table\n games (\n id int8 primary key,\n home_team int8 not null references teams,\n away_team int8 not null references teams,\n name text\n );\n\ninsert into users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\ninsert into\n games (id, home_team, away_team, name)\nvalues\n (1, 1, 2, 'Green vs Blue'),\n (2, 2, 1, 'Blue vs Green');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query nested foreign tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"game_id\": 1,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n },\n {\n \"id\": 2,\n \"name\": \"Evan\"\n }\n ]\n }\n },\n {\n \"game_id\": 2,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n }\n ]\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n \n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\nIf the filter on a referenced table's column is not satisfied, the referenced\ntable returns " - }, - { - "kind": "code", - "text": "`[]`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " but the parent table is not filtered out.\nIf you want to filter out the parent table rows, use the " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " hint" - } - ] - }, - { - "tag": "@example", - "name": "Filtering through referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections(*)')\n .eq('orchestral_sections.name', 'percussion')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": null\n },\n {\n \"name\": \"violin\",\n \"orchestral_sections\": null\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\nYou can get the number of rows in a related table by using the\n**count** property." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with count", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`*, instruments(count)`)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table characters (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('strings') returning id\n)\ninsert into instruments (name, section_id) values\n('violin', (select id from section)),\n('viola', (select id from section)),\n('cello', (select id from section)),\n('double bass', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```json\n[\n {\n \"id\": \"693694e7-d993-4360-a6d7-6294e325d9b6\",\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"count\": 4\n }\n ]\n }\n]\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying with count option\nYou can get the number of rows by using the\n[count](/docs/reference/javascript/select#parameters) option." - } - ] - }, - { - "tag": "@example", - "name": "Querying with count option", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { count, error } = await supabase\n .from('characters')\n .select('*', { count: 'exact', head: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"count\": 3,\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\nYou can select and filter data inside of\n[JSON](/docs/guides/database/json) columns. Postgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nquerying JSON data." - } - ] - }, - { - "tag": "@example", - "name": "Querying JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n id, name,\n address->city\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Frodo', '{\"city\":\"Hobbiton\"}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Frodo\",\n \"city\": \"Hobbiton\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\nIf you don't want to return the referenced table contents, you can leave the parenthesis empty.\nLike " - }, - { - "kind": "code", - "text": "`.select('name, orchestral_sections!inner()')`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with inner join", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections!inner(name)')\n .eq('orchestral_sections.name', 'woodwinds')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table instruments (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('woodwinds') returning id\n)\ninsert into instruments (name, section_id) values\n('flute', (select id from section)),\n('clarinet', (select id from section)),\n('bassoon', (select id from section)),\n('piccolo', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\nIn addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas)." - } - ] - }, - { - "tag": "@example", - "name": "Switching schemas per query", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .schema('myschema')\n .from('mytable')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```sql\ncreate schema myschema;\n\ncreate table myschema.mytable (\n id uuid primary key default gen_random_uuid(),\n data text\n);\n\ninsert into myschema.mytable (data) values ('mydata');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": \"4162e008-27b0-4c0f-82dc-ccaeee9a624d\",\n \"data\": \"mydata\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 905, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L905" - } - ], - "typeParameters": [ - { - "id": 127, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 128, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 127, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 129, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " - }, - { - "kind": "code", - "text": "`customName:columnName`" - } - ] - }, - "type": { - "type": "reference", - "target": 127, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 130, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 133, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows in the table or view.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 919, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L919" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 132, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 918, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L918" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [133, 132] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 917, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L917" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 128, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "GET" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 163, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1571" - } - ], - "signatures": [ - { - "id": 164, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update." - } - ] - }, - { - "tag": "@example", - "name": "Updating your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\nPostgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nworking with JSON data. Currently, it is only possible to update the entire JSON document." - } - ] - }, - { - "tag": "@example", - "name": "Updating JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .update({\n address: {\n street: 'Melrose Place',\n postcode: 90210\n }\n })\n .eq('address->postcode', 90210)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210 }');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Michael\",\n \"address\": {\n \"street\": \"Melrose Place\",\n \"postcode\": 90210\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1571" - } - ], - "typeParameters": [ - { - "id": 165, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 166, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to update with" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 167, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 168, - "name": "Update", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1573, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1573" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [168] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1573, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1573" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Update" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 165, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 169, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 170, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 171, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count updated rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1579, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1579" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 172, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [171] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1578, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1578" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "PATCH" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 148, - "name": "upsert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1360" - } - ], - "signatures": [ - { - "id": 149, - "name": "upsert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": " allows you to perform the equivalent of\n" - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": " if a row with the corresponding " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates`" - }, - { - "kind": "text", - "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Upsert a single row using a unique key", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting a single row, overwriting based on the 'username' unique column\nconst { data, error } = await supabase\n .from('users')\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\n\n// Example response:\n// {\n// data: [\n// { id: 4, message: 'bar', username: 'supabot' }\n// ],\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upsert with conflict resolution and exact row counting", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting and returning exact count\nconst { data, error, count } = await supabase\n .from('users')\n .upsert(\n {\n id: 3,\n message: 'foo',\n username: 'supabot'\n },\n {\n onConflict: 'username',\n count: 'exact'\n }\n )\n\n// Example response:\n// {\n// data: [\n// {\n// id: 42,\n// handle: \"saoirse\",\n// display_name: \"Saoirse\"\n// }\n// ],\n// count: 1,\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Primary keys must be included in " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " to use upsert." - } - ] - }, - { - "tag": "@example", - "name": "Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert({ id: 1, name: 'piano' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Bulk Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert([\n { id: 1, name: 'piano' },\n { id: 2, name: 'harp' },\n ])\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n },\n {\n \"id\": 2,\n \"name\": \"harp\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\nIn the following query, " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " implicitly uses the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": "\n(primary key) column to determine conflicts. If there is no existing\nrow with the same " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " inserts a new row, which\nwill fail in this case as there is already a row with " - }, - { - "kind": "code", - "text": "`handle`" - }, - { - "kind": "text", - "text": " " - }, - { - "kind": "code", - "text": "`\"saoirse\"`" - }, - { - "kind": "text", - "text": ".\nUsing the " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " option, you can instruct " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " to use\nanother column with a unique constraint to determine conflicts." - } - ] - }, - { - "tag": "@example", - "name": "Upserting into tables with constraints", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 generated by default as identity primary key,\n handle text not null unique,\n display_name text\n );\n\ninsert into\n users (id, handle, display_name)\nvalues\n (1, 'saoirse', null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (handle)=(saoirse) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"users_handle_key\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1360, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1360" - } - ], - "typeParameters": [ - { - "id": 150, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 151, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 153, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1363, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1363" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [153] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1363, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1363" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 150, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 154, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 155, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1367, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1367" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [155] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1367, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1367" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 86, - "typeArguments": [ - { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - ], - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 150, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 156, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 157, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 160, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count upserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1378, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1378" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 162, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates: false`" - }, - { - "kind": "text", - "text": ". This also only applies when doing bulk upserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1379" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 159, - "name": "ignoreDuplicates", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", duplicate rows are ignored. If\n" - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", duplicate rows are merged with existing rows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1377, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1377" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 158, - "name": "onConflict", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns are equal." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1376, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1376" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [160, 162, 159, 158] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 1375, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1375" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 84, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 85, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 87, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 88, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [82] - }, - { - "title": "Properties", - "children": [110, 107, 119, 108, 109, 106, 118] - }, - { - "title": "Methods", - "children": [173, 135, 125, 163, 148] - } - ], - "categories": [ - { - "title": "Database", - "children": [82, 173, 135, 125, 163, 148] - }, - { - "title": "Other", - "children": [110, 107, 119, 108, 109, 106, 118] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 12, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L12" - } - ], - "typeParameters": [ - { - "id": 179, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 180, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 181, - "name": "Relation", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 182, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 183, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 86, - "name": "Relation", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relation", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 184, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 185, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ], - "type": { - "type": "inferred", - "name": "R" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [185] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", - "line": 17, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - }, - { - "id": 604, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 605, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "signatures": [ - { - "id": 606, - "name": "PostgrestTransformBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ], - "typeParameters": [ - { - "id": 607, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 608, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 609, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 610, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 611, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 612, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 613, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 614, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 620, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 118, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 623, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 121, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 624, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 625, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 626, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 627, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 628, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 629, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 630, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 618, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 116, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 631, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 122, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 616, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 114, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L114" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 634, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 619, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 117, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 632, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 123, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 621, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 119, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 622, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 120, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 617, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 115, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 633, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 124, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [620, 623, 618, 631, 616, 634, 619, 632, 621, 622, 617, 633] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 113, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 776, - "name": "default.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 775, - "name": "default.constructor" - } - }, - { - "id": 721, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 79, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 805, - "name": "default.body" - } - }, - { - "id": 724, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 82, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 725, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 726, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 727, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 728, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 729, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 730, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 731, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 808, - "name": "default.fetch" - } - }, - { - "id": 719, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 77, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 803, - "name": "default.headers" - } - }, - { - "id": 732, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 816, - "name": "default.isMaybeSingle" - } - }, - { - "id": 717, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 75, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L75" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 801, - "name": "default.method" - } - }, - { - "id": 735, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L88" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": 819, - "name": "default.retryEnabled" - } - }, - { - "id": 720, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 78, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 804, - "name": "default.schema" - } - }, - { - "id": 733, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 84, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 817, - "name": "default.shouldStripNulls" - } - }, - { - "id": 722, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 80, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false", - "inheritedFrom": { - "type": "reference", - "target": 806, - "name": "default.shouldThrowOnError" - } - }, - { - "id": 723, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 807, - "name": "default.signal" - } - }, - { - "id": 718, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 76, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L76" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 802, - "name": "default.url" - } - }, - { - "id": 734, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 818, - "name": "default.urlLengthLimit" - } - }, - { - "id": 686, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "signatures": [ - { - "id": 687, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 598, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598" - } - ], - "parameters": [ - { - "id": 688, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 695, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "signatures": [ - { - "id": 696, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 740, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 699, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "signatures": [ - { - "id": 700, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 851, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" - } - ], - "parameters": [ - { - "id": 701, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 702, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 703, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 859, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L859" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 706, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 862, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L862" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 708, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 864, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L864" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - }, - "defaultValue": "'text'" - }, - { - "id": 705, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 861, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L861" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 704, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 860, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L860" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 707, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 863, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L863" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - } - ], - "groups": [ - { - "title": "Properties", - "children": [703, 706, 708, 705, 704, 707] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 858, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L858" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - } - } - ] - }, - { - "id": 697, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "signatures": [ - { - "id": 698, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 750, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750" - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 671, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "signatures": [ - { - "id": 672, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 448, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448" - } - ], - "parameters": [ - { - "id": 673, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 674, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 675, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 676, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 677, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [676, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 453, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 714, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "signatures": [ - { - "id": 715, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 967, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967" - } - ], - "parameters": [ - { - "id": 716, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/feature-flags.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - } - } - ] - }, - { - "id": 692, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "signatures": [ - { - "id": 693, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 692, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692" - } - ], - "typeParameters": [ - { - "id": 694, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 524, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 640, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order the query result by " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": ".\n\nYou 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 " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " in the query." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "column", - "content": [ - { - "kind": "text", - "text": "The column to order by" - } - ] - }, - { - "tag": "@param", - "name": "options", - "content": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - { - "tag": "@param", - "name": "options.ascending", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the result will be in ascending order" - } - ] - }, - { - "tag": "@param", - "name": "options.nullsFirst", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear first. If " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "s appear last." - } - ] - }, - { - "tag": "@param", - "name": "options.referencedTable", - "content": [ - { - "kind": "text", - "text": "Set this to order a referenced table by\nits columns" - } - ] - }, - { - "tag": "@param", - "name": "options.foreignTable", - "content": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('id, name')\n .order('id', { ascending: false })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "On a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " doesn't affect the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .order('name', { referencedTable: 'instruments', ascending: false })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n },\n {\n \"name\": \"harp\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": []\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\nOrdering with " - }, - { - "kind": "code", - "text": "`referenced_table(col)`" - }, - { - "kind": "text", - "text": " affects the ordering of the\nparent table." - } - ] - }, - { - "tag": "@example", - "name": "Order parent table by a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\n const { data, error } = await supabase\n .from('instruments')\n .select(`\n name,\n section:orchestral_sections (\n name\n )\n `)\n .order('section(name)', { ascending: true })\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Order parent table by a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"violin\",\n \"orchestral_sections\": {\"name\": \"strings\"}\n },\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - }, - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 322, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L322" - } - ], - "signatures": [ - { - "id": 641, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 111, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111" - } - ], - "typeParameters": [ - { - "id": 642, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 643, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 472, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 644, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 645, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 646, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 647, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 648, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [646, 647, 648] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 113, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 649, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115" - } - ], - "parameters": [ - { - "id": 650, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 651, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 652, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 653, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 654, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 655, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [653, 654, 655] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 117, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 656, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 122, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122" - } - ], - "typeParameters": [ - { - "id": 657, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 658, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 487, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 659, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 660, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 661, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 663, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 662, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [661, 663, 662] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 124, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 664, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129" - } - ], - "parameters": [ - { - "id": 665, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 666, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 667, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 668, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 670, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [668, 670, 669] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 131, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 759, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "signatures": [ - { - "id": 760, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 672, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L672" - } - ], - "typeParameters": [ - { - "id": 761, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 762, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 763, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 764, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [764] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 765, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 766, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [766] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 674, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L674" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/types.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 592, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 591, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "inheritedFrom": { - "type": "reference", - "target": 857, - "name": "default.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 856, - "name": "default.overrideTypes" - } - }, - { - "id": 678, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "signatures": [ - { - "id": 679, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515" - } - ], - "parameters": [ - { - "id": 680, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 681, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 682, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 684, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 685, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "foreignTable" - } - ], - "groups": [ - { - "title": "Properties", - "children": [684, 685] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 521, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 744, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "signatures": [ - { - "id": 745, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L249" - } - ], - "parameters": [ - { - "id": 746, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 829, - "name": "default.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 828, - "name": "default.retry" - } - }, - { - "id": 711, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "signatures": [ - { - "id": 712, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 939, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939" - } - ], - "typeParameters": [ - { - "id": 713, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 543, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": 854, - "name": "default.returns" - } - } - ], - "overwrites": { - "type": "reference", - "target": 853, - "name": "default.returns" - } - }, - { - "id": 709, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "signatures": [ - { - "id": 710, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 895, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 635, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "signatures": [ - { - "id": 636, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62" - } - ], - "typeParameters": [ - { - "id": 637, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 638, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 911, - "typeArguments": [ - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 639, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 467, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 186, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 468, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 740, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "signatures": [ - { - "id": 741, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 223, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L223" - } - ], - "parameters": [ - { - "id": 742, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 743, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 825, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 824, - "name": "default.setHeader" - } - }, - { - "id": 689, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "signatures": [ - { - "id": 690, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 645, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645" - } - ], - "typeParameters": [ - { - "id": 691, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 521, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 738, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "signatures": [ - { - "id": 739, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 210, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L210" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 823, - "name": "default.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 822, - "name": "default.stripNulls" - } - }, - { - "id": 747, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "signatures": [ - { - "id": 748, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 254, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L254" - } - ], - "typeParameters": [ - { - "id": 749, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 750, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 751, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "signatures": [ - { - "id": 753, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 261, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L261" - } - ], - "parameters": [ - { - "id": 754, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 755, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 756, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "signatures": [ - { - "id": 757, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 268, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L268" - } - ], - "parameters": [ - { - "id": 758, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 579, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 580, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 832, - "name": "default.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 831, - "name": "default.then" - } - }, - { - "id": 736, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "signatures": [ - { - "id": 737, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestBuilder.ts#L155" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 604, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 608, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 609, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 611, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 612, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 613, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - }, - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 821, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 820, - "name": "default.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [605] - }, - { - "title": "Properties", - "children": [721, 724, 719, 732, 717, 735, 720, 733, 722, 723, 718, 734] - }, - { - "title": "Methods", - "children": [ - 686, 695, 699, 697, 671, 714, 692, 640, 759, 678, 744, 711, 709, 635, 740, 689, 738, - 747, 736 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 605, 686, 695, 699, 697, 671, 714, 692, 640, 759, 678, 711, 709, 635, 740, 689, 738, 736 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [744] - }, - { - "title": "Other", - "children": [721, 724, 719, 732, 717, 735, 720, 733, 722, 723, 718, 734, 747] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", - "line": 8, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L8" - } - ], - "typeParameters": [ - { - "id": 767, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 768, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 769, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 770, - "name": "Result", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 771, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 772, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 773, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 774, - "typeArguments": [ - { - "type": "reference", - "target": 607, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 610, - "name": "Result", - "package": "@supabase/postgrest-js", - "qualifiedName": "default.Result", - "refersToTypeParameter": true - } - ], - "name": "default", - "package": "@supabase/postgrest-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 186, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 889, - "name": "PostgrestResponseFailure", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 893, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L25" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 892, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L24" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 891, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L23" - } - ], - "type": { - "type": "reference", - "target": 867, - "name": "PostgrestError", - "package": "@supabase/postgrest-js", - "qualifiedName": "default" - } - }, - { - "id": 894, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 895, - "name": "statusText", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.statusText" - } - }, - { - "id": 890, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L22" - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [893, 892, 891, 894, 895, 890] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 21, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L21" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase" - }, - "name": "PostgrestResponseBase", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 896, - "name": "PostgrestResponseSuccess", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 900, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L19" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 899, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L18" - } - ], - "type": { - "type": "reference", - "target": 903, - "name": "T", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestResponseSuccess.T", - "refersToTypeParameter": true - } - }, - { - "id": 898, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L17" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 901, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L12" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.status" - } - }, - { - "id": 902, - "name": "statusText", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PostgrestResponseBase.statusText" - } - }, - { - "id": 897, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 16, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L16" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [900, 899, 898, 901, 902, 897] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 15, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L15" - } - ], - "typeParameters": [ - { - "id": 903, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase" - }, - "name": "PostgrestResponseBase", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 908, - "name": "PostgrestClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 81, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L81" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 910, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L82" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [910] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/common/common.ts", - "line": 81, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/common/common.ts#L81" - } - ] - } - } - }, - { - "id": 906, - "name": "PostgrestMaybeSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 32, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L32" - } - ], - "typeParameters": [ - { - "id": 907, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 907, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 887, - "name": "PostgrestResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 33, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L33" - } - ], - "typeParameters": [ - { - "id": 888, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 904, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 888, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 904, - "name": "PostgrestSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/types/types.ts", - "line": 31, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/types/types.ts#L31" - } - ], - "typeParameters": [ - { - "id": 905, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 896, - "typeArguments": [ - { - "type": "reference", - "target": 905, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 889, - "name": "PostgrestResponseFailure", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 911, - "name": "UnstableGetResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Main entry point for constructing the result type of a PostgREST query." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/select-query-parser/result.ts", - "line": 38, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/select-query-parser/result.ts#L38" - } - ], - "typeParameters": [ - { - "id": 912, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Database schema." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 913, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of a row in the current table." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 914, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the current table or view." - } - ] - } - }, - { - "id": 915, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Relationships of the current table." - } - ] - } - }, - { - "id": 916, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The select query string literal to parse." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 917, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 908, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "IsAny" - }, - "typeArguments": [ - { - "type": "reference", - "target": 912, - "name": "Schema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "IsAny", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ProcessNodesWithoutSchema" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ProcessNodesWithoutSchema", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": null - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "RPCCallNodes" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "literal", - "value": "rpc_call" - } - }, - { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RPCCallNodes", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "ParseQuery" - }, - "typeArguments": [ - { - "type": "reference", - "target": 916, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ParseQuery", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "inferred", - "name": "ParsedQuery" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/parser.ts", - "qualifiedName": "Ast.Node" - }, - "name": "Ast.Node", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "GenericRelationship" - }, - "name": "GenericRelationship", - "package": "@supabase/postgrest-js" - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ProcessNodes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 917, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 912, - "name": "Schema", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 913, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 914, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 915, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ProcessNodes", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "SelectQueryError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "Invalid Relationships cannot infer result type" - } - ], - "name": "SelectQueryError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/utils.ts", - "qualifiedName": "SelectQueryError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "Invalid RelationName cannot infer result type" - } - ], - "name": "SelectQueryError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ParsedQuery" - }, - "name": "ParsedQuery", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - }, - { - "id": 1, - "name": "default", - "variant": "declaration", - "kind": 32, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 16, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L16" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 7, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L21" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 774, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 3, - "name": "PostgrestClient", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L17" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 9, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 8, - "name": "PostgrestError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L22" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 867, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 5, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L19" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 186, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 4, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L18" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 81, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 6, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L20" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 604, - "name": "default", - "package": "@supabase/postgrest-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [7, 3, 8, 5, 4, 6] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/src/index.ts", - "line": 16, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/postgrest-js/src/index.ts#L16" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Classes", - "children": [774, 9, 867, 186, 81, 604] - }, - { - "title": "Interfaces", - "children": [889, 896] - }, - { - "title": "Type Aliases", - "children": [908, 906, 887, 904, 911] - }, - { - "title": "Variables", - "children": [1] - } - ], - "packageName": "@supabase/postgrest-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase PostgREST JS SDK

    \n\n

    Isomorphic JavaScript SDK for PostgREST with an ORM-like interface.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/postgrest-js)](https://www.npmjs.com/package/@supabase/postgrest-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js)\n\n
    \n\n### Quick start\n\nInstall\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nUsage\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst REST_URL = 'http://localhost:3000'\nconst postgrest = new PostgrestClient(REST_URL)\n```" - }, - { - "kind": "text", - "text": "\n\n- [select()](https://supabase.com/docs/reference/javascript/select)\n- [insert()](https://supabase.com/docs/reference/javascript/insert)\n- [update()](https://supabase.com/docs/reference/javascript/update)\n- [delete()](https://supabase.com/docs/reference/javascript/delete)\n\n#### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`postgrest-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst REST_URL = 'http://localhost:3000'\nconst postgrest = new PostgrestClient(REST_URL, {\n fetch: (...args) => fetch(...args),\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Build (from monorepo root)\npnpm nx build postgrest-js\n\n# Build with watch mode for development\npnpm nx build:watch postgrest-js\n\n# TypeScript type checking\npnpm nx type-check postgrest-js\n\n# Generate documentation\npnpm nx docs postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\n**Supabase CLI Required!** The " - }, - { - "kind": "code", - "text": "`postgrest-js`" - }, - { - "kind": "text", - "text": " tests use the [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started) to run a local PostgreSQL database and PostgREST server.\n\n#### Quick Start\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run all tests (from monorepo root)\npnpm nx test:ci:postgrest postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis single command automatically:\n\n1. Stops any existing Supabase CLI containers\n2. Starts PostgreSQL database and PostgREST server via Supabase CLI\n3. Resets and seeds the database\n4. Runs all Jest unit tests with coverage\n5. Cleans up containers\n\n#### Individual Test Commands\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run Jest tests with coverage (requires infrastructure running)\npnpm nx test:run postgrest-js\n\n# Run type tests with tstyche\npnpm nx test:types postgrest-js\n\n# Run smoke tests (CommonJS and ESM imports)\npnpm nx test:smoke postgrest-js\n\n# Format code\npnpm nx format postgrest-js\n\n# Check formatting\npnpm nx format:check postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure\n\nThe tests use Supabase CLI to spin up:\n\n- **PostgreSQL** - Database with test schema and seed data (port 54322)\n- **PostgREST** - REST API server that the client connects to (port 54321)\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Manually manage test infrastructure (from monorepo root)\npnpm nx test:infra postgrest-js # Start containers\npnpm nx test:clean-pre postgrest-js # Stop and remove containers\n```" - }, - { - "kind": "text", - "text": "\n\nOr directly via Supabase CLI:\n\n" - }, - { - "kind": "code", - "text": "```bash\ncd packages/core/postgrest-js\nnpx supabase --workdir ./test start # Start all services\nnpx supabase --workdir ./test db reset # Reset and seed database\nnpx supabase --workdir ./test stop # Stop all services\n```" - }, - { - "kind": "text", - "text": "\n\n#### Regenerating TypeScript Types\n\nWhen the database schema changes, regenerate TypeScript types from the actual database:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From the monorepo root\npnpm run codegen:postgrest\n```" - }, - { - "kind": "text", - "text": "\n\nThis command automatically:\n\n1. Cleans up any existing Supabase containers\n2. Starts Supabase (PostgreSQL, PostgREST, and all services)\n3. Generates TypeScript types from the database schema\n4. Post-processes the generated types (updates JSON type definitions)\n5. Formats the generated file with Prettier\n6. Cleans up Supabase containers\n\nThe generated types are written to " - }, - { - "kind": "code", - "text": "`test/types.generated.ts`" - }, - { - "kind": "text", - "text": ".\n\n#### Test Types Explained\n\n- **Unit Tests** - Jest tests covering all client functionality (" - }, - { - "kind": "code", - "text": "`pnpm nx test:run postgrest-js`" - }, - { - "kind": "text", - "text": ")\n- **Type Tests** - Validates TypeScript types using tstyche (" - }, - { - "kind": "code", - "text": "`pnpm nx test:types postgrest-js`" - }, - { - "kind": "text", - "text": ")\n- **Smoke Tests** - Basic import/require tests for CommonJS and ESM (" - }, - { - "kind": "code", - "text": "`pnpm nx test:smoke postgrest-js`" - }, - { - "kind": "text", - "text": ")\n\n#### Prerequisites\n\n- **Supabase CLI** must be installed ([instructions](https://supabase.com/docs/guides/local-development/cli/getting-started)) or can be used through " - }, - { - "kind": "code", - "text": "`npx`" - }, - { - "kind": "text", - "text": " (" - }, - { - "kind": "code", - "text": "`npx supabase`" - }, - { - "kind": "text", - "text": ")\n- **Docker** must be installed and running (Supabase CLI uses Docker under the hood)\n- **Port 54321** - PostgREST API\n- **Port 54322** - PostgreSQL database\n- **Port 54323** - Supabase Studio (used for type generation)\n\n#### PostgREST v12 Backward Compatibility Tests\n\nWe maintain backward compatibility tests for PostgREST v12 (the current Supabase CLI uses v14+). These tests ensure the SDK works correctly for users still running older PostgREST versions.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run v12 compatibility tests (requires Docker)\npnpm nx test:ci:v12 postgrest-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command:\n\n1. Starts PostgREST v12 + PostgreSQL in Docker (ports 3012/5433)\n2. Runs runtime tests that verify v12-specific behavior\n3. Cleans up containers\n\n**Type-only tests** for v12 compatibility also run as part of the regular type tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\npnpm nx test:types postgrest-js # Includes v12-compat.test-d.ts\n```" - }, - { - "kind": "text", - "text": "\n\n**Note:** These v12 tests will be removed when v3 ships (sometime in 2026).\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n## License\n\nThis repo is licensed under MIT License." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "default" - }, - "2": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object" - }, - "3": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestClient" - }, - "4": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestQueryBuilder" - }, - "5": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestFilterBuilder" - }, - "6": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestTransformBuilder" - }, - "7": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestBuilder" - }, - "8": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__object.PostgrestError" - }, - "9": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default" - }, - "10": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.__constructor" - }, - "11": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default" - }, - "12": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Database" - }, - "13": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "14": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "15": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "16": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "17": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.SchemaName" - }, - "18": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Schema" - }, - "19": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "url" - }, - "20": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__1" - }, - "21": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "22": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.headers" - }, - "23": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.schema" - }, - "24": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.fetch" - }, - "25": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "26": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "27": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "28": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "29": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "30": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "31": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "32": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.timeout" - }, - "33": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "34": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.retry" - }, - "35": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.url" - }, - "36": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.headers" - }, - "37": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schemaName" - }, - "38": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.fetch" - }, - "39": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "40": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "41": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "42": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "43": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "44": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "45": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "46": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "47": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.retry" - }, - "48": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "49": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "50": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "TableName" - }, - "51": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "Table" - }, - "52": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "relation" - }, - "53": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.from" - }, - "54": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "ViewName" - }, - "55": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "View" - }, - "56": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "relation" - }, - "57": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schema" - }, - "58": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.schema" - }, - "59": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "DynamicSchema" - }, - "60": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "schema" - }, - "61": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.rpc" - }, - "62": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.rpc" - }, - "63": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "FnName" - }, - "64": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "Args" - }, - "65": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "FilterBuilder" - }, - "66": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "fn" - }, - "67": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "args" - }, - "68": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__2" - }, - "69": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.head" - }, - "71": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.get" - }, - "72": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.count" - }, - "73": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "74": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Database" - }, - "75": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "76": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "77": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "78": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "__type" - }, - "79": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.SchemaName" - }, - "80": { - "sourceFileName": "src/PostgrestClient.ts", - "qualifiedName": "default.Schema" - }, - "81": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default" - }, - "82": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "83": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default" - }, - "84": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "85": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Schema" - }, - "86": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relation" - }, - "87": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "88": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "89": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "90": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Relationships" - }, - "91": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "url" - }, - "92": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "93": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.headers" - }, - "95": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.schema" - }, - "96": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "97": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "98": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "99": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "100": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "101": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "102": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "103": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "104": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "105": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.retry" - }, - "106": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.url" - }, - "107": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.headers" - }, - "108": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.schema" - }, - "109": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.signal" - }, - "110": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.fetch" - }, - "111": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "112": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "113": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "114": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "115": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "116": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "117": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "118": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "119": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.retry" - }, - "125": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.select" - }, - "126": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.select" - }, - "127": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Query" - }, - "128": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "ResultOne" - }, - "129": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "columns" - }, - "130": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "options" - }, - "131": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "132": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.head" - }, - "133": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "134": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "135": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.insert" - }, - "136": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.insert" - }, - "137": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "138": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "139": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "140": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "141": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "142": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "143": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "144": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "145": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "146": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "147": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.defaultToNull" - }, - "148": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.upsert" - }, - "149": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.upsert" - }, - "150": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "151": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "152": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "153": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "154": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "155": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Insert" - }, - "156": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "157": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "158": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.onConflict" - }, - "159": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.ignoreDuplicates" - }, - "160": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "161": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "162": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.defaultToNull" - }, - "163": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.update" - }, - "164": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.update" - }, - "165": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "Row" - }, - "166": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "values" - }, - "167": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "168": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Update" - }, - "169": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__1" - }, - "170": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "171": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "172": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "173": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.delete" - }, - "174": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.delete" - }, - "175": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__0" - }, - "176": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "177": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.count" - }, - "178": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "179": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "180": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Schema" - }, - "181": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relation" - }, - "182": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "183": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "184": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type" - }, - "185": { - "sourceFileName": "src/PostgrestQueryBuilder.ts", - "qualifiedName": "__type.Relationships" - }, - "186": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default" - }, - "187": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "188": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "189": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "190": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Schema" - }, - "191": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Row" - }, - "192": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Result" - }, - "193": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "194": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "195": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Method" - }, - "196": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "197": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "198": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "199": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "200": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "201": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "202": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "203": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "204": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "205": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "206": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "207": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "208": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "209": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "210": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "211": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "212": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "213": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "214": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "215": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "216": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "217": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.eq" - }, - "218": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.eq" - }, - "219": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "220": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "221": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "222": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "223": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.neq" - }, - "224": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.neq" - }, - "225": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "226": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "227": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "228": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "229": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "230": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "231": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "232": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "233": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gt" - }, - "234": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "235": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "236": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "237": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "238": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "239": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "240": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "241": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.gte" - }, - "242": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "243": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "244": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "245": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "246": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "247": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "248": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "249": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lt" - }, - "250": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "251": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "252": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "253": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "254": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "255": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "256": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "257": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.lte" - }, - "258": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "259": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "260": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "261": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "262": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "263": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "264": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "265": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.like" - }, - "266": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "267": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "268": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "269": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "270": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "271": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "272": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "273": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAllOf" - }, - "274": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "275": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "276": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "277": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "278": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "279": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "280": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "281": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.likeAnyOf" - }, - "282": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "283": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "284": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "285": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "286": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "287": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "288": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "289": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilike" - }, - "290": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "291": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "292": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "293": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "294": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "295": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "296": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "297": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAllOf" - }, - "298": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "299": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "300": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "301": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "302": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "303": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "304": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "305": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ilikeAnyOf" - }, - "306": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "307": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "patterns" - }, - "308": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "309": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "310": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "311": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "312": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "313": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexMatch" - }, - "314": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "315": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "316": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "317": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "318": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "319": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "320": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "321": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.regexIMatch" - }, - "322": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "323": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "pattern" - }, - "324": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "325": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "326": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "327": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "328": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "329": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.is" - }, - "330": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "331": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "332": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.isDistinct" - }, - "333": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.isDistinct" - }, - "334": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "335": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "336": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "337": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.in" - }, - "338": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.in" - }, - "339": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "340": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "341": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "values" - }, - "342": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.notIn" - }, - "343": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.notIn" - }, - "344": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "345": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "346": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "values" - }, - "347": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "348": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "349": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "350": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "351": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "352": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.contains" - }, - "353": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "354": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "355": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "356": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "357": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "358": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "359": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "360": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.containedBy" - }, - "361": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "362": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "363": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "364": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "365": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "366": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "367": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "368": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGt" - }, - "369": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "370": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "371": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "372": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "373": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "374": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "375": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "376": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeGte" - }, - "377": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "378": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "379": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "380": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "381": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "382": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "383": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "384": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLt" - }, - "385": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "386": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "387": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "388": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "389": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "390": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "391": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "392": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeLte" - }, - "393": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "394": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "395": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "396": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "397": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "398": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "399": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "400": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.rangeAdjacent" - }, - "401": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "402": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "range" - }, - "403": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "404": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "405": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "406": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "407": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "408": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.overlaps" - }, - "409": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "410": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "411": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "412": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "413": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "414": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "415": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "416": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "options" - }, - "417": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "418": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.config" - }, - "419": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.type" - }, - "420": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.textSearch" - }, - "421": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "422": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "423": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "options" - }, - "424": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "425": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.config" - }, - "426": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.type" - }, - "427": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "428": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "429": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "430": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "431": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.match" - }, - "432": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "query" - }, - "433": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "434": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "435": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "436": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "437": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "438": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "439": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "440": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "441": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "442": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "443": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "444": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.not" - }, - "445": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "446": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "447": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "448": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.or" - }, - "449": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.or" - }, - "450": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "filters" - }, - "451": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__1" - }, - "452": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "454": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "455": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "456": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "457": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "ColumnName" - }, - "458": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "459": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "460": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "461": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.filter" - }, - "462": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "column" - }, - "463": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "operator" - }, - "464": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "value" - }, - "465": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "466": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "467": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "Query" - }, - "468": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResultOne" - }, - "469": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "columns" - }, - "470": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "471": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "472": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "473": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "474": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "475": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "476": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "477": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "478": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "479": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "480": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "481": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "482": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "483": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "484": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "485": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "486": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "487": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "488": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "489": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "490": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "491": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "492": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "493": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "494": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "495": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "496": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "497": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "498": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "499": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "500": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "501": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "502": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "503": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "count" - }, - "504": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__1" - }, - "505": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "506": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "507": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "508": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "509": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "510": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "from" - }, - "511": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "to" - }, - "512": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__2" - }, - "513": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "514": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "515": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "516": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "517": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "518": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "signal" - }, - "519": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "520": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "521": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "522": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "523": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "524": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "525": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "526": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "527": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "528": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "529": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "530": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "531": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__0" - }, - "532": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "533": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.analyze" - }, - "534": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.verbose" - }, - "535": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.settings" - }, - "536": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.buffers" - }, - "537": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.wal" - }, - "538": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.format" - }, - "539": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "540": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "541": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "542": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "543": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResult" - }, - "544": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "545": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "546": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "value" - }, - "547": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "548": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "549": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "550": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "551": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "552": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "553": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "554": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "555": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "556": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "557": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "558": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "559": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "560": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "561": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "562": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "563": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "564": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "565": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "566": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "567": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "568": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "569": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "570": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "571": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "572": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "573": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "574": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "575": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "576": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "577": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "578": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "579": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "580": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "581": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "582": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "583": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "584": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "585": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "586": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "587": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "588": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "589": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "590": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "591": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "592": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "593": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "594": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "595": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "596": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "597": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "598": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Schema" - }, - "599": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Row" - }, - "600": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Result" - }, - "601": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "602": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "603": { - "sourceFileName": "src/PostgrestFilterBuilder.ts", - "qualifiedName": "default.Method" - }, - "604": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default" - }, - "605": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "606": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "607": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "608": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Schema" - }, - "609": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Row" - }, - "610": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Result" - }, - "611": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "612": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "613": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Method" - }, - "614": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "615": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "617": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "618": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "619": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "620": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "621": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "622": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "623": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "624": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "625": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "626": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "627": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "628": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "629": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "630": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "631": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "632": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "633": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "634": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "635": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "636": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.select" - }, - "637": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "Query" - }, - "638": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResultOne" - }, - "639": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "columns" - }, - "640": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "641": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "642": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "643": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "644": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "645": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "646": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "647": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "648": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "649": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "650": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "651": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "652": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "653": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "654": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "655": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "656": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "657": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ColumnName" - }, - "658": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "659": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "660": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "661": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "662": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "663": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "664": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.order" - }, - "665": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "column" - }, - "666": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "options" - }, - "667": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "668": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.ascending" - }, - "669": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.nullsFirst" - }, - "670": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "671": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "672": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.limit" - }, - "673": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "count" - }, - "674": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__1" - }, - "675": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "676": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "677": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "678": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "679": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.range" - }, - "680": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "from" - }, - "681": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "to" - }, - "682": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__2" - }, - "683": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "684": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.foreignTable" - }, - "685": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.referencedTable" - }, - "686": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "687": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.abortSignal" - }, - "688": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "signal" - }, - "689": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "690": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.single" - }, - "691": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "692": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "693": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maybeSingle" - }, - "694": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "ResultOne" - }, - "695": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "696": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.csv" - }, - "697": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "698": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.geojson" - }, - "699": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "700": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.explain" - }, - "701": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__0" - }, - "702": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type" - }, - "703": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.analyze" - }, - "704": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.verbose" - }, - "705": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.settings" - }, - "706": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.buffers" - }, - "707": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.wal" - }, - "708": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "__type.format" - }, - "709": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "710": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.rollback" - }, - "711": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "712": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.returns" - }, - "713": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "NewResult" - }, - "714": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "715": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.maxAffected" - }, - "716": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "value" - }, - "717": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "718": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "719": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "720": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "721": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "722": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "723": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "724": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "725": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "726": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "727": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "728": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "729": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "730": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "731": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "732": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "733": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "734": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "735": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "736": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "737": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "738": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "739": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "740": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "741": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "742": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "743": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "744": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "745": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "746": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "747": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "748": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "749": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "750": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "751": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "752": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "753": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "754": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "755": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "756": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "757": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "758": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "759": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "760": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "761": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "762": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "763": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "765": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "766": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "767": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "768": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Schema" - }, - "769": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Row" - }, - "770": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Result" - }, - "771": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.RelationName" - }, - "772": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Relationships" - }, - "773": { - "sourceFileName": "src/PostgrestTransformBuilder.ts", - "qualifiedName": "default.Method" - }, - "774": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "775": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "776": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default" - }, - "777": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "778": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.Result" - }, - "779": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ThrowOnError" - }, - "780": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "builder" - }, - "781": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "782": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.method" - }, - "783": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.url" - }, - "784": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.headers" - }, - "785": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.schema" - }, - "786": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.body" - }, - "787": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "788": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.signal" - }, - "789": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.fetch" - }, - "790": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "791": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "792": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "793": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "794": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "795": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "796": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "797": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "798": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "799": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "800": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.retry" - }, - "801": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.method" - }, - "802": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.url" - }, - "803": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.headers" - }, - "804": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.schema" - }, - "805": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.body" - }, - "806": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldThrowOnError" - }, - "807": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.signal" - }, - "808": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.fetch" - }, - "809": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "810": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "811": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "812": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "813": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "814": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "815": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "816": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.isMaybeSingle" - }, - "817": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.shouldStripNulls" - }, - "818": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.urlLengthLimit" - }, - "819": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retryEnabled" - }, - "820": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "821": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.throwOnError" - }, - "822": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "823": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.stripNulls" - }, - "824": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "825": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.setHeader" - }, - "826": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "name" - }, - "827": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "828": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "829": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.retry" - }, - "830": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "enabled" - }, - "831": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "832": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.then" - }, - "833": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult1" - }, - "834": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "TResult2" - }, - "835": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "836": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "837": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "838": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "value" - }, - "839": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "onrejected" - }, - "840": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "841": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "842": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "reason" - }, - "853": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.returns" - }, - "854": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.returns" - }, - "855": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "856": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "857": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.overrideTypes" - }, - "858": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "NewResult" - }, - "859": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "Options" - }, - "860": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "861": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "862": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type" - }, - "863": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "__type.merge" - }, - "864": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ClientOptions" - }, - "865": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.Result" - }, - "866": { - "sourceFileName": "src/PostgrestBuilder.ts", - "qualifiedName": "default.ThrowOnError" - }, - "867": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default" - }, - "868": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.__constructor" - }, - "869": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default" - }, - "870": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "context" - }, - "871": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "873": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "874": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "875": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "876": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.details" - }, - "877": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.hint" - }, - "878": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.code" - }, - "879": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.toJSON" - }, - "880": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "default.toJSON" - }, - "881": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "882": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.name" - }, - "883": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "884": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "885": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "886": { - "sourceFileName": "src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "887": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponse" - }, - "888": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "889": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure" - }, - "890": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.success" - }, - "891": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.error" - }, - "892": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.data" - }, - "893": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseFailure.count" - }, - "894": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.status" - }, - "895": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.statusText" - }, - "896": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "897": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.success" - }, - "898": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.error" - }, - "899": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.data" - }, - "900": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.count" - }, - "901": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.status" - }, - "902": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseBase.statusText" - }, - "903": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestResponseSuccess.T" - }, - "904": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestSingleResponse" - }, - "905": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "906": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "PostgrestMaybeSingleResponse" - }, - "907": { - "sourceFileName": "src/types/types.ts", - "qualifiedName": "T" - }, - "908": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "ClientServerOptions" - }, - "909": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "__type" - }, - "910": { - "sourceFileName": "src/types/common/common.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "911": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "GetResult" - }, - "912": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Schema" - }, - "913": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Row" - }, - "914": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "RelationName" - }, - "915": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Relationships" - }, - "916": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "Query" - }, - "917": { - "sourceFileName": "src/select-query-parser/result.ts", - "qualifiedName": "ClientOptions" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/realtime.json b/apps/docs/spec/enrichments/tsdoc_v2/realtime.json deleted file mode 100644 index da040a4c859..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/realtime.json +++ /dev/null @@ -1,17533 +0,0 @@ -{ - "id": 0, - "name": "@supabase/realtime-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 693, - "name": "REALTIME_LISTEN_TYPES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 694, - "name": "BROADCAST", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L138" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 696, - "name": "POSTGRES_CHANGES", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L140" - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 695, - "name": "PRESENCE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 139, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L139" - } - ], - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 697, - "name": "SYSTEM", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L141" - } - ], - "type": { - "type": "literal", - "value": "system" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [694, 696, 695, 697] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 137, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L137" - } - ] - }, - { - "id": 698, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 699, - "name": "ALL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 131, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L131" - } - ], - "type": { - "type": "literal", - "value": "*" - } - }, - { - "id": 702, - "name": "DELETE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 134, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L134" - } - ], - "type": { - "type": "literal", - "value": "DELETE" - } - }, - { - "id": 700, - "name": "INSERT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L132" - } - ], - "type": { - "type": "literal", - "value": "INSERT" - } - }, - { - "id": 701, - "name": "UPDATE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 133, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L133" - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [699, 702, 700, 701] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 130, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L130" - } - ] - }, - { - "id": 703, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 705, - "name": "JOIN", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L33" - } - ], - "type": { - "type": "literal", - "value": "join" - } - }, - { - "id": 706, - "name": "LEAVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L34" - } - ], - "type": { - "type": "literal", - "value": "leave" - } - }, - { - "id": 704, - "name": "SYNC", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L32" - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [705, 706, 704] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 31, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L31" - } - ] - }, - { - "id": 707, - "name": "REALTIME_SUBSCRIBE_STATES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 711, - "name": "CHANNEL_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 148, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L148" - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - } - }, - { - "id": 710, - "name": "CLOSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 147, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L147" - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - } - }, - { - "id": 708, - "name": "SUBSCRIBED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 145, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L145" - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - } - }, - { - "id": 709, - "name": "TIMED_OUT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L146" - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [711, 710, 708, 709] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 144, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L144" - } - ] - }, - { - "id": 10, - "name": "RealtimeChannel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "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": 15, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L238" - } - ], - "signatures": [ - { - "id": 16, - "name": "RealtimeChannel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\n\nThe topic determines which realtime stream you are subscribing to. Config options let you\nenable acknowledgement for broadcasts, presence tracking, or private channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L238" - } - ], - "parameters": [ - { - "id": 17, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 18, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - }, - { - "id": 19, - "name": "socket", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 20, - "name": "bindings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L177" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "Binding" - }, - "name": "Binding", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 22, - "name": "broadcastEndpointURL", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 179, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L179" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 241, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L241" - } - ], - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - }, - { - "id": 24, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 181, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L181" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 23, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 180, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L180" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 40, - "name": "socket", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 242, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L242" - } - ], - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 21, - "name": "subTopic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 178, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L178" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 38, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 240, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L240" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 30, - "name": "joinedOnce", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L193" - } - ], - "getSignature": { - "id": 31, - "name": "joinedOnce", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L193" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - }, - { - "id": 34, - "name": "joinPush", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 201, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L201" - } - ], - "getSignature": { - "id": 35, - "name": "joinPush", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 201, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L201" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/push.js", - "qualifiedName": "default" - }, - "name": "Push", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 36, - "name": "rejoinTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 205, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L205" - } - ], - "getSignature": { - "id": 37, - "name": "rejoinTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 205, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L205" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 26, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 185, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L185" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 189, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L189" - } - ], - "getSignature": { - "id": 27, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 185, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L185" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - }, - "setSignature": { - "id": 28, - "name": "state", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 189, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L189" - } - ], - "parameters": [ - { - "id": 29, - "name": "state", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 32, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 197, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L197" - } - ], - "getSignature": { - "id": 33, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 197, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L197" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 369, - "name": "copyBindings", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 1099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L1099" - } - ], - "signatures": [ - { - "id": 370, - "name": "copyBindings", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 1099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L1099" - } - ], - "parameters": [ - { - "id": 371, - "name": "other", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 305, - "name": "httpSend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 764, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L764" - } - ], - "signatures": [ - { - "id": 306, - "name": "httpSend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a broadcast message explicitly via REST API.\n\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\n\nPayloads that are " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`ArrayBufferView`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`Uint8Array`" - }, - { - "kind": "text", - "text": ") are sent as\n" - }, - { - "kind": "code", - "text": "`application/octet-stream`" - }, - { - "kind": "text", - "text": "; all other payloads are JSON-encoded." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise resolving to object with success status, and error details if failed" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 764, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L764" - } - ], - "parameters": [ - { - "id": 307, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the broadcast event" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 308, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent (required)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 309, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options including timeout" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 311, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 767, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L767" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [311] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 767, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L767" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 312, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 313, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [313] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 314, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 317, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 316, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 315, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [317, 316, 315] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 86, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listen to realtime events on this channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, Broadcast and Presence are enabled for all projects.\n- By default, listening to database changes is disabled for new projects due to database performance and security concerns. You can turn it on by managing Realtime's [replication](/docs/guides/api#realtime-api-overview).\n- You can receive the \"previous\" data for updates and deletes by setting the table's " - }, - { - "kind": "code", - "text": "`REPLICA IDENTITY`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`FULL`" - }, - { - "kind": "text", - "text": " (e.g., " - }, - { - "kind": "code", - "text": "`ALTER TABLE your_table REPLICA IDENTITY FULL;`" - }, - { - "kind": "text", - "text": ").\n- Row level security is not applied to delete statements. When RLS is enabled and replica identity is set to full, only the primary key is sent to clients." - } - ] - }, - { - "tag": "@example", - "name": "Listen to broadcast messages", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel(\"room1\")\n\nchannel.on(\"broadcast\", { event: \"cursor-pos\" }, (payload) => {\n console.log(\"Cursor position received!\", payload);\n}).subscribe((status) => {\n if (status === \"SUBSCRIBED\") {\n channel.send({\n type: \"broadcast\",\n event: \"cursor-pos\",\n payload: { x: Math.random(), y: Math.random() },\n });\n }\n});\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence sync", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'sync' }, () => {\n console.log('Synced presence state: ', channel.presenceState())\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence join", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'join' }, ({ newPresences }) => {\n console.log('Newly joined presences: ', newPresences)\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence leave", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'leave' }, ({ leftPresences }) => {\n console.log('Newly left presences: ', leftPresences)\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n await channel.untrack()\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to all database changes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: '*', schema: '*' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to a specific table", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: '*', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to inserts", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to updates\nBy default, Supabase will send only the updated record. If you want to receive the previous values as well you can\nenable full replication for the table you are listening to:\n\n" - }, - { - "kind": "code", - "text": "```sql\nalter table \"your_table\" replica identity full;\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to updates", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to deletes\nBy default, Supabase does not send deleted records. If you want to receive the deleted record you can\nenable full replication for the table you are listening to:\n\n" - }, - { - "kind": "code", - "text": "```sql\nalter table \"your_table\" replica identity full;\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to deletes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to multiple events\nYou can chain listeners if you want to listen to multiple events for each table." - } - ] - }, - { - "tag": "@example", - "name": "Listen to multiple events", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, handleRecordInserted)\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, handleRecordDeleted)\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to row level changes\nYou can listen to individual rows using the format " - }, - { - "kind": "code", - "text": "`{table}:{col}=eq.{val}`" - }, - { - "kind": "text", - "text": " - where " - }, - { - "kind": "code", - "text": "`{col}`" - }, - { - "kind": "text", - "text": " is the column name, and " - }, - { - "kind": "code", - "text": "`{val}`" - }, - { - "kind": "text", - "text": " is the value which you want to match." - } - ] - }, - { - "tag": "@example", - "name": "Listen to row level changes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries', filter: 'id=eq.200' }, handleRecordUpdated)\n .subscribe()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L453" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 504, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L504" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 530, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L530" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 730, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L730" - } - ], - "signatures": [ - { - "id": 87, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L453" - } - ], - "parameters": [ - { - "id": 88, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 89, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 90, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 91, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 455, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L455" - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [91] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 455, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L455" - } - ] - } - } - }, - { - "id": 92, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 456, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L456" - } - ], - "signatures": [ - { - "id": 94, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 456, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 95, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "typeParameters": [ - { - "id": 96, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 97, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "indexSignatures": [ - { - "id": 98, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "parameters": [ - { - "id": 99, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 100, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 101, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 102, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 103, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 460, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L460" - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [103] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 460, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L460" - } - ] - } - } - }, - { - "id": 104, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 461, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L461" - } - ], - "signatures": [ - { - "id": 106, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 461, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L461" - } - ], - "parameters": [ - { - "id": 107, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 662, - "typeArguments": [ - { - "type": "reference", - "target": 96, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 108, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "typeParameters": [ - { - "id": 109, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 110, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "indexSignatures": [ - { - "id": 111, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "parameters": [ - { - "id": 112, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 113, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 114, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 116, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 465, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L465" - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [116] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 465, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L465" - } - ] - } - } - }, - { - "id": 117, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 466, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L466" - } - ], - "signatures": [ - { - "id": 119, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 466, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L466" - } - ], - "parameters": [ - { - "id": 120, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 672, - "typeArguments": [ - { - "type": "reference", - "target": 109, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 121, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "typeParameters": [ - { - "id": 122, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "indexSignatures": [ - { - "id": 124, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "parameters": [ - { - "id": 125, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 126, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 127, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 128, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 129, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 470, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L470" - } - ], - "type": { - "type": "literal", - "value": "*" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [129] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 470, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L470" - } - ] - } - } - }, - { - "id": 130, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 471, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L471" - } - ], - "signatures": [ - { - "id": 132, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 471, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L471" - } - ], - "parameters": [ - { - "id": 133, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 662, - "typeArguments": [ - { - "type": "reference", - "target": 122, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 672, - "typeArguments": [ - { - "type": "reference", - "target": 122, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 134, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "typeParameters": [ - { - "id": 135, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "indexSignatures": [ - { - "id": 137, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "parameters": [ - { - "id": 138, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 139, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 140, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 141, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 142, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 476, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L476" - } - ], - "signatures": [ - { - "id": 143, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 476, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L476" - } - ], - "parameters": [ - { - "id": 144, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 628, - "typeArguments": [ - { - "type": "reference", - "target": 135, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 145, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "typeParameters": [ - { - "id": 146, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 147, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "indexSignatures": [ - { - "id": 148, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "parameters": [ - { - "id": 149, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 151, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 152, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 481, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L481" - } - ], - "signatures": [ - { - "id": 154, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 481, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L481" - } - ], - "parameters": [ - { - "id": 155, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 633, - "typeArguments": [ - { - "type": "reference", - "target": 146, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 156, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "typeParameters": [ - { - "id": 157, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 158, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "indexSignatures": [ - { - "id": 159, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "parameters": [ - { - "id": 160, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 161, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 162, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 163, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 164, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 486, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L486" - } - ], - "signatures": [ - { - "id": 165, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 486, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L486" - } - ], - "parameters": [ - { - "id": 166, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 643, - "typeArguments": [ - { - "type": "reference", - "target": 157, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 167, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "typeParameters": [ - { - "id": 168, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 169, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "indexSignatures": [ - { - "id": 170, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "parameters": [ - { - "id": 171, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 172, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 173, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 174, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 491, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L491" - } - ], - "signatures": [ - { - "id": 176, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 491, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L491" - } - ], - "parameters": [ - { - "id": 177, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 652, - "typeArguments": [ - { - "type": "reference", - "target": 168, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 178, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "typeParameters": [ - { - "id": 179, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "indexSignatures": [ - { - "id": 181, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "parameters": [ - { - "id": 182, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 183, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 184, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INSERT" - }, - { - "type": "literal", - "value": "UPDATE" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "*" - } - ] - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 185, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 496, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L496" - } - ], - "signatures": [ - { - "id": 187, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 496, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L496" - } - ], - "parameters": [ - { - "id": 188, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 628, - "typeArguments": [ - { - "type": "reference", - "target": 179, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 189, - "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": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 504, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L504" - } - ], - "parameters": [ - { - "id": 190, - "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": 191, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 193, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 506, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L506" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [193] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 506, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L506" - } - ] - } - } - }, - { - "id": 194, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function to be invoked when event handler is triggered." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 195, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "signatures": [ - { - "id": 196, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "parameters": [ - { - "id": 197, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 198, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 200, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 509, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L509" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 201, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 510, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L510" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 202, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 204, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 512, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 203, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 511, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L511" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [204, 203] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 510, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L510" - } - ] - } - } - }, - { - "id": 199, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 508, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L508" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [200, 201, 199] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "indexSignatures": [ - { - "id": 205, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 514, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L514" - } - ], - "parameters": [ - { - "id": 206, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 207, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "typeParameters": [ - { - "id": 208, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 209, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "indexSignatures": [ - { - "id": 210, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "parameters": [ - { - "id": 211, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 212, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 213, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 214, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 215, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 519, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L519" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [215] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 519, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L519" - } - ] - } - } - }, - { - "id": 216, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 217, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ], - "signatures": [ - { - "id": 218, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ], - "parameters": [ - { - "id": 219, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 220, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 222, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 522, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L522" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 223, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 523, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L523" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 226, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 525, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L525" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 524, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L524" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [226, 225] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 523, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L523" - } - ] - } - } - }, - { - "id": 227, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 527, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L527" - } - ], - "type": { - "type": "reference", - "target": 208, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 221, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 521, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L521" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [222, 223, 227, 221] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 228, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 530, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L530" - } - ], - "typeParameters": [ - { - "id": 229, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 230, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 231, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 232, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 233, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 532, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L532" - } - ], - "type": { - "type": "reference", - "target": 699, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [233] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 532, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L532" - } - ] - } - } - }, - { - "id": 234, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 235, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ], - "signatures": [ - { - "id": 236, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ], - "parameters": [ - { - "id": 237, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 238, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 240, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 535, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L535" - } - ], - "type": { - "type": "reference", - "target": 699, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - }, - { - "id": 241, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 536, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L536" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 229, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 239, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 534, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L534" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [240, 241, 239] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 242, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "typeParameters": [ - { - "id": 243, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 244, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "indexSignatures": [ - { - "id": 245, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "parameters": [ - { - "id": 246, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 247, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 248, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 249, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 250, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 541, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L541" - } - ], - "type": { - "type": "reference", - "target": 700, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [250] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 541, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L541" - } - ] - } - } - }, - { - "id": 251, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 252, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ], - "signatures": [ - { - "id": 253, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ], - "parameters": [ - { - "id": 254, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 257, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 544, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L544" - } - ], - "type": { - "type": "reference", - "target": 700, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - }, - { - "id": 258, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 545, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L545" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastInsertPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 243, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastInsertPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 256, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 543, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L543" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [257, 258, 256] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 259, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "typeParameters": [ - { - "id": 260, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "indexSignatures": [ - { - "id": 262, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "parameters": [ - { - "id": 263, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 264, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 265, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 266, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 267, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 550, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L550" - } - ], - "type": { - "type": "reference", - "target": 701, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [267] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 550, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L550" - } - ] - } - } - }, - { - "id": 268, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 269, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ], - "signatures": [ - { - "id": 270, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ], - "parameters": [ - { - "id": 271, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 272, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 274, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 553, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L553" - } - ], - "type": { - "type": "reference", - "target": 701, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - }, - { - "id": 275, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 554, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L554" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastUpdatePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 260, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastUpdatePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 273, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 552, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L552" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [274, 275, 273] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 276, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "typeParameters": [ - { - "id": 277, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 278, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "indexSignatures": [ - { - "id": 279, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "parameters": [ - { - "id": 280, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 281, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 282, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 283, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 284, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 559, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L559" - } - ], - "type": { - "type": "reference", - "target": 702, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [284] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 559, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L559" - } - ] - } - } - }, - { - "id": 285, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 286, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ], - "signatures": [ - { - "id": 287, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ], - "parameters": [ - { - "id": 288, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 289, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 291, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 562, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L562" - } - ], - "type": { - "type": "reference", - "target": 702, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - }, - { - "id": 292, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 563, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L563" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastDeletePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 277, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastDeletePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 290, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 561, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L561" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [291, 292, 290] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 293, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "typeParameters": [ - { - "id": 294, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 295, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "indexSignatures": [ - { - "id": 296, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "parameters": [ - { - "id": 297, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 298, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 299, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 300, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 301, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 302, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 569, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L569" - } - ], - "signatures": [ - { - "id": 303, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 569, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L569" - } - ], - "parameters": [ - { - "id": 304, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 63, - "name": "presenceState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "signatures": [ - { - "id": 64, - "name": "presenceState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current presence state for this channel.\n\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\ntracked metadata for that user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "typeParameters": [ - { - "id": 65, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 66, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "indexSignatures": [ - { - "id": 67, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "parameters": [ - { - "id": 68, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "target": 682, - "typeArguments": [ - { - "type": "reference", - "target": 65, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 318, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 863, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L863" - } - ], - "signatures": [ - { - "id": 319, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a message into the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- When using REST you don't need to subscribe to the channel\n- REST calls are only available from 2.37.0 onwards\n- If you create a channel only to send a REST broadcast, remove it from\n the client when the send completes" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via websocket", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\nchannel.subscribe((status) => {\n if (status === 'SUBSCRIBED') {\n channel.send({\n type: 'broadcast',\n event: 'cursor-pos',\n payload: { x: Math.random(), y: Math.random() },\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Send a message via websocket\n" - }, - { - "kind": "code", - "text": "```js\nok | timed out | error\n```" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via REST", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\ntry {\n await channel.httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\n} finally {\n await supabase.removeChannel(channel)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 863, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L863" - } - ], - "parameters": [ - { - "id": 320, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arguments to send to channel" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 323, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event being sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 866, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L866" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 324, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 867, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L867" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 322, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of event to send" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 865, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L865" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [323, 324, 322] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 864, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L864" - } - ], - "indexSignatures": [ - { - "id": 325, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 868, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L868" - } - ], - "parameters": [ - { - "id": 326, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 327, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options to be used during the send process" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 328, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 870, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L870" - } - ], - "indexSignatures": [ - { - "id": 329, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 870, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L870" - } - ], - "parameters": [ - { - "id": 330, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 41, - "name": "subscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L292" - } - ], - "signatures": [ - { - "id": 42, - "name": "subscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Subscribe registers your client with the server.\n\nThe optional " - }, - { - "kind": "code", - "text": "`callback`" - }, - { - "kind": "text", - "text": " receives a " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and, on failure, an " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " argument.\nLog the full " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " so its " - }, - { - "kind": "code", - "text": "`cause`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", and any structured fields aren't hidden\nbehind " - }, - { - "kind": "code", - "text": "`err.message`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.channel('room1').subscribe((status, err) => {\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\n // Log the full error: its `cause` often holds the underlying reason.\n console.error(status, err)\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L292" - } - ], - "parameters": [ - { - "id": 43, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 44, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 293, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L293" - } - ], - "signatures": [ - { - "id": 45, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 293, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L293" - } - ], - "parameters": [ - { - "id": 46, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 707, - "name": "REALTIME_SUBSCRIBE_STATES", - "package": "@supabase/realtime-js" - } - }, - { - "id": 47, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 48, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 337, - "name": "teardown", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L971" - } - ], - "signatures": [ - { - "id": 338, - "name": "teardown", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Destroys and stops related timers." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L971" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 70, - "name": "track", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 421, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L421" - } - ], - "signatures": [ - { - "id": 71, - "name": "track", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends the supplied payload to the presence tracker so other subscribers can see that this\nclient is online. Use " - }, - { - "kind": "code", - "text": "`untrack`" - }, - { - "kind": "text", - "text": " to stop broadcasting presence for the same key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 421, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L421" - } - ], - "parameters": [ - { - "id": 72, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 422, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L422" - } - ], - "indexSignatures": [ - { - "id": 74, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 422, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L422" - } - ], - "parameters": [ - { - "id": 75, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 76, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 77, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 423, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L423" - } - ], - "indexSignatures": [ - { - "id": 78, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 423, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L423" - } - ], - "parameters": [ - { - "id": 79, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 334, - "name": "unsubscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 956, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L956" - } - ], - "signatures": [ - { - "id": 335, - "name": "unsubscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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!\") )" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 956, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L956" - } - ], - "parameters": [ - { - "id": 336, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 80, - "name": "untrack", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "signatures": [ - { - "id": 81, - "name": "untrack", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes the current presence state for this client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "parameters": [ - { - "id": 82, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "indexSignatures": [ - { - "id": 84, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "parameters": [ - { - "id": 85, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 331, - "name": "updateJoinPayload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L941" - } - ], - "signatures": [ - { - "id": 332, - "name": "updateJoinPayload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the payload that will be sent the next time the channel joins (reconnects).\nUseful for rotating access tokens or updating config without re-creating the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L941" - } - ], - "parameters": [ - { - "id": 333, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [15] - }, - { - "title": "Properties", - "children": [20, 22, 39, 24, 23, 40, 21, 38] - }, - { - "title": "Accessors", - "children": [30, 34, 36, 26, 32] - }, - { - "title": "Methods", - "children": [369, 305, 86, 63, 318, 41, 337, 70, 334, 80, 331] - } - ], - "categories": [ - { - "title": "Other", - "children": [20, 22, 39, 24, 23, 40, 21, 38, 30, 34, 36, 26, 32, 369] - }, - { - "title": "Realtime", - "children": [15, 305, 86, 63, 318, 41, 337, 70, 334, 80, 331] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 176, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L176" - } - ] - }, - { - "id": 396, - "name": "RealtimeClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 397, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L277" - } - ], - "signatures": [ - { - "id": 398, - "name": "RealtimeClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the Socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nclient.connect()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L277" - } - ], - "parameters": [ - { - "id": 399, - "name": "endPoint", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 400, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 573, - "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": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future." - } - ], - "heartbeatIntervalMs": [ - { - "kind": "text", - "text": "The millisec interval to send a heartbeat message." - } - ], - "heartbeatCallback": [ - { - "kind": "text", - "text": "The optional function to handle heartbeat status and latency." - } - ], - "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." - } - ], - "vsn": [ - { - "kind": "text", - "text": "The protocol version to use when connecting. Supported versions are \"1.0.0\" and \"2.0.0\". Defaults to \"2.0.0\"." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 404, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 405, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "signatures": [ - { - "id": 406, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 403, - "name": "accessTokenValue", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L140" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 407, - "name": "apiKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L142" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 402, - "name": "channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L138" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - "defaultValue": "..." - }, - { - "id": 419, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L153" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 420, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 421, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 422, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 423, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 424, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 425, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 426, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 409, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "headers cannot be set on websocket connections" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "indexSignatures": [ - { - "id": 411, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "parameters": [ - { - "id": 412, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 408, - "name": "httpEndpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L144" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 418, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L151" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 413, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 414, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "indexSignatures": [ - { - "id": 415, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "parameters": [ - { - "id": 416, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 417, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 149, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L149" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 430, - "name": "serializer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L158" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/serializer.ts", - "qualifiedName": "default" - }, - "name": "Serializer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - }, - "defaultValue": "..." - }, - { - "id": 427, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 154, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L154" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 429, - "name": "workerRef", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L156" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Worker" - }, - "name": "Worker", - "package": "typescript" - } - }, - { - "id": 428, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L155" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "decode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 206, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L206" - } - ], - "getSignature": { - "id": 452, - "name": "decode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 206, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L206" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 449, - "name": "encode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 202, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L202" - } - ], - "getSignature": { - "id": 450, - "name": "encode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 202, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L202" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 431, - "name": "endPoint", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L160" - } - ], - "getSignature": { - "id": 432, - "name": "endPoint", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L160" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 437, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L172" - } - ], - "getSignature": { - "id": 438, - "name": "heartbeatCallback", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L172" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 439, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 176, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L176" - } - ], - "getSignature": { - "id": 440, - "name": "heartbeatIntervalMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 176, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L176" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 441, - "name": "heartbeatTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 180, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L180" - } - ], - "getSignature": { - "id": 442, - "name": "heartbeatTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 180, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L180" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "HeartbeatTimer" - }, - "name": "HeartbeatTimer", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 443, - "name": "pendingHeartbeatRef", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 187, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L187" - } - ], - "getSignature": { - "id": 444, - "name": "pendingHeartbeatRef", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 187, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L187" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 453, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 210, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L210" - } - ], - "getSignature": { - "id": 454, - "name": "reconnectAfterMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 210, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L210" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 455, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 74, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L74" - } - ], - "signatures": [ - { - "id": 456, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 74, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L74" - } - ], - "parameters": [ - { - "id": 457, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - } - }, - { - "id": 445, - "name": "reconnectTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L194" - } - ], - "getSignature": { - "id": 446, - "name": "reconnectTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L194" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 458, - "name": "sendBuffer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 214, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L214" - } - ], - "getSignature": { - "id": 459, - "name": "sendBuffer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 214, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L214" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 78, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L78" - } - ], - "signatures": [ - { - "id": 461, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 78, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - } - }, - { - "id": 462, - "name": "stateChangeCallbacks", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ], - "getSignature": { - "id": 463, - "name": "stateChangeCallbacks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 464, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 466, - "name": "close", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 220, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L220" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 467, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 221, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L221" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 468, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 222, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L222" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 465, - "name": "open", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 219, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L219" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [466, 467, 468, 465] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ] - } - } - } - }, - { - "id": 433, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L164" - } - ], - "getSignature": { - "id": 434, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L164" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 435, - "name": "transport", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L168" - } - ], - "getSignature": { - "id": 436, - "name": "transport", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L168" - } - ], - "type": { - "type": "reference", - "target": 782, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 447, - "name": "vsn", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 198, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L198" - } - ], - "getSignature": { - "id": 448, - "name": "vsn", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 198, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L198" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Vsn" - }, - "name": "Vsn", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 503, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L469" - } - ], - "signatures": [ - { - "id": 504, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates (or reuses) a " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RealtimeChannel", - "target": 10 - }, - { - "kind": "text", - "text": " for the provided topic.\n\nTopics are automatically prefixed with " - }, - { - "kind": "code", - "text": "`realtime:`" - }, - { - "kind": "text", - "text": " to match the Realtime service.\nIf a channel with the same topic already exists it will be returned instead of creating\na duplicate connection." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L469" - } - ], - "parameters": [ - { - "id": 505, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 506, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 475, - "name": "connect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L297" - } - ], - "signatures": [ - { - "id": 476, - "name": "connect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Connects the socket, unless already connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L297" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 495, - "name": "connectionState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 429, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L429" - } - ], - "signatures": [ - { - "id": 496, - "name": "connectionState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current state of the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 429, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L429" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "ConnectionState" - }, - "name": "ConnectionState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 479, - "name": "disconnect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 356, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L356" - } - ], - "signatures": [ - { - "id": 480, - "name": "disconnect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Disconnects the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 356, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L356" - } - ], - "parameters": [ - { - "id": 481, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A numeric status code to send on disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 482, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom reason for the disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timeout" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 477, - "name": "endpointURL", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L344" - } - ], - "signatures": [ - { - "id": 478, - "name": "endpointURL", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the URL of the websocket." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "string The URL of the websocket." - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L344" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 483, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L376" - } - ], - "signatures": [ - { - "id": 484, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all created channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L376" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 497, - "name": "isConnected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 438, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L438" - } - ], - "signatures": [ - { - "id": 498, - "name": "isConnected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " is the connection is open." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 438, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L438" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 499, - "name": "isConnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 447, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L447" - } - ], - "signatures": [ - { - "id": 500, - "name": "isConnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently connecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 447, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L447" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 501, - "name": "isDisconnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L456" - } - ], - "signatures": [ - { - "id": 502, - "name": "isDisconnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently disconnecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 490, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L420" - } - ], - "signatures": [ - { - "id": 491, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " - }, - { - "kind": "code", - "text": "`this.logger`" - }, - { - "kind": "text", - "text": " can be overridden in Client constructor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L420" - } - ], - "parameters": [ - { - "id": 492, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 493, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 494, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 517, - "name": "onHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L550" - } - ], - "signatures": [ - { - "id": 518, - "name": "onHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets a callback that receives lifecycle events for internal heartbeat messages.\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L550" - } - ], - "parameters": [ - { - "id": 519, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 507, - "name": "push", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L491" - } - ], - "signatures": [ - { - "id": 508, - "name": "push", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L491" - } - ], - "parameters": [ - { - "id": 509, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 614, - "name": "RealtimeMessage", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 488, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 401, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L401" - } - ], - "signatures": [ - { - "id": 489, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down all channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 401, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L401" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 691, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 485, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L386" - } - ], - "signatures": [ - { - "id": 486, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down a single channel" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L386" - } - ], - "parameters": [ - { - "id": 487, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A RealtimeChannel instance" - } - ] - }, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 691, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 515, - "name": "sendHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 540, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L540" - } - ], - "signatures": [ - { - "id": 516, - "name": "sendHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a heartbeat message if the socket is connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 540, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L540" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 510, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 517, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L517" - } - ], - "signatures": [ - { - "id": 511, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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.\n\nWhen a token is explicitly provided, it will be preserved across channel operations\n(including removeChannel and resubscribe). The " - }, - { - "kind": "code", - "text": "`accessToken`" - }, - { - "kind": "text", - "text": " callback will not be\ninvoked until " - }, - { - "kind": "code", - "text": "`setAuth()`" - }, - { - "kind": "text", - "text": " is called without arguments." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nSetting the authorization header\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\nclient.realtime.setAuth('my-custom-jwt')\n\n// Switch back to using the accessToken callback\nclient.realtime.setAuth()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 517, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L517" - } - ], - "parameters": [ - { - "id": 512, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A JWT string to override the token set on the client." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [397] - }, - { - "title": "Properties", - "children": [404, 403, 407, 402, 419, 409, 408, 418, 413, 417, 430, 427, 429, 428] - }, - { - "title": "Accessors", - "children": [451, 449, 431, 437, 439, 441, 443, 453, 445, 458, 462, 433, 435, 447] - }, - { - "title": "Methods", - "children": [ - 503, 475, 495, 479, 477, 483, 497, 499, 501, 490, 517, 507, 488, 485, 515, 510 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 404, 403, 407, 402, 419, 409, 408, 418, 413, 417, 430, 427, 429, 428, 451, 449, 431, - 437, 439, 441, 443, 453, 445, 458, 462, 433, 435, 447 - ] - }, - { - "title": "Realtime", - "children": [ - 397, 503, 475, 495, 479, 477, 483, 497, 499, 501, 490, 517, 507, 488, 485, 515, 510 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 135, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L135" - } - ] - }, - { - "id": 1, - "name": "RealtimePresence", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L65" - } - ], - "signatures": [ - { - "id": 3, - "name": "RealtimePresence", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Presence helper that keeps the local presence state in sync with the server." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example for a presence channel", - "content": [ - { - "kind": "code", - "text": "```ts\nconst presence = new RealtimePresence(channel)\n\nchannel.on('presence', ({ event, key }) => {\n console.log(`Presence ${event} on ${key}`)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L65" - } - ], - "parameters": [ - { - "id": 4, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 5, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom event names, e.g. " - }, - { - "kind": "code", - "text": "`{ events: { state: 'state', diff: 'diff' } }`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceOptions" - }, - "name": "RealtimePresenceOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 9, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 66, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L66" - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 6, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 42, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L42" - } - ], - "getSignature": { - "id": 7, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 42, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L42" - } - ], - "type": { - "type": "reference", - "target": 682, - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [9] - }, - { - "title": "Accessors", - "children": [6] - } - ], - "categories": [ - { - "title": "Other", - "children": [9, 6] - }, - { - "title": "Realtime", - "children": [2] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 41, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L41" - } - ] - }, - { - "id": 719, - "name": "WebSocketFactory", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Utilities for creating WebSocket instances across runtimes." - } - ] - }, - "children": [ - { - "id": 722, - "name": "getWebSocketConstructor", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 169, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L169" - } - ], - "signatures": [ - { - "id": 723, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the best available WebSocket constructor for the current runtime." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example with error handling", - "content": [ - { - "kind": "code", - "text": "```ts\ntry {\n const WS = WebSocketFactory.getWebSocketConstructor()\n const socket = new WS('wss://example.com/socket')\n} catch (error) {\n console.error('WebSocket not available in this environment.', error)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 169, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L169" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 724, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26772, - "character": 23 - } - ], - "signatures": [ - { - "id": 725, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26774, - "character": 4 - } - ], - "parameters": [ - { - "id": 726, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 727, - "name": "protocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" - }, - "name": "WebSocket", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 728, - "name": "isWebSocketSupported", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 194, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L194" - } - ], - "signatures": [ - { - "id": 729, - "name": "isWebSocketSupported", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detects whether the runtime can establish WebSocket connections." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example in a Node.js script", - "content": [ - { - "kind": "code", - "text": "```ts\nif (!WebSocketFactory.isWebSocketSupported()) {\n console.error('WebSockets are required for this script.')\n process.exitCode = 1\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 194, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L194" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [722, 728] - } - ], - "categories": [ - { - "title": "Realtime", - "children": [722, 728] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 61, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L61" - } - ] - }, - { - "id": 732, - "name": "WebSocketLike", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 775, - "name": "binaryType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L34" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 776, - "name": "bufferedAmount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L35" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 736, - "name": "CLOSED", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 5, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L5" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 735, - "name": "CLOSING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 4, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L4" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 733, - "name": "CONNECTING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 2, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L2" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 778, - "name": "dispatchEvent", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "signatures": [ - { - "id": 780, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "parameters": [ - { - "id": 781, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - }, - { - "id": 777, - "name": "extensions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 757, - "name": "onclose", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 758, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "signatures": [ - { - "id": 759, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "parameters": [ - { - "id": 760, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 761, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "CloseEvent" - }, - "name": "CloseEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 762, - "name": "onerror", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 763, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "signatures": [ - { - "id": 764, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "parameters": [ - { - "id": 765, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 766, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 752, - "name": "onmessage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 753, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "signatures": [ - { - "id": 754, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "parameters": [ - { - "id": 755, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 756, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "MessageEvent" - }, - "name": "MessageEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 747, - "name": "onopen", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 748, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "signatures": [ - { - "id": 749, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "parameters": [ - { - "id": 750, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 751, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 734, - "name": "OPEN", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 3, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L3" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 739, - "name": "protocol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 8, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L8" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 737, - "name": "readyState", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 6, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L6" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 738, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 7, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L7" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 767, - "name": "addEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L27" - } - ], - "signatures": [ - { - "id": 768, - "name": "addEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registers an event listener on the socket (compatible with browser WebSocket API)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L27" - } - ], - "parameters": [ - { - "id": 769, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 770, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 740, - "name": "close", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L13" - } - ], - "signatures": [ - { - "id": 741, - "name": "close", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Closes the socket, optionally providing a close code and reason." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L13" - } - ], - "parameters": [ - { - "id": 742, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 743, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 771, - "name": "removeEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L31" - } - ], - "signatures": [ - { - "id": 772, - "name": "removeEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a previously registered event listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L31" - } - ], - "parameters": [ - { - "id": 773, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 774, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 744, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L17" - } - ], - "signatures": [ - { - "id": 745, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends data through the socket using the underlying implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L17" - } - ], - "parameters": [ - { - "id": 746, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [775, 776, 736, 735, 733, 778, 777, 757, 762, 752, 747, 734, 739, 737, 738] - }, - { - "title": "Methods", - "children": [767, 740, 771, 744] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 1, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L1" - } - ] - }, - { - "id": 782, - "name": "WebSocketLikeConstructor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal WebSocket constructor interface that RealtimeClient can work with.\nSupply a compatible implementation (native WebSocket, " - }, - { - "kind": "code", - "text": "`ws`" - }, - { - "kind": "text", - "text": ", etc) when running outside the browser." - } - ] - }, - "children": [ - { - "id": 783, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 58, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L58" - } - ], - "signatures": [ - { - "id": 784, - "name": "WebSocketLikeConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 59, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L59" - } - ], - "parameters": [ - { - "id": 785, - "name": "address", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 786, - "name": "subprotocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 732, - "name": "WebSocketLike", - "package": "@supabase/realtime-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [783] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 58, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L58" - } - ], - "indexSignatures": [ - { - "id": 787, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 61, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L61" - } - ], - "parameters": [ - { - "id": 788, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 380, - "name": "RealtimeChannelOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L22" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 381, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 382, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L23" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 383, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 384, - "name": "broadcast", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received\nreplay option instructs server to replay broadcast messages" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 387, - "name": "ack", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 388, - "name": "replay", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "ReplayOption" - }, - "name": "ReplayOption", - "package": "@supabase/realtime-js" - } - }, - { - "id": 386, - "name": "self", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [387, 388, 386] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ] - } - } - }, - { - "id": 389, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "key option is used to track presence payload across clients" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 392, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 391, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [392, 391] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ] - } - } - }, - { - "id": 393, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "defines if the channel is private or not and if RLS policies will be used to check data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [384, 389, 393] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 23, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L23" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [382] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 22, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L22" - } - ] - } - } - }, - { - "id": 394, - "name": "RealtimeChannelSendResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 128, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L128" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 395, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 128, - "character": 83, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L128" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 573, - "name": "RealtimeClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 64, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L64" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 574, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 609, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 610, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 82, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L82" - } - ], - "signatures": [ - { - "id": 611, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 591, - "name": "decode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 72, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L72" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - }, - { - "id": 612, - "name": "disconnectOnEmptyChannelsAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 590, - "name": "encode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 71, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L71" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - }, - { - "id": 606, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L79" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/realtime-js" - } - }, - { - "id": 596, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 597, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "indexSignatures": [ - { - "id": 598, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "parameters": [ - { - "id": 599, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 578, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 68, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L68" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 579, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 68, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L68" - } - ], - "signatures": [ - { - "id": 580, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 581, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "HeartbeatStatus" - }, - "name": "HeartbeatStatus", - "package": "@supabase/realtime-js" - } - }, - { - "id": 582, - "name": "latency", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 577, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 604, - "name": "log_level", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 77, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 584, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 70, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L70" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 585, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 70, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L70" - } - ], - "signatures": [ - { - "id": 586, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 587, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 588, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 589, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 605, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 78, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L78" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 600, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 601, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "indexSignatures": [ - { - "id": 602, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "parameters": [ - { - "id": 603, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 592, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L73" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 593, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 73, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L73" - } - ], - "signatures": [ - { - "id": 594, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 595, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - }, - { - "id": 613, - "name": "sessionStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage compatible object used by the underlying socket for longpoll fallback history.\nProvide a custom implementation in environments where reading " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": "\nthrows (sandboxed iframes, in-app webviews, \"block third-party storage\" privacy modes).\nDefaults to " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": " when accessible, otherwise an in-memory store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L90" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - } - }, - { - "id": 576, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 66, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L66" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 575, - "name": "transport", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L65" - } - ], - "type": { - "type": "reference", - "target": 782, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - }, - { - "id": 583, - "name": "vsn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 69, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L69" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 607, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 80, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 608, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 81, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L81" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 609, 591, 612, 590, 606, 596, 578, 577, 604, 584, 605, 600, 592, 613, 576, 575, 583, - 607, 608 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 64, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L64" - } - ] - } - } - }, - { - "id": 614, - "name": "RealtimeMessage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 32, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L32" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 617, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L34" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 620, - "name": "join_ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 618, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L35" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 619, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 616, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [617, 620, 618, 619, 616] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 32, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L32" - } - ] - } - } - }, - { - "id": 621, - "name": "RealtimePostgresChangesFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 109, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L109" - } - ], - "typeParameters": [ - { - "id": 627, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 698, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 623, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of database change to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L113" - } - ], - "type": { - "type": "reference", - "target": 627, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 626, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive database changes when filter is matched." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L125" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 624, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database schema to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 625, - "name": "table", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database table to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L121" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [623, 626, 624, 625] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 109, - "character": 99, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L109" - } - ] - } - } - }, - { - "id": 628, - "name": "RealtimePostgresChangesPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "typeParameters": [ - { - "id": 629, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "indexSignatures": [ - { - "id": 631, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "parameters": [ - { - "id": 632, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 633, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 643, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 652, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 652, - "name": "RealtimePostgresDeletePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "typeParameters": [ - { - "id": 658, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 659, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "indexSignatures": [ - { - "id": 660, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "parameters": [ - { - "id": 661, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 653, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 654, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 99, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L99" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 702, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 655, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 100, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L100" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 100, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L100" - } - ] - } - } - }, - { - "id": 657, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 101, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L101" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 658, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [654, 655, 657] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 98, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L98" - } - ] - } - } - ] - } - }, - { - "id": 633, - "name": "RealtimePostgresInsertPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "typeParameters": [ - { - "id": 639, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 640, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "indexSignatures": [ - { - "id": 641, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "parameters": [ - { - "id": 642, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 634, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 635, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 85, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L85" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 700, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 636, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 86, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L86" - } - ], - "type": { - "type": "reference", - "target": 639, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 637, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 87, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L87" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 638, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 87, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L87" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [635, 636, 637] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 84, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L84" - } - ] - } - } - ] - } - }, - { - "id": 643, - "name": "RealtimePostgresUpdatePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "typeParameters": [ - { - "id": 648, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "indexSignatures": [ - { - "id": 650, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "parameters": [ - { - "id": 651, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 644, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 645, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 92, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L92" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 701, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 646, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 93, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L93" - } - ], - "type": { - "type": "reference", - "target": 648, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 647, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 94, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L94" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 648, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [645, 646, 647] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 91, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L91" - } - ] - } - } - ] - } - }, - { - "id": 662, - "name": "RealtimePresenceJoinPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "typeParameters": [ - { - "id": 668, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 669, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 50, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "indexSignatures": [ - { - "id": 670, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "parameters": [ - { - "id": 671, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 663, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 666, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L20" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 668, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 664, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L18" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 705, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 665, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 667, - "name": "newPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L21" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 668, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [666, 664, 665, 667] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 76, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ] - } - } - }, - { - "id": 672, - "name": "RealtimePresenceLeavePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "typeParameters": [ - { - "id": 678, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 679, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "indexSignatures": [ - { - "id": 680, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "parameters": [ - { - "id": 681, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 673, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 676, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L27" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 678, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 674, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L25" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 706, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 675, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 677, - "name": "leftPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L28" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 678, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [676, 674, 675, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 77, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ] - } - } - }, - { - "id": 682, - "name": "RealtimePresenceState", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "typeParameters": [ - { - "id": 686, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 687, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "indexSignatures": [ - { - "id": 688, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "parameters": [ - { - "id": 689, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 690, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 75, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "indexSignatures": [ - { - "id": 684, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L14" - } - ], - "parameters": [ - { - "id": 685, - "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": 686, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ] - } - } - }, - { - "id": 691, - "name": "RealtimeRemoveChannelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 40, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L40" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 692, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 40, - "character": 85, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L40" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 712, - "name": "REALTIME_CHANNEL_STATES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 151, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L151" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 713, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 714, - "name": "closed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L33" - } - ], - "type": { - "type": "literal", - "value": "closed" - }, - "defaultValue": "'closed'" - }, - { - "id": 715, - "name": "errored", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L34" - } - ], - "type": { - "type": "literal", - "value": "errored" - }, - "defaultValue": "'errored'" - }, - { - "id": 716, - "name": "joined", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L35" - } - ], - "type": { - "type": "literal", - "value": "joined" - }, - "defaultValue": "'joined'" - }, - { - "id": 717, - "name": "joining", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L36" - } - ], - "type": { - "type": "literal", - "value": "joining" - }, - "defaultValue": "'joining'" - }, - { - "id": 718, - "name": "leaving", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L37" - } - ], - "type": { - "type": "literal", - "value": "leaving" - }, - "defaultValue": "'leaving'" - } - ], - "groups": [ - { - "title": "Properties", - "children": [714, 715, 716, 717, 718] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 32, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L32" - } - ] - } - }, - "defaultValue": "CHANNEL_STATES" - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [693, 698, 703, 707] - }, - { - "title": "Classes", - "children": [10, 396, 1, 719] - }, - { - "title": "Interfaces", - "children": [732, 782] - }, - { - "title": "Type Aliases", - "children": [380, 394, 573, 614, 621, 628, 652, 633, 643, 662, 672, 682, 691] - }, - { - "title": "Variables", - "children": [712] - } - ], - "packageName": "@supabase/realtime-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Realtime JS SDK

    \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
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/realtime-js)](https://www.npmjs.com/package/@supabase/realtime-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/realtime-js)](https://pkg.pr.new/~/supabase/realtime-js)\n\n
    \n\n# Overview\n\nThis SDK 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- 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## 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) => console.log(payload))\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 acknowledgment 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\n### Broadcast Replay\n\nBroadcast Replay enables **private** channels to access messages that were sent earlier. Only messages published via [Broadcast From the Database](https://supabase.com/docs/guides/realtime/broadcast#trigger-broadcast-messages-from-your-database) are available for replay.\n\nYou can configure replay with the following options:\n\n- **" - }, - { - "kind": "code", - "text": "`since`" - }, - { - "kind": "text", - "text": "** (Required): The epoch timestamp in milliseconds, specifying the earliest point from which messages should be retrieved.\n- **" - }, - { - "kind": "code", - "text": "`limit`" - }, - { - "kind": "text", - "text": "** (Optional): The number of messages to return. This must be a positive integer, with a maximum value of 25.\n\nExample:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst twelveHours = 12 * 60 * 60 * 1000\nconst twelveHoursAgo = Date.now() - twelveHours\n\nconst config = { private: true, broadcast: { replay: { since: twelveHoursAgo, limit: 10 } } }\n\nsupabase\n .channel('main:room', { config })\n .on('broadcast', { event: 'my_event' }, (payload) => {\n if (payload?.meta?.replayed) {\n console.log('This message was sent earlier:', payload)\n } else {\n console.log('This is a new message', payload)\n }\n // ...\n })\n .subscribe()\n```" - }, - { - "kind": "text", - "text": "\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('presence-test', {\n config: {\n presence: {\n key: '',\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(\n 'postgres_changes',\n { event: 'INSERT', schema: 'public', table: 'messages' },\n (payload) => {\n console.log('All inserts in messages table: ', payload)\n }\n)\n\nchannel.on(\n 'postgres_changes',\n { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' },\n (payload) => {\n console.log('All updates on users table when username is Realtime: ', payload)\n }\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.unsubscribe()\nclient.removeChannel(channel)\n```" - }, - { - "kind": "text", - "text": "\n\n- Remove all channels and close the connection\n\n" - }, - { - "kind": "code", - "text": "```js\n// Setup...\n\nclient.removeAllChannels()\nclient.disconnect()\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build realtime-js\n\n# Build with watch mode for development\npnpm nx build realtime-js --watch\n\n# Individual build targets\npnpm nx build:main realtime-js # CommonJS build (dist/main/)\npnpm nx build:module realtime-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx clean realtime-js # Clean build artifacts\npnpm nx lint realtime-js # Run ESLint\npnpm nx typecheck realtime-js # TypeScript type checking\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\nNote: Unlike some other packages, realtime-js doesn't include a UMD build since it's primarily used in Node.js or bundled applications.\n\n#### Validating Package Exports\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Check if package exports are correctly configured\npnpm nx check-exports realtime-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command uses [\"Are the types wrong?\"](https://github.com/arethetypeswrong/arethetypeswrong.github.io) to verify that the package exports work correctly in different environments. Run this before publishing to ensure your package can be imported correctly by all consumers.\n\n### Testing\n\n**No Docker or Supabase instance required!** The realtime-js tests use mocked WebSocket connections, so they're completely self-contained.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run unit tests (from monorepo root)\npnpm nx test realtime-js\n\n# Run tests with coverage report\npnpm nx test:coverage realtime-js\n\n# Run tests in watch mode during development\npnpm nx test:watch realtime-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Scripts Explained\n\n- **test** - Runs all unit tests once using Vitest\n- **test:coverage** - Runs tests and generates coverage report with terminal output\n- **test:watch** - Runs tests in interactive watch mode for development\n\nThe tests mock WebSocket connections using " - }, - { - "kind": "code", - "text": "`mock-socket`" - }, - { - "kind": "text", - "text": ", so you can run them anytime without any external dependencies.\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\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" - }, - "2": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.__constructor" - }, - "3": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "channel" - }, - "5": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "opts" - }, - "6": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "7": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "9": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.channel" - }, - "10": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "15": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.__constructor" - }, - "16": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "17": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "topic" - }, - "18": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "params" - }, - "19": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "socket" - }, - "20": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.bindings" - }, - "21": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subTopic" - }, - "22": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.broadcastEndpointURL" - }, - "23": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.private" - }, - "24": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presence" - }, - "26": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "27": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "28": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "29": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "state" - }, - "30": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "31": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "32": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "33": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "34": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "35": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "36": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "37": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "38": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.topic" - }, - "39": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.params" - }, - "40": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.socket" - }, - "41": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "42": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "43": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "44": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "45": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "46": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "status" - }, - "47": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "err" - }, - "48": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "63": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "64": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "65": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "66": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "67": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "69": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "71": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "72": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "73": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "74": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "76": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "77": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "78": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "80": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "81": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "82": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "83": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "84": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "86": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "87": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "88": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "89": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "90": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "91": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "92": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "93": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "95": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "96": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "97": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "98": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "100": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "101": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "102": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "103": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "104": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "105": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "106": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "107": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "108": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "109": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "110": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "111": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "113": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "114": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "115": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "116": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "117": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "118": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "119": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "120": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "121": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "122": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "123": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "124": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "126": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "127": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "128": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "129": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "130": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "131": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "132": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "133": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "134": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "135": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "136": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "137": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "139": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "140": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "141": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "142": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "143": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "144": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "145": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "146": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "147": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "148": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "150": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "151": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "152": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "153": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "154": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "155": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "156": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "157": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "158": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "159": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "161": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "162": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "163": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "164": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "165": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "166": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "167": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "168": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "169": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "170": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "172": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "173": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "174": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "175": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "176": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "177": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "178": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "179": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "180": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "181": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "183": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "184": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "185": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "186": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "187": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "188": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "189": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "190": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "191": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "192": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "193": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "194": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "195": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "196": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "197": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "198": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "199": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "200": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "201": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "202": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "203": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "204": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "205": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "207": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "208": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "209": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "210": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "212": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "213": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "214": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "215": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "216": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "217": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "218": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "219": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "220": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "221": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "222": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "223": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "224": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "225": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "226": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "227": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "228": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "229": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "230": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "231": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "232": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "233": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "234": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "235": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "236": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "237": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "238": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "239": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "240": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "241": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "242": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "243": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "244": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "245": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "247": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "248": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "249": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "250": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "251": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "252": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "253": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "254": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "255": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "256": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "257": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "258": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "259": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "260": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "261": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "262": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "264": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "265": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "266": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "267": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "268": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "269": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "270": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "271": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "272": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "273": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "274": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "275": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "276": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "277": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "278": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "279": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "281": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "282": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "283": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "284": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "285": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "286": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "287": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "288": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "289": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "290": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "291": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "292": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "293": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "294": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "295": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "296": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "298": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "299": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "300": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "301": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "302": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "303": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "304": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "305": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "306": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "307": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "event" - }, - "308": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "309": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "310": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "311": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.timeout" - }, - "312": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "313": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "314": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "315": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "316": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.status" - }, - "317": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.error" - }, - "318": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "319": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "320": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "args" - }, - "321": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "322": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "323": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "324": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "325": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "327": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "328": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "329": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "331": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "332": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "333": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "334": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "335": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "336": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "337": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "338": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "369": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "370": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "371": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "other" - }, - "380": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelOptions" - }, - "381": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "382": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.config" - }, - "383": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "384": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.broadcast" - }, - "385": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "386": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.self" - }, - "387": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.ack" - }, - "388": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replay" - }, - "389": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.presence" - }, - "390": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "391": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.key" - }, - "392": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.enabled" - }, - "393": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.private" - }, - "394": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelSendResponse" - }, - "395": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "396": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "397": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.__constructor" - }, - "398": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "399": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "endPoint" - }, - "400": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "options" - }, - "402": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channels" - }, - "403": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.accessTokenValue" - }, - "404": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.accessToken" - }, - "405": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "406": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "407": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.apiKey" - }, - "408": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.httpEndpoint" - }, - "409": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.headers" - }, - "410": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "411": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "413": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.params" - }, - "414": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "415": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "417": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.ref" - }, - "418": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.logLevel" - }, - "419": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.fetch" - }, - "420": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "421": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "422": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "423": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "424": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "425": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "426": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "427": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.worker" - }, - "428": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.workerUrl" - }, - "429": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.workerRef" - }, - "430": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.serializer" - }, - "431": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "432": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "433": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "434": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "435": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "436": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "437": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "438": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "439": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "440": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "441": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "442": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "443": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "444": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "445": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "446": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "447": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "448": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "449": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "450": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "451": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "452": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "453": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "454": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "455": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "456": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "457": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "tries" - }, - "458": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "459": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "460": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "461": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "462": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "463": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "464": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "465": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.open" - }, - "466": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.close" - }, - "467": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.error" - }, - "468": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.message" - }, - "475": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "476": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "477": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "478": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "479": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "480": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "481": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "code" - }, - "482": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "reason" - }, - "483": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "484": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "485": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "486": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "487": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "channel" - }, - "488": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "489": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "490": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "491": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "492": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "493": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "494": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "495": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "496": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "497": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "498": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "499": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "500": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "501": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "502": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "503": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "504": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "505": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "topic" - }, - "506": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "params" - }, - "507": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "508": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "509": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "510": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "511": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "512": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "token" - }, - "515": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "516": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "517": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "518": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "519": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "callback" - }, - "573": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeClientOptions" - }, - "574": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "575": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.transport" - }, - "576": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.timeout" - }, - "577": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatIntervalMs" - }, - "578": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatCallback" - }, - "579": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "580": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "581": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "status" - }, - "582": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "latency" - }, - "583": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.vsn" - }, - "584": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.logger" - }, - "585": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "586": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "587": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "588": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "589": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "590": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.encode" - }, - "591": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.decode" - }, - "592": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.reconnectAfterMs" - }, - "593": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "594": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "595": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "596": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.headers" - }, - "597": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "598": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "600": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.params" - }, - "601": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "602": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "604": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.log_level" - }, - "605": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.logLevel" - }, - "606": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.fetch" - }, - "607": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.worker" - }, - "608": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.workerUrl" - }, - "609": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.accessToken" - }, - "610": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "611": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "612": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.disconnectOnEmptyChannelsAfterMs" - }, - "613": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.sessionStorage" - }, - "614": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeMessage" - }, - "615": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.topic" - }, - "617": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.event" - }, - "618": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.payload" - }, - "619": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.ref" - }, - "620": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.join_ref" - }, - "621": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesFilter" - }, - "622": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "623": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "624": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.schema" - }, - "625": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.table" - }, - "626": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.filter" - }, - "627": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "628": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayload" - }, - "629": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "630": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "631": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "633": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresInsertPayload" - }, - "634": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "635": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "636": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "637": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "638": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "639": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "640": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "641": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "643": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresUpdatePayload" - }, - "644": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "645": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "646": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "647": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "648": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "649": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "650": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "652": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresDeletePayload" - }, - "653": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "654": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "655": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "656": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "657": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "658": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "659": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "660": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "662": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceJoinPayload" - }, - "663": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "664": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "665": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "666": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "667": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.newPresences" - }, - "668": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "669": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "670": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "672": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceLeavePayload" - }, - "673": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "674": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "675": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "676": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "677": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.leftPresences" - }, - "678": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "679": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "680": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "682": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceState" - }, - "683": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "684": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "686": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "687": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "688": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "690": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "691": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeRemoveChannelResponse" - }, - "692": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "693": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES" - }, - "694": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" - }, - "695": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" - }, - "696": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" - }, - "697": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" - }, - "698": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "699": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - }, - "700": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "701": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "702": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "703": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" - }, - "704": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" - }, - "705": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "706": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "707": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES" - }, - "708": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" - }, - "709": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" - }, - "710": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" - }, - "711": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" - }, - "712": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_CHANNEL_STATES" - }, - "713": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object" - }, - "714": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.closed" - }, - "715": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.errored" - }, - "716": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.joined" - }, - "717": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.joining" - }, - "718": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.leaving" - }, - "719": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory" - }, - "722": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "723": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "724": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "725": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "726": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "url" - }, - "727": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "protocols" - }, - "728": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "729": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "732": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike" - }, - "733": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CONNECTING" - }, - "734": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.OPEN" - }, - "735": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSING" - }, - "736": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSED" - }, - "737": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.readyState" - }, - "738": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.url" - }, - "739": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.protocol" - }, - "740": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "741": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "742": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "code" - }, - "743": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "reason" - }, - "744": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "745": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "746": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "data" - }, - "747": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onopen" - }, - "748": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "749": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "750": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "751": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "752": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onmessage" - }, - "753": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "754": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "755": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "756": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "757": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onclose" - }, - "758": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "760": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "761": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "762": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onerror" - }, - "763": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "765": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "766": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "767": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "768": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "769": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "770": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "771": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "772": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "773": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "774": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "775": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.binaryType" - }, - "776": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.bufferedAmount" - }, - "777": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.extensions" - }, - "778": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.dispatchEvent" - }, - "779": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "780": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "781": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "event" - }, - "782": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "783": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "784": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "785": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "address" - }, - "786": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "subprotocols" - }, - "787": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor.__index" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "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 deleted file mode 100644 index da040a4c859..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/realtime_dereferenced.json +++ /dev/null @@ -1,17533 +0,0 @@ -{ - "id": 0, - "name": "@supabase/realtime-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 693, - "name": "REALTIME_LISTEN_TYPES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 694, - "name": "BROADCAST", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L138" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 696, - "name": "POSTGRES_CHANGES", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L140" - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 695, - "name": "PRESENCE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 139, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L139" - } - ], - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 697, - "name": "SYSTEM", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L141" - } - ], - "type": { - "type": "literal", - "value": "system" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [694, 696, 695, 697] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 137, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L137" - } - ] - }, - { - "id": 698, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 699, - "name": "ALL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 131, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L131" - } - ], - "type": { - "type": "literal", - "value": "*" - } - }, - { - "id": 702, - "name": "DELETE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 134, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L134" - } - ], - "type": { - "type": "literal", - "value": "DELETE" - } - }, - { - "id": 700, - "name": "INSERT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L132" - } - ], - "type": { - "type": "literal", - "value": "INSERT" - } - }, - { - "id": 701, - "name": "UPDATE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 133, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L133" - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [699, 702, 700, 701] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 130, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L130" - } - ] - }, - { - "id": 703, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 705, - "name": "JOIN", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L33" - } - ], - "type": { - "type": "literal", - "value": "join" - } - }, - { - "id": 706, - "name": "LEAVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L34" - } - ], - "type": { - "type": "literal", - "value": "leave" - } - }, - { - "id": 704, - "name": "SYNC", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 32, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L32" - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [705, 706, 704] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 31, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L31" - } - ] - }, - { - "id": 707, - "name": "REALTIME_SUBSCRIBE_STATES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 711, - "name": "CHANNEL_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 148, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L148" - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - } - }, - { - "id": 710, - "name": "CLOSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 147, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L147" - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - } - }, - { - "id": 708, - "name": "SUBSCRIBED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 145, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L145" - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - } - }, - { - "id": 709, - "name": "TIMED_OUT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L146" - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [711, 710, 708, 709] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 144, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L144" - } - ] - }, - { - "id": 10, - "name": "RealtimeChannel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "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": 15, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L238" - } - ], - "signatures": [ - { - "id": 16, - "name": "RealtimeChannel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\n\nThe topic determines which realtime stream you are subscribing to. Config options let you\nenable acknowledgement for broadcasts, presence tracking, or private channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 238, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L238" - } - ], - "parameters": [ - { - "id": 17, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 18, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - }, - { - "id": 19, - "name": "socket", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 20, - "name": "bindings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 177, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L177" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "Binding" - }, - "name": "Binding", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 22, - "name": "broadcastEndpointURL", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 179, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L179" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 241, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L241" - } - ], - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - }, - { - "id": 24, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 181, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L181" - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 23, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 180, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L180" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 40, - "name": "socket", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 242, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L242" - } - ], - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 21, - "name": "subTopic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 178, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L178" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 38, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 240, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L240" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 30, - "name": "joinedOnce", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L193" - } - ], - "getSignature": { - "id": 31, - "name": "joinedOnce", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L193" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - }, - { - "id": 34, - "name": "joinPush", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 201, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L201" - } - ], - "getSignature": { - "id": 35, - "name": "joinPush", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 201, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L201" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/push.js", - "qualifiedName": "default" - }, - "name": "Push", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 36, - "name": "rejoinTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 205, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L205" - } - ], - "getSignature": { - "id": 37, - "name": "rejoinTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 205, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L205" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 26, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 185, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L185" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 189, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L189" - } - ], - "getSignature": { - "id": 27, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 185, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L185" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - }, - "setSignature": { - "id": 28, - "name": "state", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 189, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L189" - } - ], - "parameters": [ - { - "id": 29, - "name": "state", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 32, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 197, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L197" - } - ], - "getSignature": { - "id": 33, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 197, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L197" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 369, - "name": "copyBindings", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 1099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L1099" - } - ], - "signatures": [ - { - "id": 370, - "name": "copyBindings", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 1099, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L1099" - } - ], - "parameters": [ - { - "id": 371, - "name": "other", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 305, - "name": "httpSend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 764, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L764" - } - ], - "signatures": [ - { - "id": 306, - "name": "httpSend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a broadcast message explicitly via REST API.\n\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\n\nPayloads that are " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`ArrayBufferView`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`Uint8Array`" - }, - { - "kind": "text", - "text": ") are sent as\n" - }, - { - "kind": "code", - "text": "`application/octet-stream`" - }, - { - "kind": "text", - "text": "; all other payloads are JSON-encoded." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise resolving to object with success status, and error details if failed" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 764, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L764" - } - ], - "parameters": [ - { - "id": 307, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the broadcast event" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 308, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent (required)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 309, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options including timeout" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 311, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 767, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L767" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [311] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 767, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L767" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 312, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 313, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [313] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 314, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 317, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 316, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 315, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [317, 316, 315] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 768, - "character": 33, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L768" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 86, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listen to realtime events on this channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, Broadcast and Presence are enabled for all projects.\n- By default, listening to database changes is disabled for new projects due to database performance and security concerns. You can turn it on by managing Realtime's [replication](/docs/guides/api#realtime-api-overview).\n- You can receive the \"previous\" data for updates and deletes by setting the table's " - }, - { - "kind": "code", - "text": "`REPLICA IDENTITY`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`FULL`" - }, - { - "kind": "text", - "text": " (e.g., " - }, - { - "kind": "code", - "text": "`ALTER TABLE your_table REPLICA IDENTITY FULL;`" - }, - { - "kind": "text", - "text": ").\n- Row level security is not applied to delete statements. When RLS is enabled and replica identity is set to full, only the primary key is sent to clients." - } - ] - }, - { - "tag": "@example", - "name": "Listen to broadcast messages", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel(\"room1\")\n\nchannel.on(\"broadcast\", { event: \"cursor-pos\" }, (payload) => {\n console.log(\"Cursor position received!\", payload);\n}).subscribe((status) => {\n if (status === \"SUBSCRIBED\") {\n channel.send({\n type: \"broadcast\",\n event: \"cursor-pos\",\n payload: { x: Math.random(), y: Math.random() },\n });\n }\n});\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence sync", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'sync' }, () => {\n console.log('Synced presence state: ', channel.presenceState())\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence join", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'join' }, ({ newPresences }) => {\n console.log('Newly joined presences: ', newPresences)\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to presence leave", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\nchannel\n .on('presence', { event: 'leave' }, ({ leftPresences }) => {\n console.log('Newly left presences: ', leftPresences)\n })\n .subscribe(async (status) => {\n if (status === 'SUBSCRIBED') {\n await channel.track({ online_at: new Date().toISOString() })\n await channel.untrack()\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to all database changes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: '*', schema: '*' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to a specific table", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: '*', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to inserts", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to updates\nBy default, Supabase will send only the updated record. If you want to receive the previous values as well you can\nenable full replication for the table you are listening to:\n\n" - }, - { - "kind": "code", - "text": "```sql\nalter table \"your_table\" replica identity full;\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to updates", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to deletes\nBy default, Supabase does not send deleted records. If you want to receive the deleted record you can\nenable full replication for the table you are listening to:\n\n" - }, - { - "kind": "code", - "text": "```sql\nalter table \"your_table\" replica identity full;\n```" - } - ] - }, - { - "tag": "@example", - "name": "Listen to deletes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, payload => {\n console.log('Change received!', payload)\n })\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to multiple events\nYou can chain listeners if you want to listen to multiple events for each table." - } - ] - }, - { - "tag": "@example", - "name": "Listen to multiple events", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'INSERT', schema: 'public', table: 'countries' }, handleRecordInserted)\n .on('postgres_changes', { event: 'DELETE', schema: 'public', table: 'countries' }, handleRecordDeleted)\n .subscribe()\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Listen to row level changes\nYou can listen to individual rows using the format " - }, - { - "kind": "code", - "text": "`{table}:{col}=eq.{val}`" - }, - { - "kind": "text", - "text": " - where " - }, - { - "kind": "code", - "text": "`{col}`" - }, - { - "kind": "text", - "text": " is the column name, and " - }, - { - "kind": "code", - "text": "`{val}`" - }, - { - "kind": "text", - "text": " is the value which you want to match." - } - ] - }, - { - "tag": "@example", - "name": "Listen to row level changes", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase\n .channel('room1')\n .on('postgres_changes', { event: 'UPDATE', schema: 'public', table: 'countries', filter: 'id=eq.200' }, handleRecordUpdated)\n .subscribe()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L453" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 504, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L504" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 530, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L530" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - }, - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 730, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L730" - } - ], - "signatures": [ - { - "id": 87, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L453" - } - ], - "parameters": [ - { - "id": 88, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 89, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 90, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 91, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 455, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L455" - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [91] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 455, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L455" - } - ] - } - } - }, - { - "id": 92, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 456, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L456" - } - ], - "signatures": [ - { - "id": 94, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 456, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 95, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "typeParameters": [ - { - "id": 96, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 97, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "indexSignatures": [ - { - "id": 98, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 458, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L458" - } - ], - "parameters": [ - { - "id": 99, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 100, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 101, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 102, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 103, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 460, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L460" - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [103] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 460, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L460" - } - ] - } - } - }, - { - "id": 104, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 461, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L461" - } - ], - "signatures": [ - { - "id": 106, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 461, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L461" - } - ], - "parameters": [ - { - "id": 107, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 662, - "typeArguments": [ - { - "type": "reference", - "target": 96, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 108, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "typeParameters": [ - { - "id": 109, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 110, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "indexSignatures": [ - { - "id": 111, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 463, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L463" - } - ], - "parameters": [ - { - "id": 112, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 113, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 114, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 116, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 465, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L465" - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [116] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 465, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L465" - } - ] - } - } - }, - { - "id": 117, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 466, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L466" - } - ], - "signatures": [ - { - "id": 119, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 466, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L466" - } - ], - "parameters": [ - { - "id": 120, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 672, - "typeArguments": [ - { - "type": "reference", - "target": 109, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 121, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "typeParameters": [ - { - "id": 122, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "indexSignatures": [ - { - "id": 124, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 468, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L468" - } - ], - "parameters": [ - { - "id": 125, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 126, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 127, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 128, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 129, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 470, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L470" - } - ], - "type": { - "type": "literal", - "value": "*" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [129] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 470, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L470" - } - ] - } - } - }, - { - "id": 130, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 471, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L471" - } - ], - "signatures": [ - { - "id": 132, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 471, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L471" - } - ], - "parameters": [ - { - "id": 133, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 662, - "typeArguments": [ - { - "type": "reference", - "target": 122, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 672, - "typeArguments": [ - { - "type": "reference", - "target": 122, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 134, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "typeParameters": [ - { - "id": 135, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "indexSignatures": [ - { - "id": 137, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 473, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L473" - } - ], - "parameters": [ - { - "id": 138, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 139, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 140, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 141, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 142, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 476, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L476" - } - ], - "signatures": [ - { - "id": 143, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 476, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L476" - } - ], - "parameters": [ - { - "id": 144, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 628, - "typeArguments": [ - { - "type": "reference", - "target": 135, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 145, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "typeParameters": [ - { - "id": 146, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 147, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "indexSignatures": [ - { - "id": 148, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 478, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L478" - } - ], - "parameters": [ - { - "id": 149, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 150, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 151, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 152, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 481, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L481" - } - ], - "signatures": [ - { - "id": 154, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 481, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L481" - } - ], - "parameters": [ - { - "id": 155, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 633, - "typeArguments": [ - { - "type": "reference", - "target": 146, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 156, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "typeParameters": [ - { - "id": 157, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 158, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "indexSignatures": [ - { - "id": 159, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 483, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L483" - } - ], - "parameters": [ - { - "id": 160, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 161, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 162, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 163, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 164, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 486, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L486" - } - ], - "signatures": [ - { - "id": 165, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 486, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L486" - } - ], - "parameters": [ - { - "id": 166, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 643, - "typeArguments": [ - { - "type": "reference", - "target": 157, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 167, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "typeParameters": [ - { - "id": 168, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 169, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "indexSignatures": [ - { - "id": 170, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 488, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L488" - } - ], - "parameters": [ - { - "id": 171, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 172, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 173, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 174, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 491, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L491" - } - ], - "signatures": [ - { - "id": 176, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 491, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L491" - } - ], - "parameters": [ - { - "id": 177, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 652, - "typeArguments": [ - { - "type": "reference", - "target": 168, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 178, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "typeParameters": [ - { - "id": 179, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "indexSignatures": [ - { - "id": 181, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 493, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L493" - } - ], - "parameters": [ - { - "id": 182, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 183, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 184, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 621, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INSERT" - }, - { - "type": "literal", - "value": "UPDATE" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "*" - } - ] - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 185, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 496, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L496" - } - ], - "signatures": [ - { - "id": 187, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 496, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L496" - } - ], - "parameters": [ - { - "id": 188, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 628, - "typeArguments": [ - { - "type": "reference", - "target": 179, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 189, - "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": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 504, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L504" - } - ], - "parameters": [ - { - "id": 190, - "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": 191, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 192, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 193, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 506, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L506" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [193] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 506, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L506" - } - ] - } - } - }, - { - "id": 194, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function to be invoked when event handler is triggered." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 195, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "signatures": [ - { - "id": 196, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "parameters": [ - { - "id": 197, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 198, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 200, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 509, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L509" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 201, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 510, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L510" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 202, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 204, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 512, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L512" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 203, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 511, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L511" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [204, 203] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 510, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L510" - } - ] - } - } - }, - { - "id": 199, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 508, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L508" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [200, 201, 199] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 507, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L507" - } - ], - "indexSignatures": [ - { - "id": 205, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 514, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L514" - } - ], - "parameters": [ - { - "id": 206, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 207, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "typeParameters": [ - { - "id": 208, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 209, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "indexSignatures": [ - { - "id": 210, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 517, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L517" - } - ], - "parameters": [ - { - "id": 211, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 212, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 213, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 214, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 215, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 519, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L519" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [215] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 519, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L519" - } - ] - } - } - }, - { - "id": 216, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 217, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ], - "signatures": [ - { - "id": 218, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ], - "parameters": [ - { - "id": 219, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 220, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 222, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 522, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L522" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 223, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 523, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L523" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 226, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 525, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L525" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 524, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L524" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [226, 225] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 523, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L523" - } - ] - } - } - }, - { - "id": 227, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 527, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L527" - } - ], - "type": { - "type": "reference", - "target": 208, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 221, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 521, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L521" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [222, 223, 227, 221] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 520, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L520" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 228, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 530, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L530" - } - ], - "typeParameters": [ - { - "id": 229, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 230, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 231, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 232, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 233, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 532, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L532" - } - ], - "type": { - "type": "reference", - "target": 699, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [233] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 532, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L532" - } - ] - } - } - }, - { - "id": 234, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 235, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ], - "signatures": [ - { - "id": 236, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ], - "parameters": [ - { - "id": 237, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 238, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 240, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 535, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L535" - } - ], - "type": { - "type": "reference", - "target": 699, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - }, - { - "id": 241, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 536, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L536" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 229, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 239, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 534, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L534" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [240, 241, 239] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 533, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L533" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 242, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "typeParameters": [ - { - "id": 243, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 244, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "indexSignatures": [ - { - "id": 245, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 539, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L539" - } - ], - "parameters": [ - { - "id": 246, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 247, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 248, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 249, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 250, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 541, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L541" - } - ], - "type": { - "type": "reference", - "target": 700, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [250] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 541, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L541" - } - ] - } - } - }, - { - "id": 251, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 252, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ], - "signatures": [ - { - "id": 253, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ], - "parameters": [ - { - "id": 254, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 257, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 544, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L544" - } - ], - "type": { - "type": "reference", - "target": 700, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - }, - { - "id": 258, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 545, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L545" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastInsertPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 243, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastInsertPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 256, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 543, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L543" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [257, 258, 256] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 542, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L542" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 259, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "typeParameters": [ - { - "id": 260, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "indexSignatures": [ - { - "id": 262, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 548, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L548" - } - ], - "parameters": [ - { - "id": 263, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 264, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 265, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 266, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 267, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 550, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L550" - } - ], - "type": { - "type": "reference", - "target": 701, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [267] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 550, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L550" - } - ] - } - } - }, - { - "id": 268, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 269, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ], - "signatures": [ - { - "id": 270, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ], - "parameters": [ - { - "id": 271, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 272, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 274, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 553, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L553" - } - ], - "type": { - "type": "reference", - "target": 701, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - }, - { - "id": 275, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 554, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L554" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastUpdatePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 260, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastUpdatePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 273, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 552, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L552" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [274, 275, 273] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 551, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L551" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 276, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "typeParameters": [ - { - "id": 277, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 278, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "indexSignatures": [ - { - "id": 279, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 557, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L557" - } - ], - "parameters": [ - { - "id": 280, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 281, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 282, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 283, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 284, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 559, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L559" - } - ], - "type": { - "type": "reference", - "target": 702, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [284] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 559, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L559" - } - ] - } - } - }, - { - "id": 285, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 286, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ], - "signatures": [ - { - "id": 287, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ], - "parameters": [ - { - "id": 288, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 289, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 291, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 562, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L562" - } - ], - "type": { - "type": "reference", - "target": 702, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - }, - { - "id": 292, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 563, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L563" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastDeletePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 277, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastDeletePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 290, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 561, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L561" - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [291, 292, 290] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 560, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L560" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 293, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "typeParameters": [ - { - "id": 294, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 295, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "indexSignatures": [ - { - "id": 296, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 566, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L566" - } - ], - "parameters": [ - { - "id": 297, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 298, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 299, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 300, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 301, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 302, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 569, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L569" - } - ], - "signatures": [ - { - "id": 303, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 569, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L569" - } - ], - "parameters": [ - { - "id": 304, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 63, - "name": "presenceState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "signatures": [ - { - "id": 64, - "name": "presenceState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current presence state for this channel.\n\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\ntracked metadata for that user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "typeParameters": [ - { - "id": 65, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 66, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "indexSignatures": [ - { - "id": 67, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 411, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L411" - } - ], - "parameters": [ - { - "id": 68, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "target": 682, - "typeArguments": [ - { - "type": "reference", - "target": 65, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 318, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 863, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L863" - } - ], - "signatures": [ - { - "id": 319, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a message into the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- When using REST you don't need to subscribe to the channel\n- REST calls are only available from 2.37.0 onwards\n- If you create a channel only to send a REST broadcast, remove it from\n the client when the send completes" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via websocket", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\nchannel.subscribe((status) => {\n if (status === 'SUBSCRIBED') {\n channel.send({\n type: 'broadcast',\n event: 'cursor-pos',\n payload: { x: Math.random(), y: Math.random() },\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Send a message via websocket\n" - }, - { - "kind": "code", - "text": "```js\nok | timed out | error\n```" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via REST", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\ntry {\n await channel.httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\n} finally {\n await supabase.removeChannel(channel)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 863, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L863" - } - ], - "parameters": [ - { - "id": 320, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arguments to send to channel" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 323, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event being sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 866, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L866" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 324, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 867, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L867" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 322, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of event to send" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 865, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L865" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [323, 324, 322] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 864, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L864" - } - ], - "indexSignatures": [ - { - "id": 325, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 868, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L868" - } - ], - "parameters": [ - { - "id": 326, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 327, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options to be used during the send process" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 328, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 870, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L870" - } - ], - "indexSignatures": [ - { - "id": 329, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 870, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L870" - } - ], - "parameters": [ - { - "id": 330, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 41, - "name": "subscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L292" - } - ], - "signatures": [ - { - "id": 42, - "name": "subscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Subscribe registers your client with the server.\n\nThe optional " - }, - { - "kind": "code", - "text": "`callback`" - }, - { - "kind": "text", - "text": " receives a " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and, on failure, an " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " argument.\nLog the full " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " so its " - }, - { - "kind": "code", - "text": "`cause`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", and any structured fields aren't hidden\nbehind " - }, - { - "kind": "code", - "text": "`err.message`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.channel('room1').subscribe((status, err) => {\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\n // Log the full error: its `cause` often holds the underlying reason.\n console.error(status, err)\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 292, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L292" - } - ], - "parameters": [ - { - "id": 43, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 44, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 293, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L293" - } - ], - "signatures": [ - { - "id": 45, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 293, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L293" - } - ], - "parameters": [ - { - "id": 46, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 707, - "name": "REALTIME_SUBSCRIBE_STATES", - "package": "@supabase/realtime-js" - } - }, - { - "id": 47, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 48, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 337, - "name": "teardown", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L971" - } - ], - "signatures": [ - { - "id": 338, - "name": "teardown", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Destroys and stops related timers." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 971, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L971" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 70, - "name": "track", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 421, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L421" - } - ], - "signatures": [ - { - "id": 71, - "name": "track", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends the supplied payload to the presence tracker so other subscribers can see that this\nclient is online. Use " - }, - { - "kind": "code", - "text": "`untrack`" - }, - { - "kind": "text", - "text": " to stop broadcasting presence for the same key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 421, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L421" - } - ], - "parameters": [ - { - "id": 72, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 422, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L422" - } - ], - "indexSignatures": [ - { - "id": 74, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 422, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L422" - } - ], - "parameters": [ - { - "id": 75, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 76, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 77, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 423, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L423" - } - ], - "indexSignatures": [ - { - "id": 78, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 423, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L423" - } - ], - "parameters": [ - { - "id": 79, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 334, - "name": "unsubscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 956, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L956" - } - ], - "signatures": [ - { - "id": 335, - "name": "unsubscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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!\") )" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 956, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L956" - } - ], - "parameters": [ - { - "id": 336, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 80, - "name": "untrack", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "signatures": [ - { - "id": 81, - "name": "untrack", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes the current presence state for this client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "parameters": [ - { - "id": 82, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "indexSignatures": [ - { - "id": 84, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 440, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L440" - } - ], - "parameters": [ - { - "id": 85, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 394, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 331, - "name": "updateJoinPayload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L941" - } - ], - "signatures": [ - { - "id": 332, - "name": "updateJoinPayload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the payload that will be sent the next time the channel joins (reconnects).\nUseful for rotating access tokens or updating config without re-creating the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 941, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L941" - } - ], - "parameters": [ - { - "id": 333, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [15] - }, - { - "title": "Properties", - "children": [20, 22, 39, 24, 23, 40, 21, 38] - }, - { - "title": "Accessors", - "children": [30, 34, 36, 26, 32] - }, - { - "title": "Methods", - "children": [369, 305, 86, 63, 318, 41, 337, 70, 334, 80, 331] - } - ], - "categories": [ - { - "title": "Other", - "children": [20, 22, 39, 24, 23, 40, 21, 38, 30, 34, 36, 26, 32, 369] - }, - { - "title": "Realtime", - "children": [15, 305, 86, 63, 318, 41, 337, 70, 334, 80, 331] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 176, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L176" - } - ] - }, - { - "id": 396, - "name": "RealtimeClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 397, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L277" - } - ], - "signatures": [ - { - "id": 398, - "name": "RealtimeClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the Socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nclient.connect()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L277" - } - ], - "parameters": [ - { - "id": 399, - "name": "endPoint", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 400, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 573, - "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": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future." - } - ], - "heartbeatIntervalMs": [ - { - "kind": "text", - "text": "The millisec interval to send a heartbeat message." - } - ], - "heartbeatCallback": [ - { - "kind": "text", - "text": "The optional function to handle heartbeat status and latency." - } - ], - "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." - } - ], - "vsn": [ - { - "kind": "text", - "text": "The protocol version to use when connecting. Supported versions are \"1.0.0\" and \"2.0.0\". Defaults to \"2.0.0\"." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 396, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 404, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 405, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "signatures": [ - { - "id": 406, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 141, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L141" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - }, - "defaultValue": "null" - }, - { - "id": 403, - "name": "accessTokenValue", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 140, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L140" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 407, - "name": "apiKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L142" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 402, - "name": "channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L138" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - "defaultValue": "..." - }, - { - "id": 419, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L153" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 420, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 421, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 422, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - } - ] - } - }, - { - "id": 423, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 424, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 425, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - } - ] - } - }, - { - "id": 426, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 409, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "headers cannot be set on websocket connections" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "indexSignatures": [ - { - "id": 411, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 146, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L146" - } - ], - "parameters": [ - { - "id": 412, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 408, - "name": "httpEndpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 144, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L144" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "''" - }, - { - "id": 418, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L151" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 413, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 414, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "indexSignatures": [ - { - "id": 415, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 147, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L147" - } - ], - "parameters": [ - { - "id": 416, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 417, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 149, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L149" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 430, - "name": "serializer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L158" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/serializer.ts", - "qualifiedName": "default" - }, - "name": "Serializer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - }, - "defaultValue": "..." - }, - { - "id": 427, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 154, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L154" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 429, - "name": "workerRef", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 156, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L156" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Worker" - }, - "name": "Worker", - "package": "typescript" - } - }, - { - "id": 428, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L155" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "decode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 206, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L206" - } - ], - "getSignature": { - "id": 452, - "name": "decode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 206, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L206" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 449, - "name": "encode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 202, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L202" - } - ], - "getSignature": { - "id": 450, - "name": "encode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 202, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L202" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 431, - "name": "endPoint", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L160" - } - ], - "getSignature": { - "id": 432, - "name": "endPoint", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 160, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L160" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 437, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L172" - } - ], - "getSignature": { - "id": 438, - "name": "heartbeatCallback", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L172" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 439, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 176, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L176" - } - ], - "getSignature": { - "id": 440, - "name": "heartbeatIntervalMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 176, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L176" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 441, - "name": "heartbeatTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 180, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L180" - } - ], - "getSignature": { - "id": 442, - "name": "heartbeatTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 180, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L180" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "HeartbeatTimer" - }, - "name": "HeartbeatTimer", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 443, - "name": "pendingHeartbeatRef", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 187, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L187" - } - ], - "getSignature": { - "id": 444, - "name": "pendingHeartbeatRef", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 187, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L187" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 453, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 210, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L210" - } - ], - "getSignature": { - "id": 454, - "name": "reconnectAfterMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 210, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L210" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 455, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 74, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L74" - } - ], - "signatures": [ - { - "id": 456, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 74, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L74" - } - ], - "parameters": [ - { - "id": 457, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - } - }, - { - "id": 445, - "name": "reconnectTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L194" - } - ], - "getSignature": { - "id": 446, - "name": "reconnectTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L194" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 458, - "name": "sendBuffer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 214, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L214" - } - ], - "getSignature": { - "id": 459, - "name": "sendBuffer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 214, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L214" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 78, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L78" - } - ], - "signatures": [ - { - "id": 461, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/phoenix/socketAdapter.ts", - "line": 78, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/phoenix/socketAdapter.ts#L78" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - } - }, - { - "id": 462, - "name": "stateChangeCallbacks", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ], - "getSignature": { - "id": 463, - "name": "stateChangeCallbacks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 464, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 466, - "name": "close", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 220, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L220" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 467, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 221, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L221" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 468, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 222, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L222" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 465, - "name": "open", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 219, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L219" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [466, 467, 468, 465] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 218, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L218" - } - ] - } - } - } - }, - { - "id": 433, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L164" - } - ], - "getSignature": { - "id": 434, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 164, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L164" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 435, - "name": "transport", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L168" - } - ], - "getSignature": { - "id": 436, - "name": "transport", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L168" - } - ], - "type": { - "type": "reference", - "target": 782, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 447, - "name": "vsn", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 198, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L198" - } - ], - "getSignature": { - "id": 448, - "name": "vsn", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 198, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L198" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Vsn" - }, - "name": "Vsn", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 503, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L469" - } - ], - "signatures": [ - { - "id": 504, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates (or reuses) a " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RealtimeChannel", - "target": 10 - }, - { - "kind": "text", - "text": " for the provided topic.\n\nTopics are automatically prefixed with " - }, - { - "kind": "code", - "text": "`realtime:`" - }, - { - "kind": "text", - "text": " to match the Realtime service.\nIf a channel with the same topic already exists it will be returned instead of creating\na duplicate connection." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 469, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L469" - } - ], - "parameters": [ - { - "id": 505, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 506, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 380, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 475, - "name": "connect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L297" - } - ], - "signatures": [ - { - "id": 476, - "name": "connect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Connects the socket, unless already connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 297, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L297" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 495, - "name": "connectionState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 429, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L429" - } - ], - "signatures": [ - { - "id": 496, - "name": "connectionState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current state of the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 429, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L429" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "ConnectionState" - }, - "name": "ConnectionState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 479, - "name": "disconnect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 356, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L356" - } - ], - "signatures": [ - { - "id": 480, - "name": "disconnect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Disconnects the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 356, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L356" - } - ], - "parameters": [ - { - "id": 481, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A numeric status code to send on disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 482, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom reason for the disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timeout" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 477, - "name": "endpointURL", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L344" - } - ], - "signatures": [ - { - "id": 478, - "name": "endpointURL", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the URL of the websocket." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "string The URL of the websocket." - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 344, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L344" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 483, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L376" - } - ], - "signatures": [ - { - "id": 484, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all created channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 376, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L376" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 497, - "name": "isConnected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 438, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L438" - } - ], - "signatures": [ - { - "id": 498, - "name": "isConnected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " is the connection is open." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 438, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L438" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 499, - "name": "isConnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 447, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L447" - } - ], - "signatures": [ - { - "id": 500, - "name": "isConnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently connecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 447, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L447" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 501, - "name": "isDisconnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L456" - } - ], - "signatures": [ - { - "id": 502, - "name": "isDisconnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently disconnecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 490, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L420" - } - ], - "signatures": [ - { - "id": 491, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " - }, - { - "kind": "code", - "text": "`this.logger`" - }, - { - "kind": "text", - "text": " can be overridden in Client constructor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 420, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L420" - } - ], - "parameters": [ - { - "id": 492, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 493, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 494, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 517, - "name": "onHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L550" - } - ], - "signatures": [ - { - "id": 518, - "name": "onHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets a callback that receives lifecycle events for internal heartbeat messages.\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L550" - } - ], - "parameters": [ - { - "id": 519, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 507, - "name": "push", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L491" - } - ], - "signatures": [ - { - "id": 508, - "name": "push", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L491" - } - ], - "parameters": [ - { - "id": 509, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 614, - "name": "RealtimeMessage", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 488, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 401, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L401" - } - ], - "signatures": [ - { - "id": 489, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down all channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 401, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L401" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 691, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 485, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L386" - } - ], - "signatures": [ - { - "id": 486, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down a single channel" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L386" - } - ], - "parameters": [ - { - "id": 487, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A RealtimeChannel instance" - } - ] - }, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 691, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 515, - "name": "sendHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 540, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L540" - } - ], - "signatures": [ - { - "id": 516, - "name": "sendHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a heartbeat message if the socket is connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 540, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L540" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 510, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 517, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L517" - } - ], - "signatures": [ - { - "id": 511, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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.\n\nWhen a token is explicitly provided, it will be preserved across channel operations\n(including removeChannel and resubscribe). The " - }, - { - "kind": "code", - "text": "`accessToken`" - }, - { - "kind": "text", - "text": " callback will not be\ninvoked until " - }, - { - "kind": "code", - "text": "`setAuth()`" - }, - { - "kind": "text", - "text": " is called without arguments." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nSetting the authorization header\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\nclient.realtime.setAuth('my-custom-jwt')\n\n// Switch back to using the accessToken callback\nclient.realtime.setAuth()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 517, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L517" - } - ], - "parameters": [ - { - "id": 512, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A JWT string to override the token set on the client." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "defaultValue": "null" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [397] - }, - { - "title": "Properties", - "children": [404, 403, 407, 402, 419, 409, 408, 418, 413, 417, 430, 427, 429, 428] - }, - { - "title": "Accessors", - "children": [451, 449, 431, 437, 439, 441, 443, 453, 445, 458, 462, 433, 435, 447] - }, - { - "title": "Methods", - "children": [ - 503, 475, 495, 479, 477, 483, 497, 499, 501, 490, 517, 507, 488, 485, 515, 510 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 404, 403, 407, 402, 419, 409, 408, 418, 413, 417, 430, 427, 429, 428, 451, 449, 431, - 437, 439, 441, 443, 453, 445, 458, 462, 433, 435, 447 - ] - }, - { - "title": "Realtime", - "children": [ - 397, 503, 475, 495, 479, 477, 483, 497, 499, 501, 490, 517, 507, 488, 485, 515, 510 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 135, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L135" - } - ] - }, - { - "id": 1, - "name": "RealtimePresence", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L65" - } - ], - "signatures": [ - { - "id": 3, - "name": "RealtimePresence", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Presence helper that keeps the local presence state in sync with the server." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example for a presence channel", - "content": [ - { - "kind": "code", - "text": "```ts\nconst presence = new RealtimePresence(channel)\n\nchannel.on('presence', ({ event, key }) => {\n console.log(`Presence ${event} on ${key}`)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L65" - } - ], - "parameters": [ - { - "id": 4, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 5, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom event names, e.g. " - }, - { - "kind": "code", - "text": "`{ events: { state: 'state', diff: 'diff' } }`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceOptions" - }, - "name": "RealtimePresenceOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 9, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 66, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L66" - } - ], - "type": { - "type": "reference", - "target": 10, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 6, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 42, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L42" - } - ], - "getSignature": { - "id": 7, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 42, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L42" - } - ], - "type": { - "type": "reference", - "target": 682, - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2] - }, - { - "title": "Properties", - "children": [9] - }, - { - "title": "Accessors", - "children": [6] - } - ], - "categories": [ - { - "title": "Other", - "children": [9, 6] - }, - { - "title": "Realtime", - "children": [2] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 41, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L41" - } - ] - }, - { - "id": 719, - "name": "WebSocketFactory", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Utilities for creating WebSocket instances across runtimes." - } - ] - }, - "children": [ - { - "id": 722, - "name": "getWebSocketConstructor", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 169, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L169" - } - ], - "signatures": [ - { - "id": 723, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the best available WebSocket constructor for the current runtime." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example with error handling", - "content": [ - { - "kind": "code", - "text": "```ts\ntry {\n const WS = WebSocketFactory.getWebSocketConstructor()\n const socket = new WS('wss://example.com/socket')\n} catch (error) {\n console.error('WebSocket not available in this environment.', error)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 169, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L169" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 724, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26772, - "character": 23 - } - ], - "signatures": [ - { - "id": 725, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26774, - "character": 4 - } - ], - "parameters": [ - { - "id": 726, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 727, - "name": "protocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" - }, - "name": "WebSocket", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 728, - "name": "isWebSocketSupported", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 194, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L194" - } - ], - "signatures": [ - { - "id": 729, - "name": "isWebSocketSupported", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detects whether the runtime can establish WebSocket connections." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example in a Node.js script", - "content": [ - { - "kind": "code", - "text": "```ts\nif (!WebSocketFactory.isWebSocketSupported()) {\n console.error('WebSockets are required for this script.')\n process.exitCode = 1\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 194, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L194" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [722, 728] - } - ], - "categories": [ - { - "title": "Realtime", - "children": [722, 728] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 61, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L61" - } - ] - }, - { - "id": 732, - "name": "WebSocketLike", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 775, - "name": "binaryType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L34" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 776, - "name": "bufferedAmount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L35" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 736, - "name": "CLOSED", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 5, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L5" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 735, - "name": "CLOSING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 4, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L4" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 733, - "name": "CONNECTING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 2, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L2" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 778, - "name": "dispatchEvent", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "signatures": [ - { - "id": 780, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 37, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L37" - } - ], - "parameters": [ - { - "id": 781, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - }, - { - "id": 777, - "name": "extensions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 757, - "name": "onclose", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 758, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "signatures": [ - { - "id": 759, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 21, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L21" - } - ], - "parameters": [ - { - "id": 760, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 761, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "CloseEvent" - }, - "name": "CloseEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 762, - "name": "onerror", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 763, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "signatures": [ - { - "id": 764, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L22" - } - ], - "parameters": [ - { - "id": 765, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 766, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 752, - "name": "onmessage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 753, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "signatures": [ - { - "id": 754, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 20, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L20" - } - ], - "parameters": [ - { - "id": 755, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 756, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "MessageEvent" - }, - "name": "MessageEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 747, - "name": "onopen", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 748, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "signatures": [ - { - "id": 749, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 19, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L19" - } - ], - "parameters": [ - { - "id": 750, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 751, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 734, - "name": "OPEN", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 3, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L3" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 739, - "name": "protocol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 8, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L8" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 737, - "name": "readyState", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 6, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L6" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 738, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 7, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L7" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 767, - "name": "addEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L27" - } - ], - "signatures": [ - { - "id": 768, - "name": "addEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registers an event listener on the socket (compatible with browser WebSocket API)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L27" - } - ], - "parameters": [ - { - "id": 769, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 770, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 740, - "name": "close", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L13" - } - ], - "signatures": [ - { - "id": 741, - "name": "close", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Closes the socket, optionally providing a close code and reason." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L13" - } - ], - "parameters": [ - { - "id": 742, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 743, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 771, - "name": "removeEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L31" - } - ], - "signatures": [ - { - "id": 772, - "name": "removeEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a previously registered event listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L31" - } - ], - "parameters": [ - { - "id": 773, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 774, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 744, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L17" - } - ], - "signatures": [ - { - "id": 745, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends data through the socket using the underlying implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L17" - } - ], - "parameters": [ - { - "id": 746, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [775, 776, 736, 735, 733, 778, 777, 757, 762, 752, 747, 734, 739, 737, 738] - }, - { - "title": "Methods", - "children": [767, 740, 771, 744] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/websocket-factory.ts", - "line": 1, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/websocket-factory.ts#L1" - } - ] - }, - { - "id": 782, - "name": "WebSocketLikeConstructor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal WebSocket constructor interface that RealtimeClient can work with.\nSupply a compatible implementation (native WebSocket, " - }, - { - "kind": "code", - "text": "`ws`" - }, - { - "kind": "text", - "text": ", etc) when running outside the browser." - } - ] - }, - "children": [ - { - "id": 783, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 58, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L58" - } - ], - "signatures": [ - { - "id": 784, - "name": "WebSocketLikeConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 59, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L59" - } - ], - "parameters": [ - { - "id": 785, - "name": "address", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 786, - "name": "subprotocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 732, - "name": "WebSocketLike", - "package": "@supabase/realtime-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [783] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 58, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L58" - } - ], - "indexSignatures": [ - { - "id": 787, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 61, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L61" - } - ], - "parameters": [ - { - "id": 788, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 380, - "name": "RealtimeChannelOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 22, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L22" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 381, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 382, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L23" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 383, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 384, - "name": "broadcast", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received\nreplay option instructs server to replay broadcast messages" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 387, - "name": "ack", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 34, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 388, - "name": "replay", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "ReplayOption" - }, - "name": "ReplayOption", - "package": "@supabase/realtime-js" - } - }, - { - "id": 386, - "name": "self", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [387, 388, 386] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 29, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L29" - } - ] - } - } - }, - { - "id": 389, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "key option is used to track presence payload across clients" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 392, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 31, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 391, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [392, 391] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 33, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L33" - } - ] - } - } - }, - { - "id": 393, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "defines if the channel is private or not and if RLS policies will be used to check data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 37, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [384, 389, 393] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 23, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L23" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [382] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 22, - "character": 37, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L22" - } - ] - } - } - }, - { - "id": 394, - "name": "RealtimeChannelSendResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 128, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L128" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 395, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 128, - "character": 83, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L128" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 573, - "name": "RealtimeClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 64, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L64" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 574, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 609, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 82, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L82" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 610, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 82, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L82" - } - ], - "signatures": [ - { - "id": 611, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 591, - "name": "decode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 72, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L72" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - }, - { - "id": 612, - "name": "disconnectOnEmptyChannelsAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L83" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 590, - "name": "encode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 71, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L71" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - }, - { - "id": 606, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L79" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/realtime-js" - } - }, - { - "id": 596, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 597, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "indexSignatures": [ - { - "id": 598, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 74, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L74" - } - ], - "parameters": [ - { - "id": 599, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 578, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 68, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L68" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 579, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 68, - "character": 22, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L68" - } - ], - "signatures": [ - { - "id": 580, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 581, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "HeartbeatStatus" - }, - "name": "HeartbeatStatus", - "package": "@supabase/realtime-js" - } - }, - { - "id": 582, - "name": "latency", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 577, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 604, - "name": "log_level", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 77, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L77" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 584, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 70, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L70" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 585, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 70, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L70" - } - ], - "signatures": [ - { - "id": 586, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 587, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 588, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 589, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 605, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 78, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L78" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 600, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 601, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "indexSignatures": [ - { - "id": 602, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 75, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L75" - } - ], - "parameters": [ - { - "id": 603, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 592, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 73, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L73" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 593, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 73, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L73" - } - ], - "signatures": [ - { - "id": 594, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 595, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - }, - { - "id": 613, - "name": "sessionStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage compatible object used by the underlying socket for longpoll fallback history.\nProvide a custom implementation in environments where reading " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": "\nthrows (sandboxed iframes, in-app webviews, \"block third-party storage\" privacy modes).\nDefaults to " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": " when accessible, otherwise an in-memory store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 90, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L90" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - } - }, - { - "id": 576, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 66, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L66" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 575, - "name": "transport", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L65" - } - ], - "type": { - "type": "reference", - "target": 782, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - }, - { - "id": 583, - "name": "vsn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 69, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L69" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 607, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 80, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L80" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 608, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 81, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L81" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 609, 591, 612, 590, 606, 596, 578, 577, 604, 584, 605, 600, 592, 613, 576, 575, 583, - 607, 608 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 64, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L64" - } - ] - } - } - }, - { - "id": 614, - "name": "RealtimeMessage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 32, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L32" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 617, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L34" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 620, - "name": "join_ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L37" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 618, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L35" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 619, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 616, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L33" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [617, 620, 618, 619, 616] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 32, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L32" - } - ] - } - } - }, - { - "id": 621, - "name": "RealtimePostgresChangesFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 109, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L109" - } - ], - "typeParameters": [ - { - "id": 627, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 698, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 623, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of database change to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L113" - } - ], - "type": { - "type": "reference", - "target": 627, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 626, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive database changes when filter is matched." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L125" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 624, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database schema to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 625, - "name": "table", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database table to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L121" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [623, 626, 624, 625] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 109, - "character": 99, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L109" - } - ] - } - } - }, - { - "id": 628, - "name": "RealtimePostgresChangesPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "typeParameters": [ - { - "id": 629, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "indexSignatures": [ - { - "id": 631, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 104, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L104" - } - ], - "parameters": [ - { - "id": 632, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 633, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 643, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 652, - "typeArguments": [ - { - "type": "reference", - "target": 629, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 652, - "name": "RealtimePostgresDeletePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "typeParameters": [ - { - "id": 658, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 659, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "indexSignatures": [ - { - "id": 660, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 97, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L97" - } - ], - "parameters": [ - { - "id": 661, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 653, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 654, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 99, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L99" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 702, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 655, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 100, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L100" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 100, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L100" - } - ] - } - } - }, - { - "id": 657, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 101, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L101" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 658, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [654, 655, 657] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 98, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L98" - } - ] - } - } - ] - } - }, - { - "id": 633, - "name": "RealtimePostgresInsertPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "typeParameters": [ - { - "id": 639, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 640, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "indexSignatures": [ - { - "id": 641, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 83, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L83" - } - ], - "parameters": [ - { - "id": 642, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 634, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 635, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 85, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L85" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 700, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 636, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 86, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L86" - } - ], - "type": { - "type": "reference", - "target": 639, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 637, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 87, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L87" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 638, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 87, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L87" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [635, 636, 637] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 84, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L84" - } - ] - } - } - ] - } - }, - { - "id": 643, - "name": "RealtimePostgresUpdatePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "typeParameters": [ - { - "id": 648, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "indexSignatures": [ - { - "id": 650, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 90, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L90" - } - ], - "parameters": [ - { - "id": 651, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 644, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 645, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 92, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L92" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 701, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 646, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 93, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L93" - } - ], - "type": { - "type": "reference", - "target": 648, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 647, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 94, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L94" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 648, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [645, 646, 647] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 91, - "character": 39, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L91" - } - ] - } - } - ] - } - }, - { - "id": 662, - "name": "RealtimePresenceJoinPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "typeParameters": [ - { - "id": 668, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 669, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 50, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "indexSignatures": [ - { - "id": 670, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 52, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ], - "parameters": [ - { - "id": 671, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 663, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 666, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 20, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L20" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 668, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 664, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L18" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 705, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 665, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 667, - "name": "newPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 21, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L21" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 668, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [666, 664, 665, 667] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 17, - "character": 76, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L17" - } - ] - } - } - }, - { - "id": 672, - "name": "RealtimePresenceLeavePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "typeParameters": [ - { - "id": 678, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 679, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "indexSignatures": [ - { - "id": 680, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 53, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ], - "parameters": [ - { - "id": 681, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 673, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 676, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L27" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 678, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 674, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L25" - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 706, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 675, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 677, - "name": "leftPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L28" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 678, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [676, 674, 675, 677] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 24, - "character": 77, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L24" - } - ] - } - } - }, - { - "id": 682, - "name": "RealtimePresenceState", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "typeParameters": [ - { - "id": 686, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 687, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 44, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "indexSignatures": [ - { - "id": 688, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 46, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "parameters": [ - { - "id": 689, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 690, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 69, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 13, - "character": 75, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L13" - } - ], - "indexSignatures": [ - { - "id": 684, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimePresence.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimePresence.ts#L14" - } - ], - "parameters": [ - { - "id": 685, - "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": 686, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ] - } - } - }, - { - "id": 691, - "name": "RealtimeRemoveChannelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 40, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L40" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 692, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeClient.ts", - "line": 40, - "character": 85, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeClient.ts#L40" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 712, - "name": "REALTIME_CHANNEL_STATES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/RealtimeChannel.ts", - "line": 151, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/RealtimeChannel.ts#L151" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 713, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 714, - "name": "closed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 33, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L33" - } - ], - "type": { - "type": "literal", - "value": "closed" - }, - "defaultValue": "'closed'" - }, - { - "id": 715, - "name": "errored", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 34, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L34" - } - ], - "type": { - "type": "literal", - "value": "errored" - }, - "defaultValue": "'errored'" - }, - { - "id": 716, - "name": "joined", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L35" - } - ], - "type": { - "type": "literal", - "value": "joined" - }, - "defaultValue": "'joined'" - }, - { - "id": 717, - "name": "joining", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L36" - } - ], - "type": { - "type": "literal", - "value": "joining" - }, - "defaultValue": "'joining'" - }, - { - "id": 718, - "name": "leaving", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 37, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L37" - } - ], - "type": { - "type": "literal", - "value": "leaving" - }, - "defaultValue": "'leaving'" - } - ], - "groups": [ - { - "title": "Properties", - "children": [714, 715, 716, 717, 718] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/src/lib/constants.ts", - "line": 32, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/realtime-js/src/lib/constants.ts#L32" - } - ] - } - }, - "defaultValue": "CHANNEL_STATES" - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [693, 698, 703, 707] - }, - { - "title": "Classes", - "children": [10, 396, 1, 719] - }, - { - "title": "Interfaces", - "children": [732, 782] - }, - { - "title": "Type Aliases", - "children": [380, 394, 573, 614, 621, 628, 652, 633, 643, 662, 672, 682, 691] - }, - { - "title": "Variables", - "children": [712] - } - ], - "packageName": "@supabase/realtime-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Realtime JS SDK

    \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
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/realtime-js)](https://www.npmjs.com/package/@supabase/realtime-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/realtime-js)](https://pkg.pr.new/~/supabase/realtime-js)\n\n
    \n\n# Overview\n\nThis SDK 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- 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## 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) => console.log(payload))\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 acknowledgment 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\n### Broadcast Replay\n\nBroadcast Replay enables **private** channels to access messages that were sent earlier. Only messages published via [Broadcast From the Database](https://supabase.com/docs/guides/realtime/broadcast#trigger-broadcast-messages-from-your-database) are available for replay.\n\nYou can configure replay with the following options:\n\n- **" - }, - { - "kind": "code", - "text": "`since`" - }, - { - "kind": "text", - "text": "** (Required): The epoch timestamp in milliseconds, specifying the earliest point from which messages should be retrieved.\n- **" - }, - { - "kind": "code", - "text": "`limit`" - }, - { - "kind": "text", - "text": "** (Optional): The number of messages to return. This must be a positive integer, with a maximum value of 25.\n\nExample:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst twelveHours = 12 * 60 * 60 * 1000\nconst twelveHoursAgo = Date.now() - twelveHours\n\nconst config = { private: true, broadcast: { replay: { since: twelveHoursAgo, limit: 10 } } }\n\nsupabase\n .channel('main:room', { config })\n .on('broadcast', { event: 'my_event' }, (payload) => {\n if (payload?.meta?.replayed) {\n console.log('This message was sent earlier:', payload)\n } else {\n console.log('This is a new message', payload)\n }\n // ...\n })\n .subscribe()\n```" - }, - { - "kind": "text", - "text": "\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('presence-test', {\n config: {\n presence: {\n key: '',\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(\n 'postgres_changes',\n { event: 'INSERT', schema: 'public', table: 'messages' },\n (payload) => {\n console.log('All inserts in messages table: ', payload)\n }\n)\n\nchannel.on(\n 'postgres_changes',\n { event: 'UPDATE', schema: 'public', table: 'users', filter: 'username=eq.Realtime' },\n (payload) => {\n console.log('All updates on users table when username is Realtime: ', payload)\n }\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.unsubscribe()\nclient.removeChannel(channel)\n```" - }, - { - "kind": "text", - "text": "\n\n- Remove all channels and close the connection\n\n" - }, - { - "kind": "code", - "text": "```js\n// Setup...\n\nclient.removeAllChannels()\nclient.disconnect()\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Complete build (from monorepo root)\npnpm nx build realtime-js\n\n# Build with watch mode for development\npnpm nx build realtime-js --watch\n\n# Individual build targets\npnpm nx build:main realtime-js # CommonJS build (dist/main/)\npnpm nx build:module realtime-js # ES Modules build (dist/module/)\n\n# Other useful commands\npnpm nx clean realtime-js # Clean build artifacts\npnpm nx lint realtime-js # Run ESLint\npnpm nx typecheck realtime-js # TypeScript type checking\n```" - }, - { - "kind": "text", - "text": "\n\n#### Build Outputs\n\n- **CommonJS (" - }, - { - "kind": "code", - "text": "`dist/main/`" - }, - { - "kind": "text", - "text": ")** - For Node.js environments\n- **ES Modules (" - }, - { - "kind": "code", - "text": "`dist/module/`" - }, - { - "kind": "text", - "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" - }, - { - "kind": "code", - "text": "`dist/module/index.d.ts`" - }, - { - "kind": "text", - "text": ")** - Type definitions for TypeScript projects\n\nNote: Unlike some other packages, realtime-js doesn't include a UMD build since it's primarily used in Node.js or bundled applications.\n\n#### Validating Package Exports\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Check if package exports are correctly configured\npnpm nx check-exports realtime-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command uses [\"Are the types wrong?\"](https://github.com/arethetypeswrong/arethetypeswrong.github.io) to verify that the package exports work correctly in different environments. Run this before publishing to ensure your package can be imported correctly by all consumers.\n\n### Testing\n\n**No Docker or Supabase instance required!** The realtime-js tests use mocked WebSocket connections, so they're completely self-contained.\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Run unit tests (from monorepo root)\npnpm nx test realtime-js\n\n# Run tests with coverage report\npnpm nx test:coverage realtime-js\n\n# Run tests in watch mode during development\npnpm nx test:watch realtime-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Scripts Explained\n\n- **test** - Runs all unit tests once using Vitest\n- **test:coverage** - Runs tests and generates coverage report with terminal output\n- **test:watch** - Runs tests in interactive watch mode for development\n\nThe tests mock WebSocket connections using " - }, - { - "kind": "code", - "text": "`mock-socket`" - }, - { - "kind": "text", - "text": ", so you can run them anytime without any external dependencies.\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 2 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\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" - }, - "2": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.__constructor" - }, - "3": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "channel" - }, - "5": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "opts" - }, - "6": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "7": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "9": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "default.channel" - }, - "10": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "15": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.__constructor" - }, - "16": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "17": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "topic" - }, - "18": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "params" - }, - "19": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "socket" - }, - "20": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.bindings" - }, - "21": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subTopic" - }, - "22": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.broadcastEndpointURL" - }, - "23": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.private" - }, - "24": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presence" - }, - "26": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "27": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "28": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "29": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "state" - }, - "30": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "31": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "32": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "33": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "34": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "35": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "36": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "37": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "38": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.topic" - }, - "39": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.params" - }, - "40": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.socket" - }, - "41": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "42": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "43": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "44": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "45": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "46": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "status" - }, - "47": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "err" - }, - "48": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "63": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "64": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "65": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "66": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "67": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "69": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "70": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "71": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "72": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "73": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "74": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "76": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "77": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "78": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "80": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "81": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "82": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "83": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "84": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "86": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "87": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "88": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "89": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "90": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "91": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "92": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "93": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "95": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "96": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "97": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "98": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "100": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "101": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "102": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "103": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "104": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "105": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "106": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "107": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "108": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "109": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "110": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "111": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "113": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "114": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "115": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "116": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "117": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "118": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "119": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "120": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "121": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "122": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "123": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "124": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "126": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "127": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "128": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "129": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "130": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "131": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "132": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "133": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "134": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "135": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "136": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "137": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "139": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "140": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "141": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "142": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "143": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "144": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "145": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "146": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "147": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "148": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "150": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "151": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "152": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "153": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "154": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "155": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "156": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "157": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "158": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "159": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "161": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "162": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "163": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "164": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "165": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "166": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "167": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "168": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "169": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "170": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "172": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "173": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "174": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "175": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "176": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "177": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "178": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "179": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "180": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "181": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "183": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "184": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "185": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "186": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "187": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "188": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "189": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "190": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "191": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "192": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "193": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "194": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "195": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "196": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "197": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "198": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "199": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "200": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "201": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "202": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "203": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "204": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "205": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "207": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "208": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "209": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "210": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "212": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "213": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "214": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "215": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "216": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "217": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "218": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "219": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "220": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "221": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "222": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "223": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "224": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "225": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "226": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "227": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "228": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "229": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "230": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "231": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "232": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "233": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "234": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "235": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "236": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "237": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "238": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "239": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "240": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "241": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "242": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "243": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "244": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "245": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "247": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "248": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "249": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "250": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "251": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "252": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "253": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "254": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "255": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "256": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "257": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "258": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "259": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "260": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "261": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "262": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "264": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "265": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "266": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "267": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "268": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "269": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "270": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "271": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "272": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "273": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "274": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "275": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "276": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "277": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "278": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "279": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "281": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "282": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "283": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "284": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "285": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "286": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "287": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "288": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "289": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "290": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "291": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "292": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "293": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "294": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "295": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "296": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "298": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "299": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "300": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "301": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "302": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "303": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "304": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "305": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "306": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "307": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "event" - }, - "308": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "309": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "310": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "311": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.timeout" - }, - "312": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "313": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "314": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "315": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "316": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.status" - }, - "317": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.error" - }, - "318": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "319": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "320": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "args" - }, - "321": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "322": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "323": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "324": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "325": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "327": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "328": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "329": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "331": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "332": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "333": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "334": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "335": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "336": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "337": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "338": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "369": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "370": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "371": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "other" - }, - "380": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelOptions" - }, - "381": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "382": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.config" - }, - "383": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "384": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.broadcast" - }, - "385": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "386": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.self" - }, - "387": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.ack" - }, - "388": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.replay" - }, - "389": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.presence" - }, - "390": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "391": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.key" - }, - "392": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.enabled" - }, - "393": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.private" - }, - "394": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelSendResponse" - }, - "395": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "396": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "397": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.__constructor" - }, - "398": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "399": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "endPoint" - }, - "400": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "options" - }, - "402": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channels" - }, - "403": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.accessTokenValue" - }, - "404": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.accessToken" - }, - "405": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "406": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "407": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.apiKey" - }, - "408": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.httpEndpoint" - }, - "409": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.headers" - }, - "410": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "411": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "413": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.params" - }, - "414": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "415": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "417": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.ref" - }, - "418": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.logLevel" - }, - "419": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.fetch" - }, - "420": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "421": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "422": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "423": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "424": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "425": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "426": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "427": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.worker" - }, - "428": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.workerUrl" - }, - "429": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.workerRef" - }, - "430": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.serializer" - }, - "431": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "432": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "433": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "434": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "435": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "436": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "437": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "438": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "439": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "440": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "441": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "442": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "443": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "444": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "445": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "446": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "447": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "448": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "449": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "450": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "451": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "452": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "453": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "454": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "455": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "456": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "457": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "tries" - }, - "458": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "459": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "460": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "461": { - "sourceFileName": "src/phoenix/socketAdapter.ts", - "qualifiedName": "__type" - }, - "462": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "463": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "464": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "465": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.open" - }, - "466": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.close" - }, - "467": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.error" - }, - "468": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.message" - }, - "475": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "476": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "477": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "478": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "479": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "480": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "481": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "code" - }, - "482": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "reason" - }, - "483": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "484": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "485": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "486": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "487": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "channel" - }, - "488": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "489": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "490": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "491": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "492": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "493": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "494": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "495": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "496": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "497": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "498": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "499": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "500": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "501": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "502": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "503": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "504": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "505": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "topic" - }, - "506": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "params" - }, - "507": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "508": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "509": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "510": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "511": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "512": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "token" - }, - "515": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "516": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "517": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "518": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "519": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "callback" - }, - "573": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeClientOptions" - }, - "574": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "575": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.transport" - }, - "576": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.timeout" - }, - "577": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatIntervalMs" - }, - "578": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatCallback" - }, - "579": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "580": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "581": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "status" - }, - "582": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "latency" - }, - "583": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.vsn" - }, - "584": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.logger" - }, - "585": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "586": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "587": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "588": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "589": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "590": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.encode" - }, - "591": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.decode" - }, - "592": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.reconnectAfterMs" - }, - "593": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "594": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "595": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "596": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.headers" - }, - "597": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "598": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "600": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.params" - }, - "601": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "602": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "604": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.log_level" - }, - "605": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.logLevel" - }, - "606": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.fetch" - }, - "607": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.worker" - }, - "608": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.workerUrl" - }, - "609": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.accessToken" - }, - "610": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "611": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "612": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.disconnectOnEmptyChannelsAfterMs" - }, - "613": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.sessionStorage" - }, - "614": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeMessage" - }, - "615": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.topic" - }, - "617": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.event" - }, - "618": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.payload" - }, - "619": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.ref" - }, - "620": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type.join_ref" - }, - "621": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesFilter" - }, - "622": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "623": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "624": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.schema" - }, - "625": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.table" - }, - "626": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.filter" - }, - "627": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "628": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayload" - }, - "629": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "630": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "631": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "633": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresInsertPayload" - }, - "634": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "635": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "636": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "637": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "638": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "639": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "640": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "641": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "643": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresUpdatePayload" - }, - "644": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "645": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "646": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "647": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "648": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "649": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "650": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "652": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresDeletePayload" - }, - "653": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "654": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "655": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "656": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "657": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "658": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "659": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "660": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "662": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceJoinPayload" - }, - "663": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "664": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "665": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "666": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "667": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.newPresences" - }, - "668": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "669": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "670": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "672": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceLeavePayload" - }, - "673": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "674": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "675": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "676": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "677": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.leftPresences" - }, - "678": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "679": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "680": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "682": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceState" - }, - "683": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "684": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "686": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "687": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "688": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "690": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "691": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "RealtimeRemoveChannelResponse" - }, - "692": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "693": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES" - }, - "694": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" - }, - "695": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" - }, - "696": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" - }, - "697": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" - }, - "698": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "699": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - }, - "700": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "701": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "702": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "703": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" - }, - "704": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" - }, - "705": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "706": { - "sourceFileName": "src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "707": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES" - }, - "708": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" - }, - "709": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" - }, - "710": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" - }, - "711": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" - }, - "712": { - "sourceFileName": "src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_CHANNEL_STATES" - }, - "713": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object" - }, - "714": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.closed" - }, - "715": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.errored" - }, - "716": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.joined" - }, - "717": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.joining" - }, - "718": { - "sourceFileName": "src/lib/constants.ts", - "qualifiedName": "__object.leaving" - }, - "719": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory" - }, - "722": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "723": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "724": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "725": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "726": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "url" - }, - "727": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "protocols" - }, - "728": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "729": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "732": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike" - }, - "733": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CONNECTING" - }, - "734": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.OPEN" - }, - "735": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSING" - }, - "736": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSED" - }, - "737": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.readyState" - }, - "738": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.url" - }, - "739": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.protocol" - }, - "740": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "741": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "742": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "code" - }, - "743": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "reason" - }, - "744": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "745": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "746": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "data" - }, - "747": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onopen" - }, - "748": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "749": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "750": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "751": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "752": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onmessage" - }, - "753": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "754": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "755": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "756": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "757": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onclose" - }, - "758": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "760": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "761": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "762": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onerror" - }, - "763": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "765": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "766": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "767": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "768": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "769": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "770": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "771": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "772": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "773": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "774": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "775": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.binaryType" - }, - "776": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.bufferedAmount" - }, - "777": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.extensions" - }, - "778": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.dispatchEvent" - }, - "779": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "780": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "781": { - "sourceFileName": "src/lib/websocket-factory.ts", - "qualifiedName": "event" - }, - "782": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "783": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "784": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "785": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "address" - }, - "786": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "subprotocols" - }, - "787": { - "sourceFileName": "src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor.__index" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 0 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/storage.json b/apps/docs/spec/enrichments/tsdoc_v2/storage.json deleted file mode 100644 index d121fa2e9f3..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/storage.json +++ /dev/null @@ -1,35693 +0,0 @@ -{ - "id": 0, - "name": "@supabase/storage-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1, - "name": "index", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 1456, - "name": "StorageVectorsErrorCode", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error codes specific to S3 Vectors API\nMaps AWS service errors to application-friendly error codes" - } - ] - }, - "children": [ - { - "id": 1457, - "name": "InternalError", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Internal server fault (HTTP 500)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 149, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L149" - } - ], - "type": { - "type": "literal", - "value": "InternalError" - } - }, - { - "id": 1460, - "name": "S3VectorBucketNotEmpty", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete bucket while not empty (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L155" - } - ], - "type": { - "type": "literal", - "value": "S3VectorBucketNotEmpty" - } - }, - { - "id": 1458, - "name": "S3VectorConflictException", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource already exists / conflict (HTTP 409)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L151" - } - ], - "type": { - "type": "literal", - "value": "S3VectorConflictException" - } - }, - { - "id": 1461, - "name": "S3VectorMaxBucketsExceeded", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exceeds bucket quota/limit (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 157, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L157" - } - ], - "type": { - "type": "literal", - "value": "S3VectorMaxBucketsExceeded" - } - }, - { - "id": 1462, - "name": "S3VectorMaxIndexesExceeded", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exceeds index quota/limit (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 159, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L159" - } - ], - "type": { - "type": "literal", - "value": "S3VectorMaxIndexesExceeded" - } - }, - { - "id": 1459, - "name": "S3VectorNotFoundException", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource not found (HTTP 404)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L153" - } - ], - "type": { - "type": "literal", - "value": "S3VectorNotFoundException" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [1457, 1460, 1458, 1461, 1462, 1459] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 147, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L147" - } - ] - }, - { - "id": 1371, - "name": "StorageApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "API error returned from Storage service\nIncludes HTTP status code and service-specific error code" - } - ] - }, - "children": [ - { - "id": 1372, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L62" - } - ], - "signatures": [ - { - "id": 1373, - "name": "StorageApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L62" - } - ], - "parameters": [ - { - "id": 1374, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1375, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1376, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1377, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - } - ], - "type": { - "type": "reference", - "target": 1371, - "name": "StorageApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1378, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 59, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1379, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 60, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L60" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1380, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "signatures": [ - { - "id": 1381, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1382, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1384, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 76, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L76" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1383, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 75, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1385, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 77, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L77" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1386, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 78, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L78" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1384, 1383, 1385, 1386] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1372] - }, - { - "title": "Properties", - "children": [1378, 1379] - }, - { - "title": "Methods", - "children": [1380] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 58, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L58" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1422, - "name": "StorageVectorsApiError" - } - ] - }, - { - "id": 984, - "name": "StorageClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 985, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L36" - } - ], - "signatures": [ - { - "id": 986, - "name": "StorageClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a client for Storage buckets, files, analytics, and vectors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst avatars = supabase.storage.from('avatars')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {\n apikey: 'your-publishable-key',\n})\nconst avatars = storage.from('avatars')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L36" - } - ], - "parameters": [ - { - "id": 987, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 988, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 989, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 38, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L38" - } - ], - "indexSignatures": [ - { - "id": 990, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 38, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L38" - } - ], - "parameters": [ - { - "id": 991, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 992, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 993, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 994, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 995, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 996, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 997, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 998, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 999, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1000, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1112, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 984, - "name": "StorageClient", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 138, - "name": "default.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 137, - "name": "default.constructor" - } - }, - { - "id": 1006, - "name": "analytics", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 95, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L95" - } - ], - "getSignature": { - "id": 1007, - "name": "analytics", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access analytics storage operations using Iceberg tables.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A StorageAnalyticsClient instance configured with the current storage settings." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 95, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L95" - } - ], - "type": { - "type": "reference", - "target": 48, - "name": "StorageAnalyticsClient", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1004, - "name": "vectors", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L75" - } - ], - "getSignature": { - "id": 1005, - "name": "vectors", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access vector storage operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A StorageVectorsClient instance configured with the current storage settings." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L75" - } - ], - "type": { - "type": "reference", - "target": 549, - "name": "StorageVectorsClient", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1026, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "signatures": [ - { - "id": 1027, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created bucket name or error" - } - ] - }, - { - "tag": "@example", - "name": "Create bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "parameters": [ - { - "id": 1028, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are creating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1029, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1030, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1033, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L193" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1032, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 192, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L192" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1031, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 191, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1034, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "(private-beta) specifies the bucket type. see " - }, - { - "kind": "code", - "text": "`BucketType`" - }, - { - "kind": "text", - "text": " for more details.\n - default bucket type is " - }, - { - "kind": "code", - "text": "`STANDARD`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1033, 1032, 1031, 1034] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1035, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1036, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 200, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "name" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1037, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 201, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1036, 1037] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 199, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L199" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1039, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 204, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1040, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1039, 1040] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 203, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 172, - "name": "default.createBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 171, - "name": "default.createBucket" - } - }, - { - "id": 1068, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "signatures": [ - { - "id": 1069, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " - }, - { - "kind": "code", - "text": "`empty()`" - }, - { - "kind": "text", - "text": " the bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "parameters": [ - { - "id": 1070, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1071, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1072, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1074, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1074] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ] - } - } - }, - { - "id": 1075, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L381" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1072, 1075] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1076, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1077, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 384, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L384" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1078, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L385" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1077, 1078] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 383, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L383" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 214, - "name": "default.deleteBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 213, - "name": "default.deleteBucket" - } - }, - { - "id": 1057, - "name": "emptyBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "signatures": [ - { - "id": 1058, - "name": "emptyBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes all objects inside a single bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Empty bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "parameters": [ - { - "id": 1059, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to empty." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1060, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1061, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1062, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1063, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1063] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ] - } - } - }, - { - "id": 1064, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L334" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1061, 1064] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 332, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1065, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1066, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L337" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1067, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 338, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L338" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1066, 1067] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 336, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L336" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 203, - "name": "default.emptyBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 202, - "name": "default.emptyBucket" - } - }, - { - "id": 1001, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L58" - } - ], - "signatures": [ - { - "id": 1002, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform file operation in a bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Accessing a bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst avatars = supabase.storage.from('avatars')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L58" - } - ], - "parameters": [ - { - "id": 1003, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The bucket id to operate on." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 261, - "name": "StorageFileApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1017, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "signatures": [ - { - "id": 1018, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing Storage bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing bucket details or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "parameters": [ - { - "id": 1019, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to retrieve." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1020, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1021, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 131, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L131" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 1022, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 132, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1021, 1022] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 130, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1023, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1024, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L135" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1025, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 136, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L136" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1024, 1025] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 134, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 163, - "name": "default.getBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 162, - "name": "default.getBucket" - } - }, - { - "id": 1008, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "signatures": [ - { - "id": 1009, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Storage buckets within an existing project." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "List buckets with options", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "parameters": [ - { - "id": 1010, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reference", - "target": 1135, - "name": "ListBucketOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "limit": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ], - "offset": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ], - "sortColumn": [ - { - "kind": "text", - "text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')" - } - ], - "sortOrder": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ], - "search": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1011, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1012, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1013, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L74" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1012, 1013] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 72, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1014, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1015, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 77, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1016, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 78, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1015, 1016] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 154, - "name": "default.listBuckets" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 153, - "name": "default.listBuckets" - } - }, - { - "id": 1096, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 1097, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 1098, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1099, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 245, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 244, - "name": "default.setHeader" - } - }, - { - "id": 1094, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 1095, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 243, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 242, - "name": "default.throwOnError" - } - }, - { - "id": 1041, - "name": "updateBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "signatures": [ - { - "id": 1042, - "name": "updateBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Update bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "parameters": [ - { - "id": 1043, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are updating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1044, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1045, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1048, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 272, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1047, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 271, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1046, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 270, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L270" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1048, 1047, 1046] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 269, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L269" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1050, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1051, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1052, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1052] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ] - } - } - }, - { - "id": 1053, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1050, 1053] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1054, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1055, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 280, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L280" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1056, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 281, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L281" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1055, 1056] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L279" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 187, - "name": "default.updateBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 186, - "name": "default.updateBucket" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [985] - }, - { - "title": "Accessors", - "children": [1006, 1004] - }, - { - "title": "Methods", - "children": [1026, 1068, 1057, 1001, 1017, 1008, 1096, 1094, 1041] - } - ], - "categories": [ - { - "title": "Other", - "children": [1096, 1094] - }, - { - "title": "Storage", - "children": [985, 1006, 1004, 1026, 1068, 1057, 1001, 1017, 1008, 1041] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L11" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 136, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1353, - "name": "StorageError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error class for all Storage errors\nSupports both 'storage' and 'vectors' namespaces" - } - ] - }, - "children": [ - { - "id": 1354, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L17" - } - ], - "signatures": [ - { - "id": 1355, - "name": "StorageError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L17" - } - ], - "parameters": [ - { - "id": 1356, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1357, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - }, - { - "id": 1358, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1359, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 1362, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1363, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1364, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1365, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1368, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1367, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1369, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1370, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1368, 1367, 1369, 1370] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1354] - }, - { - "title": "Properties", - "children": [1362, 1363] - }, - { - "title": "Methods", - "children": [1364] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L11" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1371, - "name": "StorageApiError" - }, - { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError" - }, - { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError" - } - ] - }, - { - "id": 1389, - "name": "StorageUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unknown error that doesn't match expected error patterns\nWraps the original error for debugging" - } - ] - }, - "children": [ - { - "id": 1390, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L93" - } - ], - "signatures": [ - { - "id": 1391, - "name": "StorageUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L93" - } - ], - "parameters": [ - { - "id": 1392, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1393, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1394, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - } - ], - "type": { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1395, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 91, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L91" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1398, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1399, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1400, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1401, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1404, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1403, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1405, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1406, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1404, 1403, 1405, 1406] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1390] - }, - { - "title": "Properties", - "children": [1395, 1398, 1399] - }, - { - "title": "Methods", - "children": [1400] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 90, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L90" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1439, - "name": "StorageVectorsUnknownError" - } - ] - }, - { - "id": 1422, - "name": "StorageVectorsApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageApiError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1423, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L128" - } - ], - "signatures": [ - { - "id": 1424, - "name": "StorageVectorsApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L128" - } - ], - "parameters": [ - { - "id": 1425, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1426, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1427, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1422, - "name": "StorageVectorsApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1373, - "name": "StorageApiError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1372, - "name": "StorageApiError.constructor" - } - }, - { - "id": 1428, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 59, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1378, - "name": "StorageApiError.status" - } - }, - { - "id": 1429, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 60, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L60" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1379, - "name": "StorageApiError.statusCode" - } - }, - { - "id": 1430, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "signatures": [ - { - "id": 1431, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1432, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1434, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 76, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L76" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1433, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 75, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1435, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 77, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L77" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1436, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 78, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L78" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1434, 1433, 1435, 1436] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1381, - "name": "StorageApiError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1380, - "name": "StorageApiError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1423] - }, - { - "title": "Properties", - "children": [1428, 1429] - }, - { - "title": "Methods", - "children": [1430] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 127, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L127" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1371, - "name": "StorageApiError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1407, - "name": "StorageVectorsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1408, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L109" - } - ], - "signatures": [ - { - "id": 1409, - "name": "StorageVectorsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L109" - } - ], - "parameters": [ - { - "id": 1410, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1413, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1414, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1415, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1416, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1417, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1419, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1418, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1420, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1421, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1419, 1418, 1420, 1421] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1408] - }, - { - "title": "Properties", - "children": [1413, 1414] - }, - { - "title": "Methods", - "children": [1415] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 108, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L108" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1439, - "name": "StorageVectorsUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageUnknownError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1440, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L138" - } - ], - "signatures": [ - { - "id": 1441, - "name": "StorageVectorsUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L138" - } - ], - "parameters": [ - { - "id": 1442, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1443, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 1439, - "name": "StorageVectorsUnknownError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1391, - "name": "StorageUnknownError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1390, - "name": "StorageUnknownError.constructor" - } - }, - { - "id": 1444, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 91, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L91" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 1395, - "name": "StorageUnknownError.originalError" - } - }, - { - "id": 1447, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1398, - "name": "StorageUnknownError.status" - } - }, - { - "id": 1448, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1399, - "name": "StorageUnknownError.statusCode" - } - }, - { - "id": 1449, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1450, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1451, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1453, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1452, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1454, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1455, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1453, 1452, 1454, 1455] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1401, - "name": "StorageUnknownError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1400, - "name": "StorageUnknownError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1440] - }, - { - "title": "Properties", - "children": [1444, 1447, 1448] - }, - { - "title": "Methods", - "children": [1449] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 137, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L137" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1141, - "name": "AnalyticBucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents an Analytics Bucket using Apache Iceberg table format.\nAnalytics buckets are optimized for analytical queries and data processing." - } - ] - }, - "children": [ - { - "id": 1145, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ISO 8601 timestamp of bucket creation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 42, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L42" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1144, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage format used (e.g., 'iceberg')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 40, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L40" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1142, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1143, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bucket type - always 'ANALYTICS' for analytics buckets" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L38" - } - ], - "type": { - "type": "literal", - "value": "ANALYTICS" - } - }, - { - "id": 1146, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ISO 8601 timestamp of last update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1145, 1144, 1142, 1143, 1146] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 34, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L34" - } - ] - }, - { - "id": 1125, - "name": "Bucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1131, - "name": "allowed_mime_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 16, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L16" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1132, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L17" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1130, - "name": "file_size_limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L15" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1126, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 11, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1128, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1129, - "name": "owner", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1134, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1127, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L12" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - }, - { - "id": 1133, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L18" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1131, 1132, 1130, 1126, 1128, 1129, 1134, 1127, 1133] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 10, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L10" - } - ] - }, - { - "id": 1307, - "name": "DeleteVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch deleting vectors" - } - ] - }, - "children": [ - { - "id": 1309, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L549" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1310, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector keys to delete (1-500 items)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L550" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1308, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L548" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1309, 1310, 1308] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 547, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L547" - } - ] - }, - { - "id": 1190, - "name": "DestinationOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1191, - "name": "destinationBucket", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 176, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L176" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1191] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 175, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L175" - } - ] - }, - { - "id": 1243, - "name": "EncryptionConfiguration", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration for encryption at rest" - } - ] - }, - "children": [ - { - "id": 1244, - "name": "kmsKeyArn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ARN of the KMS key used for encryption" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 362, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L362" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1245, - "name": "sseType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server-side encryption type (e.g., 'KMS')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 363, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L363" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1244, 1245] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 361, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L361" - } - ] - }, - { - "id": 1341, - "name": "ErrorResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Standard response wrapper for failed operations" - } - ] - }, - "children": [ - { - "id": 1342, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Null on error" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 646, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L646" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1343, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "StorageError with details (named StorageVectorsError for vector operations)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 647, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L647" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1342, 1343] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 645, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L645" - } - ] - }, - { - "id": 1222, - "name": "FetchParameters", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1224, - "name": "cache", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Controls how the request interacts with the browser's HTTP cache.\n- 'default': Use standard cache behavior\n- 'no-store': Bypass cache entirely (useful in Edge Functions)\n- 'reload': Bypass cache but update it with response\n- 'no-cache': Validate with server before using cached response\n- 'force-cache': Use cache even if stale\n- 'only-if-cached': Only use cache, fail if not cached" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 296, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L296" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "default" - }, - { - "type": "literal", - "value": "no-store" - }, - { - "type": "literal", - "value": "reload" - }, - { - "type": "literal", - "value": "no-cache" - }, - { - "type": "literal", - "value": "force-cache" - }, - { - "type": "literal", - "value": "only-if-cached" - } - ] - } - }, - { - "id": 1223, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pass in an AbortController's signal to cancel the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 285, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L285" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1224, 1223] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 281, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L281" - } - ] - }, - { - "id": 1147, - "name": "FileMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata object returned by the Storage API for files\nContains information about file size, type, caching, and HTTP response details" - } - ] - }, - "children": [ - { - "id": 1151, - "name": "cacheControl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cache control directive (e.g., \"max-age=3600\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 59, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1153, - "name": "contentLength", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Content length in bytes (usually same as size)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 63, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L63" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1148, - "name": "eTag", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Entity tag for caching and conditional requests" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 53, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L53" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1154, - "name": "httpStatusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code from the storage backend" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L65" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1152, - "name": "lastModified", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last modification timestamp (ISO 8601)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 61, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L61" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1150, - "name": "mimetype", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "MIME type of the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 57, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L57" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1149, - "name": "size", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File size in bytes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L55" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1151, 1153, 1148, 1154, 1152, 1150, 1149] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 51, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L51" - } - ], - "indexSignatures": [ - { - "id": 1155, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Any additional custom metadata stored with the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L67" - } - ], - "parameters": [ - { - "id": 1156, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1157, - "name": "FileObject", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the List V1 API (list() method)\nNote: Folder entries will have null values for most fields except name\n\nWarning: Some fields may not be present in all API responses. Fields like\nbucket_id, owner, and buckets are not returned by list() operations." - } - ] - }, - "children": [ - { - "id": 1164, - "name": "bucket_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Bucket identifier - NOT returned by list() operations.\nMay be present in remove() responses. Do not rely on this field." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L94" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1166, - "name": "buckets", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Bucket object - NOT returned by list() or remove() operations.\nThis field should not be relied upon." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 104, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L104" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 1161, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 85, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L85" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1159, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 81, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L81" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1162, - "name": "last_accessed_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Last access timestamp (null for folders)" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 87, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L87" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1163, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File metadata including size, mimetype, etc. (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 89, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L89" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1158, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File or folder name (relative to the prefix) - always present" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1165, - "name": "owner", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Owner identifier - NOT returned by list() or remove() operations.\nThis field should not be relied upon." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 99, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L99" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1160, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last update timestamp (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L83" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1164, 1166, 1161, 1159, 1162, 1163, 1158, 1165, 1160] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 77, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L77" - } - ] - }, - { - "id": 1167, - "name": "FileObjectV2", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the Info endpoint (info() method)\nContains detailed metadata for a specific file" - } - ] - }, - "children": [ - { - "id": 1171, - "name": "bucket_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bucket identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 119, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1174, - "name": "cache_control", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cache control header value" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L125" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1175, - "name": "content_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "MIME content type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 127, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L127" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1172, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L121" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1176, - "name": "etag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Entity tag for caching" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L129" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1168, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1177, - "name": "last_modified", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last modification timestamp (replaces updated_at)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 131, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1178, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom file metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 133, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L133" - } - ], - "type": { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - }, - { - "id": 1170, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1173, - "name": "size", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File size in bytes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1179, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The API returns last_modified instead.\nThis field may not be present in responses." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L138" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1169, - "name": "version", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File version identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1171, 1174, 1175, 1172, 1176, 1168, 1177, 1178, 1170, 1173, 1179, 1169] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 111, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L111" - } - ] - }, - { - "id": 1183, - "name": "FileOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1184, - "name": "cacheControl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " - }, - { - "kind": "code", - "text": "`Cache-Control: max-age=`" - }, - { - "kind": "text", - "text": " header. Defaults to 3600 seconds." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 150, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L150" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1185, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header value. Should be specified if using a " - }, - { - "kind": "code", - "text": "`fileBody`" - }, - { - "kind": "text", - "text": " that is neither " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": " nor " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " nor " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": ", otherwise will default to " - }, - { - "kind": "code", - "text": "`text/plain;charset=UTF-8`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 154, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L154" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1187, - "name": "duplex", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 162, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1189, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optionally add extra headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 172, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L172" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1188, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 167, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L167" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1186, - "name": "upsert", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L158" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1184, 1185, 1187, 1189, 1188, 1186] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 146, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L146" - } - ] - }, - { - "id": 1295, - "name": "GetVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch reading vectors" - } - ] - }, - "children": [ - { - "id": 1297, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L515" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1298, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector keys to retrieve" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L516" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1299, - "name": "returnData", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include vector data in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L517" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1300, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 518, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L518" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1296, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 514, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L514" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1297, 1298, 1299, 1300, 1296] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 513, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L513" - } - ] - }, - { - "id": 1301, - "name": "GetVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from getting vectors" - } - ] - }, - "children": [ - { - "id": 1302, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of retrieved vector objects" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 526, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L526" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1302] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 525, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L525" - } - ] - }, - { - "id": 1135, - "name": "ListBucketOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1136, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L23" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1137, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1140, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L27" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1138, - "name": "sortColumn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L25" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "id" - }, - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 1139, - "name": "sortOrder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L26" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1136, 1137, 1140, 1138, 1139] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 22, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L22" - } - ] - }, - { - "id": 1285, - "name": "ListIndexesOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing indexes within a bucket" - } - ] - }, - "children": [ - { - "id": 1288, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 100)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L491" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1289, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 492, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1287, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter indexes by name prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1286, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the parent vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 489, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L489" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1288, 1289, 1287, 1286] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 488, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L488" - } - ] - }, - { - "id": 1290, - "name": "ListIndexesResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing indexes" - } - ] - }, - "children": [ - { - "id": 1291, - "name": "indexes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of index names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1292, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1293, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1293] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ] - } - } - } - }, - { - "id": 1294, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 502, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L502" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1291, 1294] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 500, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L500" - } - ] - }, - { - "id": 1276, - "name": "ListVectorBucketsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for fetching vector buckets" - } - ] - }, - "children": [ - { - "id": 1278, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 100)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 467, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L467" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1279, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L468" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1277, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter buckets by name prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 466, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L466" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1278, 1279, 1277] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 465, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L465" - } - ] - }, - { - "id": 1280, - "name": "ListVectorBucketsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing vector buckets" - } - ] - }, - "children": [ - { - "id": 1284, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1281, - "name": "vectorBuckets", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of bucket names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1282, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1283, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1283] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1284, 1281] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 476, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L476" - } - ] - }, - { - "id": 1311, - "name": "ListVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing/scanning vectors in an index\nSupports parallel scanning via segment configuration" - } - ] - }, - "children": [ - { - "id": 1313, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 567, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L567" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1314, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 500, max: 1000)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 568, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L568" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1315, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 569, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L569" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1316, - "name": "returnData", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include vector data in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L570" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1317, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L571" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1318, - "name": "segmentCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of parallel segments (1-16)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 572, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L572" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1319, - "name": "segmentIndex", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Zero-based index of this segment (0 to segmentCount-1)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 573, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L573" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1312, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L566" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1313, 1314, 1315, 1316, 1317, 1318, 1319, 1312] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 565, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L565" - } - ] - }, - { - "id": 1320, - "name": "ListVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing vectors" - } - ] - }, - "children": [ - { - "id": 1322, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 583, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L583" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1321, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector objects" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 582, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L582" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1322, 1321] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 581, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L581" - } - ] - }, - { - "id": 1225, - "name": "Metadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1226, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1226] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 300, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L300" - } - ] - }, - { - "id": 1250, - "name": "MetadataConfiguration", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata configuration for vector index\nDefines which metadata keys should not be indexed for filtering" - } - ] - }, - "children": [ - { - "id": 1251, - "name": "nonFilterableMetadataKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of metadata keys that cannot be used in filters" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 384, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L384" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1251] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 383, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L383" - } - ] - }, - { - "id": 1303, - "name": "PutVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch inserting/updating vectors" - } - ] - }, - "children": [ - { - "id": 1305, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 537, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L537" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1304, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L536" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1306, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vectors to insert/upsert (1-500 items)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 538, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L538" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1267, - "name": "VectorObject", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1305, 1304, 1306] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 535, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L535" - } - ] - }, - { - "id": 1324, - "name": "QueryVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for querying similar vectors (ANN search)" - } - ] - }, - "children": [ - { - "id": 1329, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional JSON filter for metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 607, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L607" - } - ], - "type": { - "type": "reference", - "target": 1323, - "name": "VectorFilter", - "package": "@supabase/storage-js" - } - }, - { - "id": 1326, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 604, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L604" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1327, - "name": "queryVector", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query vector to find similar vectors" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L605" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1330, - "name": "returnDistance", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include distance scores" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 608, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L608" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1331, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in results" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 609, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L609" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1328, - "name": "topK", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of nearest neighbors to return (default: 10)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 606, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L606" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1325, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 603, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L603" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1329, 1326, 1327, 1330, 1331, 1328, 1325] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 602, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L602" - } - ] - }, - { - "id": 1332, - "name": "QueryVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from vector similarity query" - } - ] - }, - "children": [ - { - "id": 1334, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The distance metric used for the similarity search" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 619, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L619" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 1333, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of similar vectors ordered by distance" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L618" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1334, 1333] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 617, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L617" - } - ] - }, - { - "id": 1192, - "name": "SearchOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1193, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of files you want to be returned." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n100\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 184, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L184" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1194, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 189, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L189" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1196, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The search string to filter files by." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1195, - "name": "sortBy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to sort by. Can be any column inside a FileObject." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 194, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1180, - "name": "SortBy", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1193, 1194, 1196, 1195] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 179, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L179" - } - ] - }, - { - "id": 1214, - "name": "SearchV2Folder", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Folder entry returned by the List V2 API (listV2() method) when using with_delimiter: true" - } - ] - }, - "children": [ - { - "id": 1216, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full folder key/path" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 271, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L271" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1215, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Folder name/prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 269, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L269" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1216, 1215] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 267, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L267" - } - ] - }, - { - "id": 1206, - "name": "SearchV2Object", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the List V2 API (listV2() method)\nObjects and folders are returned in separate arrays - this type represents\nactual files only. Use SearchV2Folder for folder entries." - } - ] - }, - "children": [ - { - "id": 1211, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 257, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L257" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1209, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 253, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L253" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1208, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full object key/path" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 251, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L251" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1213, - "name": "last_accessed_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Last access timestamp" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L261" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1212, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File metadata including size, mimetype, etc. (null if not yet set)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 259, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L259" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1207, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L249" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1210, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last update timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 255, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L255" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1211, 1209, 1208, 1213, 1212, 1207, 1210] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 247, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L247" - } - ] - }, - { - "id": 1200, - "name": "SearchV2Options", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1203, - "name": "cursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cursor used for pagination. Pass the value received from nextCursor of the previous request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 222, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1201, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of files you want to be returned." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n1000\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 212, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L212" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1202, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix search string to filter files by." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 217, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L217" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1205, - "name": "sortBy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column and order to sort by" - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n'name asc'\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 239, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L239" - } - ], - "type": { - "type": "reference", - "target": 1197, - "name": "SortByV2", - "package": "@supabase/storage-js" - } - }, - { - "id": 1204, - "name": "with_delimiter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to emulate a hierarchical listing of objects using delimiters.\n\n- When " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " (default), all objects are listed as flat key/value pairs.\n- When " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the response groups objects by delimiter, making it appear\n like a file/folder hierarchy." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 233, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L233" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1203, 1201, 1202, 1205, 1204] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 207, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L207" - } - ] - }, - { - "id": 1217, - "name": "SearchV2Result", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1219, - "name": "folders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 276, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L276" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1214, - "name": "SearchV2Folder", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1218, - "name": "hasNext", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 275, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L275" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1221, - "name": "nextCursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 278, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L278" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1220, - "name": "objects", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L277" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1206, - "name": "SearchV2Object", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1219, 1218, 1221, 1220] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 274, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L274" - } - ] - }, - { - "id": 1180, - "name": "SortBy", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1181, - "name": "column", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L142" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 143, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L143" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1181, 1182] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 141, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L141" - } - ] - }, - { - "id": 1197, - "name": "SortByV2", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1198, - "name": "column", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 203, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L203" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 1199, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 204, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L204" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1198, 1199] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 202, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L202" - } - ] - }, - { - "id": 1112, - "name": "StorageClientOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1113, - "name": "useNewHostname", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L8" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 7, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L7" - } - ] - }, - { - "id": 1337, - "name": "SuccessResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Standard response wrapper for successful operations" - } - ] - }, - "children": [ - { - "id": 1338, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response data of type T" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 636, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L636" - } - ], - "type": { - "type": "reference", - "target": 1340, - "name": "T", - "package": "@supabase/storage-js", - "qualifiedName": "SuccessResponse.T", - "refersToTypeParameter": true - } - }, - { - "id": 1339, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Null on success" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 637, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L637" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1338, 1339] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L635" - } - ], - "typeParameters": [ - { - "id": 1340, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ] - }, - { - "id": 1227, - "name": "TransformOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1232, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 332, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L332" - } - ], - "type": { - "type": "literal", - "value": "origin" - } - }, - { - "id": 1229, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the image in pixels." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 312, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L312" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1231, - "name": "quality", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 325, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L325" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1230, - "name": "resize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 319, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L319" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "cover" - }, - { - "type": "literal", - "value": "contain" - }, - { - "type": "literal", - "value": "fill" - } - ] - } - }, - { - "id": 1228, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the image in pixels." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1232, 1229, 1231, 1230, 1228] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 304, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L304" - } - ] - }, - { - "id": 1246, - "name": "VectorBucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector bucket metadata" - } - ] - }, - "children": [ - { - "id": 1248, - "name": "creationTime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unix timestamp of when the bucket was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L374" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1249, - "name": "encryptionConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional encryption settings" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 375, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L375" - } - ], - "type": { - "type": "reference", - "target": 1243, - "name": "EncryptionConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 1247, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 373, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L373" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1248, 1249, 1247] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 372, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L372" - } - ] - }, - { - "id": 1264, - "name": "VectorData", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector data representation\nVectors must be float32 arrays with dimensions matching the index" - } - ] - }, - "children": [ - { - "id": 1265, - "name": "float32", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of 32-bit floating point numbers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L424" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "number" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1265] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 423, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L423" - } - ] - }, - { - "id": 1335, - "name": "VectorFetchParameters", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fetch-specific parameters like abort signals" - } - ] - }, - "children": [ - { - "id": 1336, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AbortSignal for cancelling requests" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 627, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L627" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1336] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 626, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L626" - } - ] - }, - { - "id": 1256, - "name": "VectorIndex", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector index configuration and metadata" - } - ] - }, - "children": [ - { - "id": 1263, - "name": "creationTime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unix timestamp of when the index was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L415" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1259, - "name": "dataType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data type of vector components (currently only 'float32')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L411" - } - ], - "type": { - "type": "reference", - "target": 1252, - "name": "VectorDataType", - "package": "@supabase/storage-js" - } - }, - { - "id": 1260, - "name": "dimension", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Dimensionality of vectors (e.g., 384, 768, 1536)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 412, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L412" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1261, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Similarity metric used for queries" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 413, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L413" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 1257, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name of the index within the bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L409" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1262, - "name": "metadataConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration for metadata filtering" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 414, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L414" - } - ], - "type": { - "type": "reference", - "target": 1250, - "name": "MetadataConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 1258, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the parent vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L410" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1263, 1259, 1260, 1261, 1257, 1262, 1258] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 408, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L408" - } - ] - }, - { - "id": 1271, - "name": "VectorMatch", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector object returned from queries with optional distance" - } - ] - }, - "children": [ - { - "id": 1273, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector embedding data (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 454, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L454" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1275, - "name": "distance", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Similarity distance from query vector (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1272, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the vector" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1274, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arbitrary metadata (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 455, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L455" - } - ], - "type": { - "type": "reference", - "target": 1266, - "name": "VectorMetadata", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1273, 1275, 1272, 1274] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 452, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L452" - } - ] - }, - { - "id": 1267, - "name": "VectorObject", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Single vector object for insertion/update" - } - ] - }, - "children": [ - { - "id": 1269, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector embedding data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 441, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L441" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1268, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the vector" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 440, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L440" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1270, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional arbitrary metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 442, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L442" - } - ], - "type": { - "type": "reference", - "target": 1266, - "name": "VectorMetadata", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1269, 1268, 1270] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 439, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L439" - } - ] - }, - { - "id": 1344, - "name": "ApiResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Union type for all API responses\nFollows the pattern: { data: T, error: null } | { data: null, error: Error }" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 654, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L654" - } - ], - "typeParameters": [ - { - "id": 1345, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1337, - "typeArguments": [ - { - "type": "reference", - "target": 1345, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "SuccessResponse", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 1341, - "name": "ErrorResponse", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1123, - "name": "BucketType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of storage bucket\n- STANDARD: Regular file storage buckets\n- ANALYTICS: Iceberg table-based buckets for analytical workloads" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 8, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L8" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1124, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 8, - "character": 62, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L8" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1233, - "name": "Camelize", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 339, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L339" - } - ], - "typeParameters": [ - { - "id": 1234, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1234, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1234, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - "nameType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CamelCase" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Extract", - "package": "typescript" - } - ], - "name": "CamelCase", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1254, - "name": "DistanceMetric", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Distance metrics for vector similarity search" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 396, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L396" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "cosine" - }, - { - "type": "literal", - "value": "euclidean" - }, - { - "type": "literal", - "value": "dotproduct" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1255, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 396, - "character": 79, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L396" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1235, - "name": "DownloadResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 343, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L343" - } - ], - "typeParameters": [ - { - "id": 1242, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1236, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1237, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 345, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L345" - } - ], - "type": { - "type": "reference", - "target": 1242, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - { - "id": 1238, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 346, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L346" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1237, 1238] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 344, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L344" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1239, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1240, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 349, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L349" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1241, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 350, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L350" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1240, 1241] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 348, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L348" - } - ] - } - } - ] - } - }, - { - "id": 1352, - "name": "ErrorNamespace", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace type for error classes\nDetermines the error class names and type guards" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 5, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L5" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "storage" - }, - { - "type": "literal", - "value": "vectors" - } - ] - } - }, - { - "id": 1252, - "name": "VectorDataType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supported data types for vectors\nCurrently only float32 is supported" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 391, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L391" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "float32" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1253, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 391, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L391" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1323, - "name": "VectorFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON filter expression for metadata filtering\nFormat and syntax depend on the S3 Vectors service implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 590, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L590" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1266, - "name": "VectorMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arbitrary JSON metadata attached to vectors\nKeys configured as non-filterable in the index can be stored but not queried" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 431, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L431" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1346, - "name": "isStorageError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L50" - } - ], - "signatures": [ - { - "id": 1347, - "name": "isStorageError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type guard to check if an error is a StorageError" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "True if the error is a StorageError" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L50" - } - ], - "parameters": [ - { - "id": 1348, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The error to check" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - } - ] - }, - { - "id": 1349, - "name": "isStorageVectorsError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 119, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L119" - } - ], - "signatures": [ - { - "id": 1350, - "name": "isStorageVectorsError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type guard to check if an error is a StorageVectorsError" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "True if the error is a StorageVectorsError" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 119, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L119" - } - ], - "parameters": [ - { - "id": 1351, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The error to check" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError", - "package": "@supabase/storage-js" - } - } - } - ] - }, - { - "id": 1122, - "name": "CreateIndexOptions", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 15, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L15" - } - ], - "target": 912 - }, - { - "id": 1114, - "name": "StorageAnalyticsClient", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 3, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L3" - } - ], - "target": 48 - }, - { - "id": 1115, - "name": "StorageVectorsClient", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 7, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L7" - } - ], - "target": 549 - }, - { - "id": 1118, - "name": "StorageVectorsClientOptions", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 11, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L11" - } - ], - "target": 536 - }, - { - "id": 1116, - "name": "VectorBucketScope", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L8" - } - ], - "target": 604 - }, - { - "id": 1117, - "name": "VectorIndexScope", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L9" - } - ], - "target": 672 - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [1456] - }, - { - "title": "Classes", - "children": [1371, 984, 1353, 1389, 1422, 1407, 1439] - }, - { - "title": "Interfaces", - "children": [ - 1141, 1125, 1307, 1190, 1243, 1341, 1222, 1147, 1157, 1167, 1183, 1295, 1301, 1135, - 1285, 1290, 1276, 1280, 1311, 1320, 1225, 1250, 1303, 1324, 1332, 1192, 1214, 1206, - 1200, 1217, 1180, 1197, 1112, 1337, 1227, 1246, 1264, 1335, 1256, 1271, 1267 - ] - }, - { - "title": "Type Aliases", - "children": [1344, 1123, 1233, 1254, 1235, 1352, 1252, 1323, 1266] - }, - { - "title": "Functions", - "children": [1346, 1349] - }, - { - "title": "References", - "children": [1122, 1114, 1115, 1118, 1116, 1117] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L1" - } - ] - }, - { - "id": 2, - "name": "packages/BlobDownloadBuilder", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 3, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L9" - } - ], - "signatures": [ - { - "id": 5, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L9" - } - ], - "parameters": [ - { - "id": 6, - "name": "downloadFn", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 7, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 10, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10" - } - ], - "signatures": [ - { - "id": 8, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 10, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 9, - "name": "shouldThrowOnError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": 3, - "name": "BlobDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 45, - "name": "[toStringTag]", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 6, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L6" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'BlobDownloadBuilder'", - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.[toStringTag]" - } - }, - { - "id": 15, - "name": "asStream", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14" - } - ], - "signatures": [ - { - "id": 16, - "name": "asStream", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14" - } - ], - "type": { - "type": "reference", - "target": 741, - "name": "StreamDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 29, - "name": "catch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L25" - } - ], - "signatures": [ - { - "id": 30, - "name": "catch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback for only the rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L25" - } - ], - "typeParameters": [ - { - "id": 31, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 32, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 33, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 26, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26" - } - ], - "signatures": [ - { - "id": 34, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 26, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26" - } - ], - "parameters": [ - { - "id": 35, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - }, - { - "id": 36, - "name": "finally", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "signatures": [ - { - "id": 37, - "name": "finally", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\nresolved value cannot be modified from the callback." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "parameters": [ - { - "id": 38, - "name": "onfinally", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is settled (fulfilled or rejected)." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "signatures": [ - { - "id": 40, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - }, - { - "id": 17, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18" - } - ], - "signatures": [ - { - "id": 18, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18" - } - ], - "typeParameters": [ - { - "id": 19, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - }, - { - "id": 20, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 21, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 22, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 19, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19" - } - ], - "signatures": [ - { - "id": 23, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 19, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19" - } - ], - "parameters": [ - { - "id": 24, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 25, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 26, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 20, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20" - } - ], - "signatures": [ - { - "id": 27, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 20, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20" - } - ], - "parameters": [ - { - "id": 28, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [4] - }, - { - "title": "Properties", - "children": [45] - }, - { - "title": "Methods", - "children": [15, 29, 36, 17] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 5, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L5" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [3] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L1" - } - ] - }, - { - "id": 46, - "name": "packages/StorageAnalyticsClient", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 48, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client class for managing Analytics Buckets using Iceberg tables\nProvides methods for creating, listing, and deleting analytics buckets" - } - ] - }, - "children": [ - { - "id": 49, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "signatures": [ - { - "id": 50, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new StorageAnalyticsClient instance\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.storage.analytics.listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { StorageAnalyticsClient } from '@supabase/storage-js'\n\nconst client = new StorageAnalyticsClient(url, headers)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "parameters": [ - { - "id": 51, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The base URL for the storage API" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 52, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers to include in requests" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 53, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "indexSignatures": [ - { - "id": 54, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "parameters": [ - { - "id": 55, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 56, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom fetch implementation" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 57, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 58, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 59, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 60, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 61, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 62, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 63, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 48, - "name": "StorageAnalyticsClient", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 64, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 95, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L95" - } - ], - "signatures": [ - { - "id": 65, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new analytics bucket using Iceberg tables\nAnalytics buckets are optimized for analytical queries and data processing\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created analytics bucket or error" - } - ] - }, - { - "tag": "@example", - "name": "Create analytics bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Creates a new analytics bucket using Iceberg tables\n- Analytics buckets are optimized for analytical queries and data processing" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 95, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L95" - } - ], - "parameters": [ - { - "id": 66, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique name for the bucket you are creating" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 68, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 97, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L97" - } - ], - "type": { - "type": "reference", - "target": 1141, - "name": "AnalyticBucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 69, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 98, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L98" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [68, 69] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 96, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L96" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 70, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 71, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 101, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L101" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 72, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 102, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L102" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [71, 72] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L100" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 88, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 228, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L228" - } - ], - "signatures": [ - { - "id": 89, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing analytics bucket\nA bucket can't be deleted with existing objects inside it\nYou must first empty the bucket before deletion\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete analytics bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .deleteBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deletes an analytics bucket" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 228, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L228" - } - ], - "parameters": [ - { - "id": 90, - "name": "bucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 91, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 92, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 94, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [94] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ] - } - } - }, - { - "id": 95, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 231, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L231" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [92, 95] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 229, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L229" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 96, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 97, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 234, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L234" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 98, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 235, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L235" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [97, 98] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 233, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L233" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 99, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 372, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L372" - } - ], - "signatures": [ - { - "id": 100, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get an Iceberg REST Catalog client configured for a specific analytics bucket\nUse this to perform advanced table and namespace operations within the bucket\nThe returned client provides full access to the Apache Iceberg REST Catalog API\nwith the Supabase " - }, - { - "kind": "code", - "text": "`{ data, error }`" - }, - { - "kind": "text", - "text": " pattern for consistent error handling on all operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The wrapped Iceberg catalog client" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "If the bucket name is invalid" - } - ] - }, - { - "tag": "@example", - "name": "Get catalog and create table", - "content": [ - { - "kind": "code", - "text": "```js\n// First, create an analytics bucket\nconst { data: bucket, error: bucketError } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n\n// Get the Iceberg catalog for that bucket\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Create a namespace\nconst { error: nsError } = await catalog.createNamespace({ namespace: ['default'] })\n\n// Create a table with schema\nconst { data: tableMetadata, error: tableError } = await catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false }\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1]\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: []\n },\n 'write-order': {\n 'order-id': 0,\n fields: []\n },\n properties: {\n 'write.format.default': 'parquet'\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "List tables in namespace", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all tables in the default namespace\nconst { data: tables, error: listError } = await catalog.listTables({ namespace: ['default'] })\nif (listError) {\n if (listError.isNotFound()) {\n console.log('Namespace not found')\n }\n return\n}\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Working with namespaces", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all namespaces\nconst { data: namespaces } = await catalog.listNamespaces()\n\n// Create namespace with properties\nawait catalog.createNamespace(\n { namespace: ['production'] },\n { properties: { owner: 'data-team', env: 'prod' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup operations", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Drop table with purge option (removes all data)\nconst { error: dropError } = await catalog.dropTable(\n { namespace: ['default'], name: 'events' },\n { purge: true }\n)\n\nif (dropError?.isNotFound()) {\n console.log('Table does not exist')\n}\n\n// Drop namespace (must be empty)\nawait catalog.dropNamespace({ namespace: ['default'] })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This method provides a bridge between Supabase's bucket management and the standard\nApache Iceberg REST Catalog API. The bucket name maps to the Iceberg warehouse parameter.\nAll authentication and configuration is handled automatically using your Supabase credentials.\n\n**Error Handling**: Invalid bucket names throw immediately. All catalog\noperations return " - }, - { - "kind": "code", - "text": "`{ data, error }`" - }, - { - "kind": "text", - "text": " where errors are " - }, - { - "kind": "code", - "text": "`IcebergError`" - }, - { - "kind": "text", - "text": " instances from iceberg-js.\nUse helper methods like " - }, - { - "kind": "code", - "text": "`error.isNotFound()`" - }, - { - "kind": "text", - "text": " or check " - }, - { - "kind": "code", - "text": "`error.status`" - }, - { - "kind": "text", - "text": " for specific error handling.\nUse " - }, - { - "kind": "code", - "text": "`.throwOnError()`" - }, - { - "kind": "text", - "text": " on the analytics client if you prefer exceptions for catalog operations.\n\n**Cleanup Operations**: When using " - }, - { - "kind": "code", - "text": "`dropTable`" - }, - { - "kind": "text", - "text": ", the " - }, - { - "kind": "code", - "text": "`purge: true`" - }, - { - "kind": "text", - "text": " option permanently\ndeletes all table data. Without it, the table is marked as deleted but data remains.\n\n**Library Dependency**: The returned catalog wraps " - }, - { - "kind": "code", - "text": "`IcebergRestCatalog`" - }, - { - "kind": "text", - "text": " from iceberg-js.\nFor complete API documentation and advanced usage, refer to the\n[iceberg-js documentation](https://supabase.github.io/iceberg-js/)." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 372, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L372" - } - ], - "parameters": [ - { - "id": 101, - "name": "bucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the analytics bucket (warehouse) to connect to" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 47, - "name": "WrappedIcebergRestCatalog", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 73, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ], - "signatures": [ - { - "id": 74, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Analytics Storage buckets within an existing project\nOnly returns buckets of type 'ANALYTICS'\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of analytics buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List analytics buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc'\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Retrieves the details of all Analytics Storage buckets within an existing project\n- Only returns buckets of type 'ANALYTICS'" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ], - "parameters": [ - { - "id": 75, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 77, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 162, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 78, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 163, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L163" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 81, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 166, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L166" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 79, - "name": "sortColumn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Column to sort by ('name', 'created_at', 'updated_at')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 164, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L164" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 80, - "name": "sortOrder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 165, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L165" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [77, 78, 81, 79, 80] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 82, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 83, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 169, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L169" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1141, - "name": "AnalyticBucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 84, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 170, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L170" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [83, 84] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L168" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 86, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 173, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L173" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 87, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 174, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L174" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [86, 87] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L172" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 119, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 120, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 121, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 122, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 117, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 118, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [49] - }, - { - "title": "Methods", - "children": [64, 88, 99, 73, 119, 117] - } - ], - "categories": [ - { - "title": "Other", - "children": [119, 117] - }, - { - "title": "Storage", - "children": [49, 64, 88, 99, 73] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 21, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L21" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 47, - "name": "WrappedIcebergRestCatalog", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L13" - } - ], - "type": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/iceberg-js@0.8.1/node_modules/iceberg-js/dist/index.d.ts", - "qualifiedName": "IcebergRestCatalog" - }, - "name": "IcebergRestCatalog", - "package": "iceberg-js" - } - }, - "templateType": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "WrapAsyncMethod" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/iceberg-js@0.8.1/node_modules/iceberg-js/dist/index.d.ts", - "qualifiedName": "IcebergRestCatalog" - }, - "name": "IcebergRestCatalog", - "package": "iceberg-js" - } - } - ], - "name": "WrapAsyncMethod", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Classes", - "children": [48] - }, - { - "title": "Type Aliases", - "children": [47] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L1" - } - ] - }, - { - "id": 135, - "name": "packages/StorageBucketApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 136, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 137, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L9" - } - ], - "signatures": [ - { - "id": 138, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L9" - } - ], - "parameters": [ - { - "id": 139, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 140, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L11" - } - ], - "indexSignatures": [ - { - "id": 142, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 11, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L11" - } - ], - "parameters": [ - { - "id": 143, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 144, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 145, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 146, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 147, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 148, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 149, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 150, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 151, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 152, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1112, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 136, - "name": "StorageBucketApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 171, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "signatures": [ - { - "id": 172, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created bucket name or error" - } - ] - }, - { - "tag": "@example", - "name": "Create bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "parameters": [ - { - "id": 173, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are creating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 174, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 178, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L193" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 177, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 192, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L192" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 176, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 191, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 179, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "(private-beta) specifies the bucket type. see " - }, - { - "kind": "code", - "text": "`BucketType`" - }, - { - "kind": "text", - "text": " for more details.\n - default bucket type is " - }, - { - "kind": "code", - "text": "`STANDARD`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [178, 177, 176, 179] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 181, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 200, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "name" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 182, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 201, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [181, 182] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 199, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L199" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 184, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 204, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 185, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [184, 185] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 203, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 213, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "signatures": [ - { - "id": 214, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " - }, - { - "kind": "code", - "text": "`empty()`" - }, - { - "kind": "text", - "text": " the bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "parameters": [ - { - "id": 215, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 216, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 217, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 219, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [219] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ] - } - } - }, - { - "id": 220, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L381" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [217, 220] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 222, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 384, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L384" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 223, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L385" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [222, 223] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 383, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L383" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 202, - "name": "emptyBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "signatures": [ - { - "id": 203, - "name": "emptyBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes all objects inside a single bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Empty bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "parameters": [ - { - "id": 204, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to empty." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 206, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 207, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 208, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [208] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ] - } - } - }, - { - "id": 209, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L334" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [206, 209] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 332, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 210, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 211, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L337" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 212, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 338, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L338" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [211, 212] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 336, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L336" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 162, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "signatures": [ - { - "id": 163, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing Storage bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing bucket details or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "parameters": [ - { - "id": 164, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to retrieve." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 166, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 131, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L131" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 167, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 132, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [166, 167] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 130, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 169, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L135" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 170, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 136, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L136" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [169, 170] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 134, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 153, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "signatures": [ - { - "id": 154, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Storage buckets within an existing project." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "List buckets with options", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "parameters": [ - { - "id": 155, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reference", - "target": 1135, - "name": "ListBucketOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "limit": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ], - "offset": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ], - "sortColumn": [ - { - "kind": "text", - "text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')" - } - ], - "sortOrder": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ], - "search": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 156, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 157, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 158, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L74" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [157, 158] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 72, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 160, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 77, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 161, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 78, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [160, 161] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 244, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 245, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 246, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 247, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 242, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 243, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - }, - { - "id": 186, - "name": "updateBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "signatures": [ - { - "id": 187, - "name": "updateBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Update bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "parameters": [ - { - "id": 188, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are updating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 189, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 193, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 272, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 192, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 271, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 191, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 270, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L270" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [193, 192, 191] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 269, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L269" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 195, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 197, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [197] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ] - } - } - }, - { - "id": 198, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [195, 198] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 199, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 200, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 280, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L280" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 201, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 281, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L281" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [200, 201] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L279" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [137] - }, - { - "title": "Methods", - "children": [171, 213, 202, 162, 153, 244, 242, 186] - } - ], - "categories": [ - { - "title": "Other", - "children": [137, 244, 242] - }, - { - "title": "Storage", - "children": [171, 213, 202, 162, 153, 186] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 8, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L8" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 984, - "name": "StorageClient" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [136] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L1" - } - ] - }, - { - "id": 260, - "name": "packages/StorageFileApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 261, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 262, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L55" - } - ], - "signatures": [ - { - "id": 263, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L55" - } - ], - "parameters": [ - { - "id": 264, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 265, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 266, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 57, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L57" - } - ], - "indexSignatures": [ - { - "id": 267, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 57, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L57" - } - ], - "parameters": [ - { - "id": 268, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 269, - "name": "bucketId", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 270, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 271, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 272, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 273, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 274, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 275, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 276, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 277, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 261, - "name": "StorageFileApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 369, - "name": "copy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 600, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L600" - } - ], - "signatures": [ - { - "id": 370, - "name": "copy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Copies an existing file to a new path in the same bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing copied file path or error" - } - ] - }, - { - "tag": "@example", - "name": "Copy file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .copy('public/avatar1.png', 'private/avatar2.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"avatars/private/avatar2.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 600, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L600" - } - ], - "parameters": [ - { - "id": 371, - "name": "fromPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The original file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 372, - "name": "toPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new file path, including the new file name. For example " - }, - { - "kind": "code", - "text": "`folder/image-copy.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 373, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The destination options." - } - ] - }, - "type": { - "type": "reference", - "target": 1190, - "name": "DestinationOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 374, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 375, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 376, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 377, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [377] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ] - } - } - }, - { - "id": 378, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 607, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L607" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [375, 378] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 605, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L605" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 380, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 610, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L610" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 381, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 611, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L611" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [380, 381] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 609, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L609" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 325, - "name": "createSignedUploadUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L380" - } - ], - "signatures": [ - { - "id": 326, - "name": "createSignedUploadUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing signed upload URL, token, and path or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed Upload URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUploadUrl('folder/cat.jpg')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/upload/sign/avatars/folder/cat.jpg?token=\",\n \"path\": \"folder/cat.jpg\",\n \"token\": \"\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L380" - } - ], - "parameters": [ - { - "id": 327, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 328, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 330, - "name": "upsert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, allows the file to be overwritten if it already exists." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 382, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L382" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [330] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 382, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L382" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 332, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 333, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 336, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 50, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 334, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 335, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [336, 334, 335] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ] - } - } - }, - { - "id": 337, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L386" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [332, 337] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 384, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L384" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 339, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 389, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L389" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 340, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 390, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L390" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [339, 340] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 388, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L388" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 382, - "name": "createSignedUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 689, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L689" - } - ], - "signatures": [ - { - "id": 383, - "name": "createSignedUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing signed URL or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a signed URL for an asset with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60, {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a signed URL which triggers the download of the asset", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60, {\n download: true,\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 689, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L689" - } - ], - "parameters": [ - { - "id": 384, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 385, - "name": "expiresIn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the signed URL expires. For example, " - }, - { - "kind": "code", - "text": "`60`" - }, - { - "kind": "text", - "text": " for a URL which is valid for one minute." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 386, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 387, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 390, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 695, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L695" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 388, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 693, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L693" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - }, - { - "id": 389, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform the asset before serving it to the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 694, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L694" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [390, 388, 389] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 692, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L692" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 392, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 393, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 394, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [394] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ] - } - } - }, - { - "id": 395, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 700, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L700" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [392, 395] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 698, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L698" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 396, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 397, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 703, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L703" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 398, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 704, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L704" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [397, 398] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 702, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L702" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 399, - "name": "createSignedUrls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 784, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L784" - } - ], - "signatures": [ - { - "id": 400, - "name": "createSignedUrls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of objects with signedUrl, path, and error or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed URLs", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"error\": null,\n \"path\": \"folder/avatar1.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar1.png?token=\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\"\n },\n {\n \"error\": null,\n \"path\": \"folder/avatar2.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar2.png?token=\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar2.png?token=\"\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 784, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L784" - } - ], - "parameters": [ - { - "id": 401, - "name": "paths", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file paths to be downloaded, including the current file names. For example " - }, - { - "kind": "code", - "text": "`['folder/image.png', 'folder2/image2.png']`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 402, - "name": "expiresIn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the signed URLs expire. For example, " - }, - { - "kind": "code", - "text": "`60`" - }, - { - "kind": "text", - "text": " for URLs which are valid for one minute." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 403, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 406, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [406, 405] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 407, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 408, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 409, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 410, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 411, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 412, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [410, 411, 412] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ] - } - } - } - }, - { - "id": 413, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 791, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L791" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [408, 413] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 789, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L789" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 414, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 415, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 794, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L794" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 416, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 795, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L795" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [415, 416] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 793, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L793" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 417, - "name": "download", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "signatures": [ - { - "id": 418, - "name": "download", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from " - }, - { - "kind": "code", - "text": "`getPublicUrl`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "BlobDownloadBuilder instance for downloading the file" - } - ] - }, - { - "tag": "@example", - "name": "Download file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": ,\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download file with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n quality: 80\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download with cache control (useful in Edge Functions)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {}, { cache: 'no-store' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download with abort signal", - "content": [ - { - "kind": "code", - "text": "```js\nconst controller = new AbortController()\nsetTimeout(() => controller.abort(), 5000)\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {}, { signal: controller.signal })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "typeParameters": [ - { - "id": 419, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 420, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 422, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 421, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [422, 421] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ] - } - } - } - ], - "parameters": [ - { - "id": 423, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The full path and file name of the file to be downloaded. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 424, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 419, - "name": "Options", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - { - "id": 425, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional fetch parameters like signal for cancellation. Supports standard fetch options including cache control." - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 3, - "name": "BlobDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 435, - "name": "exists", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 980, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L980" - } - ], - "signatures": [ - { - "id": 436, - "name": "exists", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Checks the existence of a file." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing boolean indicating file existence or error" - } - ] - }, - { - "tag": "@example", - "name": "Check file existence", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .exists('folder/avatar1.png')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 980, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L980" - } - ], - "parameters": [ - { - "id": 437, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 438, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 439, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 982, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L982" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 440, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 983, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L983" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [439, 440] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 981, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L981" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 441, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 442, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 986, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L986" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 443, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 987, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L987" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [442, 443] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 985, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L985" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 444, - "name": "getPublicUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1079" - } - ], - "signatures": [ - { - "id": 445, - "name": "getPublicUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Object with public URL" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL for an asset in a public bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"publicUrl\": \"https://example.supabase.co/storage/v1/object/public/public-bucket/folder/avatar1.png\"\n }\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL for an asset in a public bucket with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL which triggers the download of an asset in a public bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n download: true,\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The bucket needs to be set to public, either via [updateBucket()](/docs/reference/javascript/storage-updatebucket) or by going to Storage on [supabase.com/dashboard](https://supabase.com/dashboard), clicking the overflow menu on a bucket and choosing \"Make public\"\n- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1079" - } - ], - "parameters": [ - { - "id": 446, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path and name of the file to generate the public URL for. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 447, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 448, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 451, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1084, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1084" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 449, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1082, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1082" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - }, - { - "id": 450, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform the asset before serving it to the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1083, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1083" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [451, 449, 450] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1081, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1081" - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 455, - "name": "publicUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [455] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [453] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ] - } - } - } - ] - }, - { - "id": 426, - "name": "info", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 943, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L943" - } - ], - "signatures": [ - { - "id": 427, - "name": "info", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing file.\n\nReturns detailed file metadata including size, content type, and timestamps.\nNote: The API returns " - }, - { - "kind": "code", - "text": "`last_modified`" - }, - { - "kind": "text", - "text": " field, not " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get file info", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .info('folder/avatar1.png')\n\nif (data) {\n console.log('Last modified:', data.lastModified)\n console.log('Size:', data.size)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 943, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L943" - } - ], - "parameters": [ - { - "id": 428, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 429, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 430, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 945, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L945" - } - ], - "type": { - "type": "reference", - "target": 1233, - "typeArguments": [ - { - "type": "reference", - "target": 1167, - "name": "FileObjectV2", - "package": "@supabase/storage-js" - } - ], - "name": "Camelize", - "package": "@supabase/storage-js" - } - }, - { - "id": 431, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 946, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L946" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [430, 431] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 944, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L944" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 432, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 433, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 949, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L949" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 434, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 950, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L950" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [433, 434] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 948, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L948" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 465, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1308, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1308" - } - ], - "signatures": [ - { - "id": 466, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all the files and folders within a path of the bucket.\n\n**Important:** For folder entries, fields like " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`last_accessed_at`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`metadata`" - }, - { - "kind": "text", - "text": " will be " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ". Only files have these fields populated.\nAdditionally, deprecated fields like " - }, - { - "kind": "code", - "text": "`bucket_id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`owner`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " are NOT returned\nby this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of files/folders or error" - } - ] - }, - { - "tag": "@example", - "name": "List files in a bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .list('folder', {\n limit: 100,\n offset: 0,\n sortBy: { column: 'name', order: 'asc' },\n })\n\n// Handle files vs folders\ndata?.forEach(item => {\n if (item.id !== null) {\n // It's a file\n console.log('File:', item.name, 'Size:', item.metadata?.size)\n } else {\n // It's a folder\n console.log('Folder:', item.name)\n }\n})\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"avatar1.png\",\n \"id\": \"e668cf7f-821b-4a2f-9dce-7dfa5dd1cfd2\",\n \"updated_at\": \"2024-05-22T23:06:05.580Z\",\n \"created_at\": \"2024-05-22T23:04:34.443Z\",\n \"last_accessed_at\": \"2024-05-22T23:04:34.443Z\",\n \"metadata\": {\n \"eTag\": \"\\\"c5e8c553235d9af30ef4f6e280790b92\\\"\",\n \"size\": 32175,\n \"mimetype\": \"image/png\",\n \"cacheControl\": \"max-age=3600\",\n \"lastModified\": \"2024-05-22T23:06:05.574Z\",\n \"contentLength\": 32175,\n \"httpStatusCode\": 200\n }\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Search files in a bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .list('folder', {\n limit: 100,\n offset: 0,\n sortBy: { column: 'name', order: 'asc' },\n search: 'jon'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1308, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1308" - } - ], - "parameters": [ - { - "id": 467, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The folder path." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 468, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search options including limit (defaults to 100), offset, sortBy, and search" - } - ] - }, - "type": { - "type": "reference", - "target": 1192, - "name": "SearchOptions", - "package": "@supabase/storage-js" - } - }, - { - "id": 469, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional fetch parameters including signal for cancellation" - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 471, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1314, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1314" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1157, - "name": "FileObject", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 472, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1315, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1315" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [471, 472] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1313, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1313" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 473, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 474, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1318, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1318" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 475, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1319, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1319" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [474, 475] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1317, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1317" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 476, - "name": "listV2", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1381" - } - ], - "signatures": [ - { - "id": 477, - "name": "listV2", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all the files and folders within a bucket using the V2 API with pagination support.\n\n**Important:** Folder entries in the " - }, - { - "kind": "code", - "text": "`folders`" - }, - { - "kind": "text", - "text": " array only contain " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " and optionally " - }, - { - "kind": "code", - "text": "`key`" - }, - { - "kind": "text", - "text": " —\nthey have no " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", timestamps, or " - }, - { - "kind": "code", - "text": "`metadata`" - }, - { - "kind": "text", - "text": " fields. Full file metadata is only available\non entries in the " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " array.\n\n this method signature might change in the future" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing folders/objects arrays with pagination info or error" - } - ] - }, - { - "tag": "@example", - "name": "List files with pagination", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .listV2({\n prefix: 'folder/',\n limit: 100,\n })\n\n// Handle pagination\nif (data?.hasNext) {\n const nextPage = await supabase\n .storage\n .from('avatars')\n .listV2({\n prefix: 'folder/',\n cursor: data.nextCursor,\n })\n}\n\n// Handle files vs folders\ndata?.objects.forEach(file => {\n if (file.id !== null) {\n console.log('File:', file.name, 'Size:', file.metadata?.size)\n }\n})\ndata?.folders.forEach(folder => {\n console.log('Folder:', folder.name)\n})\n```" - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1381" - } - ], - "parameters": [ - { - "id": 478, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search options including prefix, cursor for pagination, limit, with_delimiter" - } - ] - }, - "type": { - "type": "reference", - "target": 1200, - "name": "SearchV2Options", - "package": "@supabase/storage-js" - } - }, - { - "id": 479, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional fetch parameters including signal for cancellation" - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 481, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1386" - } - ], - "type": { - "type": "reference", - "target": 1217, - "name": "SearchV2Result", - "package": "@supabase/storage-js" - } - }, - { - "id": 482, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1387, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1387" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [481, 482] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1385, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1385" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 483, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 484, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1390, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1390" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 485, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1391, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1391" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [484, 485] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1389, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1389" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 356, - "name": "move", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 537, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L537" - } - ], - "signatures": [ - { - "id": 357, - "name": "move", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Moves an existing file to a new path in the same bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Move file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .move('public/avatar1.png', 'private/avatar2.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully moved\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 537, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L537" - } - ], - "parameters": [ - { - "id": 358, - "name": "fromPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The original file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 359, - "name": "toPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new file path, including the new file name. For example " - }, - { - "kind": "code", - "text": "`folder/image-new.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The destination options." - } - ] - }, - "type": { - "type": "reference", - "target": 1190, - "name": "DestinationOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 362, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 364, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [364] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ] - } - } - }, - { - "id": 365, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L544" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [362, 365] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 542, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L542" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 367, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 547, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L547" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 368, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 548, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L548" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [367, 368] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 546, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L546" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 456, - "name": "remove", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1143" - } - ], - "signatures": [ - { - "id": 457, - "name": "remove", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes files within the same bucket\n\nReturns an array of FileObject entries for the deleted files. Note that deprecated\nfields like " - }, - { - "kind": "code", - "text": "`bucket_id`" - }, - { - "kind": "text", - "text": " may or may not be present in the response - do not rely on them." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of deleted file objects or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .remove(['folder/avatar1.png'])\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1143" - } - ], - "parameters": [ - { - "id": 458, - "name": "paths", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of files to delete, including the path and file name. For example [" - }, - { - "kind": "code", - "text": "`'folder/image.png'`" - }, - { - "kind": "text", - "text": "]." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 459, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 460, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1145" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1157, - "name": "FileObject", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 461, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1146, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1146" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [460, 461] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1144, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1144" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 463, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1149, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1149" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 464, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1150, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1150" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [463, 464] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1148, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1148" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 519, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 520, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 521, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 522, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 517, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 518, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - }, - { - "id": 489, - "name": "toBase64", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1410" - } - ], - "signatures": [ - { - "id": 490, - "name": "toBase64", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1410" - } - ], - "parameters": [ - { - "id": 491, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 341, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 476, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L476" - } - ], - "signatures": [ - { - "id": 342, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Replaces an existing file at the specified path with a new one." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path, id, and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Update file", - "content": [ - { - "kind": "code", - "text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', avatarFile, {\n cacheControl: '3600'\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update file using `ArrayBuffer` from base64 file data", - "content": [ - { - "kind": "code", - "text": "```js\nimport {decode} from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " always replaces the file at the given path regardless of the " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option.\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\n- For React Native, using either " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " does not work as intended. Update file using " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " from base64 file data instead, see example below." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 476, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L476" - } - ], - "parameters": [ - { - "id": 343, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The relative file path. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to update." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "__global.NodeJS.ReadableStream" - }, - "name": "ReadableStream", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.ReadableStream" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URLSearchParams" - }, - "name": "URLSearchParams", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/buffer.buffer.d.ts", - "qualifiedName": "__global.Buffer" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "Buffer", - "package": "@types/node", - "qualifiedName": "__global.Buffer" - } - ] - } - }, - { - "id": 345, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional file upload options including cacheControl, contentType, and metadata.\n**Note:** The " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option has no effect here. " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " always replaces the\nfile at the given path, so the " - }, - { - "kind": "code", - "text": "`x-upsert`" - }, - { - "kind": "text", - "text": " header is not sent. To control upsert\nbehavior, use " - }, - { - "kind": "code", - "text": "`upload()`" - }, - { - "kind": "text", - "text": " instead." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 346, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 347, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 348, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 351, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 349, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 350, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [351, 349, 350] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ] - } - } - }, - { - "id": 352, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 493, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L493" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [347, 352] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 491, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L491" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 353, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 354, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 496, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L496" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 355, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L497" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [354, 355] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 495, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L495" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 295, - "name": "upload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 219, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L219" - } - ], - "signatures": [ - { - "id": 296, - "name": "upload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Uploads a file to an existing bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path, id, and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Upload file", - "content": [ - { - "kind": "code", - "text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile, {\n cacheControl: '3600',\n upsert: false\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upload file using `ArrayBuffer` from base64 file data", - "content": [ - { - "kind": "code", - "text": "```js\nimport { decode } from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile)\n\nif (error) {\n // Log the full error so fields like `statusCode` and `error` (the\n // Storage error name, e.g. \"Duplicate\") aren't hidden behind `error.message`.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: only " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " when you are uploading new files and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " when you are upserting files\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\n- For React Native, using either " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " does not work as intended. Upload file using " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " from base64 file data instead, see example below." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 219, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L219" - } - ], - "parameters": [ - { - "id": 297, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to upload." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 298, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "FileBody" - }, - "name": "FileBody", - "package": "@supabase/storage-js" - } - }, - { - "id": 299, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional file upload options including cacheControl, contentType, upsert, and metadata." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 300, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 301, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 302, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 305, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 303, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 304, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [305, 303, 304] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ] - } - } - }, - { - "id": 306, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 226, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L226" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [301, 306] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 224, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L224" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 307, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 308, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 229, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L229" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 309, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 230, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L230" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [308, 309] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 228, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L228" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 310, - "name": "uploadToSignedUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L274" - } - ], - "signatures": [ - { - "id": 311, - "name": "uploadToSignedUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Upload a file with a token generated from " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Upload to a signed URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .uploadToSignedUrl('folder/cat.jpg', 'token-from-createSignedUploadUrl', file)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"folder/cat.jpg\",\n \"fullPath\": \"avatars/folder/cat.jpg\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L274" - } - ], - "parameters": [ - { - "id": 312, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to upload." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 313, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token generated from " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl`" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 314, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "FileBody" - }, - "name": "FileBody", - "package": "@supabase/storage-js" - } - }, - { - "id": 315, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers (cacheControl, contentType, etc.).\n**Note:** The " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option has no effect here. To enable upsert behavior,\npass " - }, - { - "kind": "code", - "text": "`{ upsert: true }`" - }, - { - "kind": "text", - "text": " when calling " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl()`" - }, - { - "kind": "text", - "text": " instead." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 316, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 317, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 318, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [317, 318] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 320, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 323, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "defaultValue": "data.Key" - }, - { - "id": 322, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "cleanPath" - } - ], - "groups": [ - { - "title": "Properties", - "children": [323, 322] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ] - } - } - }, - { - "id": 324, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [320, 324] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [262] - }, - { - "title": "Methods", - "children": [ - 369, 325, 382, 399, 417, 435, 444, 426, 465, 476, 356, 456, 519, 517, 489, 341, 295, - 310 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [262, 519, 517, 489] - }, - { - "title": "Storage", - "children": [ - 369, 325, 382, 399, 417, 435, 444, 426, 465, 476, 356, 456, 341, 295, 310 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 52, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L52" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [261] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1" - } - ] - }, - { - "id": 535, - "name": "packages/StorageVectorsClient", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 549, - "name": "StorageVectorsClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Main client for interacting with S3 Vectors API\nProvides access to bucket, index, and vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.\n\n**Usage Patterns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .createBucket('embeddings-prod')\n\n// Access index operations via buckets\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine'\n})\n\n// Access vector operations via index\nconst index = bucket.index('documents')\nawait index.putVectors({\n vectors: [\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\n ]\n})\n\n// Query similar vectors\nconst { data } = await index.queryVectors({\n queryVector: { float32: [...] },\n topK: 5,\n returnDistance: true\n})\n```" - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 550, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L109" - } - ], - "signatures": [ - { - "id": 551, - "name": "StorageVectorsClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\nconst client = new StorageVectorsClient(url, options)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L109" - } - ], - "parameters": [ - { - "id": 552, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base URL of the Storage Vectors REST API." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 553, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 536, - "name": "StorageVectorsClientOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "headers": [ - { - "kind": "text", - "text": "Optional headers (for example " - }, - { - "kind": "code", - "text": "`Authorization`" - }, - { - "kind": "text", - "text": ") applied to every request." - } - ], - "fetch": [ - { - "kind": "text", - "text": "Optional custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation for non-browser runtimes." - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 549, - "name": "StorageVectorsClient", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.constructor" - } - }, - { - "id": 557, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 158, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L158" - } - ], - "signatures": [ - { - "id": 558, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new vector bucket\nVector buckets are containers for vector indexes and their data\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .createBucket('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 158, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L158" - } - ], - "parameters": [ - { - "id": 559, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name for the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.createBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.createBucket" - } - }, - { - "id": 568, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 242, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L242" - } - ], - "signatures": [ - { - "id": 569, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a vector bucket (bucket must be empty)\nAll indexes must be deleted before deleting the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .deleteBucket('embeddings-old')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 242, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L242" - } - ], - "parameters": [ - { - "id": 570, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.deleteBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.deleteBucket" - } - }, - { - "id": 554, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L132" - } - ], - "signatures": [ - { - "id": 555, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access operations for a specific vector bucket\nReturns a scoped client for index and vector operations within the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Bucket-scoped client with index and vector operations" - } - ] - }, - { - "tag": "@example", - "name": "Accessing a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L132" - } - ], - "parameters": [ - { - "id": 556, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 604, - "name": "VectorBucketScope", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 560, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "signatures": [ - { - "id": 561, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves metadata for a specific vector bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with bucket metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .getBucket('embeddings-prod')\n\nconsole.log('Bucket created:', data?.vectorBucket.creationTime)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "parameters": [ - { - "id": 562, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 563, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 564, - "name": "vectorBucket", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "type": { - "type": "reference", - "target": 1246, - "name": "VectorBucket", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [564] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 65, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ] - } - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.getBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.getBucket" - } - }, - { - "id": 565, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 214, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L214" - } - ], - "signatures": [ - { - "id": 566, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all vector buckets with optional filtering and pagination\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with list of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List vector buckets", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .listBuckets({ prefix: 'embeddings-' })\n\ndata?.vectorBuckets.forEach(bucket => {\n console.log(bucket.vectorBucketName)\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 214, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L214" - } - ], - "parameters": [ - { - "id": 567, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional filters (prefix, maxResults, nextToken)" - } - ] - }, - "type": { - "type": "reference", - "target": 1276, - "name": "ListVectorBucketsOptions", - "package": "@supabase/storage-js" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1280, - "name": "ListVectorBucketsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.listBuckets" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.listBuckets" - } - }, - { - "id": 588, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 589, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 590, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 591, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.setHeader" - } - }, - { - "id": 586, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 587, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [550] - }, - { - "title": "Methods", - "children": [557, 568, 554, 560, 565, 588, 586] - } - ], - "categories": [ - { - "title": "Other", - "children": [588, 586] - }, - { - "title": "Storage", - "children": [550, 557, 568, 554, 560, 565] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 80, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L80" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 604, - "name": "VectorBucketScope", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scoped client for operations within a specific vector bucket\nProvides index management and access to vector operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 605, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 273, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L273" - } - ], - "signatures": [ - { - "id": 606, - "name": "VectorBucketScope", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a helper that automatically scopes all index operations to the provided bucket.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector bucket scope", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 273, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L273" - } - ], - "parameters": [ - { - "id": 607, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 608, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 609, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 275, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L275" - } - ], - "indexSignatures": [ - { - "id": 610, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 275, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L275" - } - ], - "parameters": [ - { - "id": 611, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 612, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 613, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 614, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 615, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 616, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 617, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 618, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 619, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 620, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 604, - "name": "VectorBucketScope", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.constructor" - } - }, - { - "id": 622, - "name": "createIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 311, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L311" - } - ], - "signatures": [ - { - "id": 623, - "name": "createIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new vector index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents-openai',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine',\n metadataConfiguration: {\n nonFilterableMetadataKeys: ['raw_text']\n }\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 311, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L311" - } - ], - "parameters": [ - { - "id": 624, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Index configuration (vectorBucketName is automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 912, - "name": "CreateIndexOptions", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "vectorBucketName" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.createIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.createIndex" - } - }, - { - "id": 633, - "name": "deleteIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 390, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L390" - } - ], - "signatures": [ - { - "id": 634, - "name": "deleteIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an index from this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.deleteIndex('old-index')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 390, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L390" - } - ], - "parameters": [ - { - "id": 635, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.deleteIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.deleteIndex" - } - }, - { - "id": 628, - "name": "getIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 366, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L366" - } - ], - "signatures": [ - { - "id": 629, - "name": "getIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves metadata for a specific index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with index metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get index metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nconst { data } = await bucket.getIndex('documents-openai')\nconsole.log('Dimension:', data?.index.dimension)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 366, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L366" - } - ], - "parameters": [ - { - "id": 630, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index to retrieve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 631, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 632, - "name": "index", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 58, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58" - } - ], - "type": { - "type": "reference", - "target": 1256, - "name": "VectorIndex", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [632] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 58, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58" - } - ] - } - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.getIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.getIndex" - } - }, - { - "id": 636, - "name": "index", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L426" - } - ], - "signatures": [ - { - "id": 637, - "name": "index", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access operations for a specific index within this bucket\nReturns a scoped client for vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Index-scoped client with vector data operations" - } - ] - }, - { - "tag": "@example", - "name": "Accessing an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\n\n// Insert vectors\nawait index.putVectors({\n vectors: [\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\n ]\n})\n\n// Query similar vectors\nconst { data } = await index.queryVectors({\n queryVector: { float32: [...] },\n topK: 5\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L426" - } - ], - "parameters": [ - { - "id": 638, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 672, - "name": "VectorIndexScope", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 625, - "name": "listIndexes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 338, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L338" - } - ], - "signatures": [ - { - "id": 626, - "name": "listIndexes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists indexes in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing indexes array and pagination token or error" - } - ] - }, - { - "tag": "@example", - "name": "List indexes", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nconst { data } = await bucket.listIndexes({ prefix: 'documents-' })\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 338, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L338" - } - ], - "parameters": [ - { - "id": 627, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listing options (vectorBucketName is automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1285, - "name": "ListIndexesOptions", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "vectorBucketName" - } - ], - "name": "Omit", - "package": "typescript" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1290, - "name": "ListIndexesResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.listIndexes" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.listIndexes" - } - }, - { - "id": 656, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 657, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 658, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 659, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.setHeader" - } - }, - { - "id": 654, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 655, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [605] - }, - { - "title": "Methods", - "children": [622, 633, 628, 636, 625, 656, 654] - } - ], - "categories": [ - { - "title": "Other", - "children": [656, 654] - }, - { - "title": "Storage", - "children": [605, 622, 633, 628, 636, 625] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 256, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L256" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 672, - "name": "VectorIndexScope", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scoped client for operations within a specific vector index\nProvides vector data operations (put, get, list, query, delete)\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 673, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L465" - } - ], - "signatures": [ - { - "id": 674, - "name": "VectorIndexScope", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a helper that automatically scopes all vector operations to the provided bucket/index names.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector index scope", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L465" - } - ], - "parameters": [ - { - "id": 675, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 676, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 677, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 467, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L467" - } - ], - "indexSignatures": [ - { - "id": 678, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 467, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L467" - } - ], - "parameters": [ - { - "id": 679, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 680, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 681, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 682, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 684, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 685, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 686, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 687, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 688, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 689, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 672, - "name": "VectorIndexScope", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.constructor" - } - }, - { - "id": 704, - "name": "deleteVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L635" - } - ], - "signatures": [ - { - "id": 705, - "name": "deleteVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete vectors by keys", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nawait index.deleteVectors({\n keys: ['doc-1', 'doc-2', 'doc-3']\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L635" - } - ], - "parameters": [ - { - "id": 706, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletion options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1307, - "name": "DeleteVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.deleteVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.deleteVectors" - } - }, - { - "id": 695, - "name": "getVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 536, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L536" - } - ], - "signatures": [ - { - "id": 696, - "name": "getVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing vectors array or error" - } - ] - }, - { - "tag": "@example", - "name": "Get vectors by keys", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.getVectors({\n keys: ['doc-1', 'doc-2'],\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 536, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L536" - } - ], - "parameters": [ - { - "id": 697, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector retrieval options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1295, - "name": "GetVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1301, - "name": "GetVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.getVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.getVectors" - } - }, - { - "id": 698, - "name": "listVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 567, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L567" - } - ], - "signatures": [ - { - "id": 699, - "name": "listVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists vectors in this index with pagination\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing vectors array and pagination token or error" - } - ] - }, - { - "tag": "@example", - "name": "List vectors with pagination", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.listVectors({\n maxResults: 500,\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 567, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L567" - } - ], - "parameters": [ - { - "id": 700, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listing options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1311, - "name": "ListVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1320, - "name": "ListVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.listVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.listVectors" - } - }, - { - "id": 692, - "name": "putVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 505, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L505" - } - ], - "signatures": [ - { - "id": 693, - "name": "putVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inserts or updates vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Insert vectors into an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nawait index.putVectors({\n vectors: [\n {\n key: 'doc-1',\n data: { float32: [0.1, 0.2, ...] },\n metadata: { title: 'Introduction', page: 1 }\n }\n ]\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 505, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L505" - } - ], - "parameters": [ - { - "id": 694, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector insertion options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1303, - "name": "PutVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.putVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.putVectors" - } - }, - { - "id": 701, - "name": "queryVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 603, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L603" - } - ], - "signatures": [ - { - "id": 702, - "name": "queryVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Queries for similar vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing matches array of similar vectors ordered by distance or error" - } - ] - }, - { - "tag": "@example", - "name": "Query similar vectors", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.queryVectors({\n queryVector: { float32: [0.1, 0.2, ...] },\n topK: 5,\n filter: { category: 'technical' },\n returnDistance: true,\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 603, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L603" - } - ], - "parameters": [ - { - "id": 703, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1324, - "name": "QueryVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1332, - "name": "QueryVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.queryVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.queryVectors" - } - }, - { - "id": 724, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 725, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 726, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 727, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.setHeader" - } - }, - { - "id": 722, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 723, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [673] - }, - { - "title": "Methods", - "children": [704, 695, 698, 692, 701, 724, 722] - } - ], - "categories": [ - { - "title": "Other", - "children": [724, 722] - }, - { - "title": "Storage", - "children": [673, 704, 695, 698, 692, 701] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 446, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L446" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 536, - "name": "StorageVectorsClientOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for the Storage Vectors client\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 541, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation (optional)\nUseful for testing or custom request handling" - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 542, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 543, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 544, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 545, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 546, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 547, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 548, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 537, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers to include in all requests" - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 538, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "indexSignatures": [ - { - "id": 539, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "parameters": [ - { - "id": 540, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [541, 537] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 26, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L26" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [549, 604, 672] - }, - { - "title": "Interfaces", - "children": [536] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L1" - } - ] - }, - { - "id": 740, - "name": "packages/StreamDownloadBuilder", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 741, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 742, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L8" - } - ], - "signatures": [ - { - "id": 743, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L8" - } - ], - "parameters": [ - { - "id": 744, - "name": "downloadFn", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 9, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L9" - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 9, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L9" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 747, - "name": "shouldThrowOnError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": 741, - "name": "StreamDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 781, - "name": "[toStringTag]", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 5, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L5" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'StreamDownloadBuilder'", - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.[toStringTag]" - } - }, - { - "id": 765, - "name": "catch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L22" - } - ], - "signatures": [ - { - "id": 766, - "name": "catch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback for only the rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L22" - } - ], - "typeParameters": [ - { - "id": 767, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 768, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 23, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L23" - } - ], - "signatures": [ - { - "id": 770, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 23, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L23" - } - ], - "parameters": [ - { - "id": 771, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - }, - { - "id": 772, - "name": "finally", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "signatures": [ - { - "id": 773, - "name": "finally", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\nresolved value cannot be modified from the callback." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "parameters": [ - { - "id": 774, - "name": "onfinally", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is settled (fulfilled or rejected)." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "signatures": [ - { - "id": 776, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - }, - { - "id": 753, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L13" - } - ], - "signatures": [ - { - "id": 754, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L13" - } - ], - "typeParameters": [ - { - "id": 755, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - }, - { - "id": 756, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 757, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 758, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 15, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L15" - } - ], - "signatures": [ - { - "id": 759, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 15, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L15" - } - ], - "parameters": [ - { - "id": 760, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 761, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 762, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 17, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L17" - } - ], - "signatures": [ - { - "id": 763, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 17, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L17" - } - ], - "parameters": [ - { - "id": 764, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [742] - }, - { - "title": "Properties", - "children": [781] - }, - { - "title": "Methods", - "children": [765, 772, 753] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 4, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L4" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [741] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L1" - } - ] - }, - { - "id": 782, - "name": "packages/VectorBucketApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorBucketApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorBucketApi.ts#L1" - } - ] - }, - { - "id": 846, - "name": "packages/VectorDataApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorDataApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorDataApi.ts#L1" - } - ] - }, - { - "id": 911, - "name": "packages/VectorIndexApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 912, - "name": "CreateIndexOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for creating a vector index\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 915, - "name": "dataType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L25" - } - ], - "type": { - "type": "reference", - "target": 1252, - "name": "VectorDataType", - "package": "@supabase/storage-js" - } - }, - { - "id": 916, - "name": "dimension", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 917, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L27" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 914, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 918, - "name": "metadataConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L28" - } - ], - "type": { - "type": "reference", - "target": 1250, - "name": "MetadataConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 913, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L23" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [915, 916, 917, 914, 918, 913] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 22, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L22" - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [912] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "children": [1, 2, 46, 135, 260, 535, 740, 782, 846, 911] - } - ], - "packageName": "@supabase/storage-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Storage JS SDK

    \n\n

    JavaScript SDK to interact with Supabase Storage, including file storage and vector embeddings.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/storage-js)](https://www.npmjs.com/package/@supabase/storage-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/storage-js)](https://pkg.pr.new/~/supabase/storage-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Features\n\n- **File Storage**: Upload, download, list, move, and delete files\n- **Access Control**: Public and private buckets with fine-grained permissions\n- **Signed URLs**: Generate time-limited URLs for secure file access\n- **Image Transformations**: On-the-fly image resizing and optimization\n- **Vector Embeddings**: Store and query high-dimensional embeddings with similarity search\n- **Analytics Buckets**: Iceberg table-based buckets optimized for analytical queries and data processing\n\n## Quick Start Guide\n\n### Installing the module\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Connecting to the storage backend\n\nThere are two ways to use the Storage SDK:\n\n#### Option 1: Via Supabase Client (Recommended)\n\nIf you're already using " - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": ", access storage through the client:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Use publishable key for frontend applications\nconst supabase = createClient('https://.supabase.co', '')\n\n// Access storage\nconst storage = supabase.storage\n\n// Access different bucket types\nconst regularBucket = storage.from('my-bucket')\nconst vectorBucket = storage.vectors.from('embeddings-bucket')\nconst analyticsBucket = storage.analytics // Analytics API\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 2: Standalone StorageClient\n\nFor backend applications or when you need to bypass Row Level Security:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { StorageClient } from '@supabase/storage-js'\n\nconst STORAGE_URL = 'https://.supabase.co/storage/v1'\nconst SERVICE_KEY = '' // Use secret key for backend operations\n\nconst storageClient = new StorageClient(STORAGE_URL, {\n apikey: SERVICE_KEY,\n Authorization: `Bearer ${SERVICE_KEY}`,\n})\n\n// Access different bucket types\nconst regularBucket = storageClient.from('my-bucket')\nconst vectorBucket = storageClient.vectors.from('embeddings-bucket')\nconst analyticsBucket = storageClient.analytics // Analytics API\n```" - }, - { - "kind": "text", - "text": "\n\n> **When to use each approach:**\n>\n> - Use " - }, - { - "kind": "code", - "text": "`supabase.storage`" - }, - { - "kind": "text", - "text": " when working with other Supabase features (auth, database, etc.) in frontend applications\n> - Use " - }, - { - "kind": "code", - "text": "`new StorageClient()`" - }, - { - "kind": "text", - "text": " for backend applications, Edge Functions, or when you need to bypass RLS policies\n\n> **Note:** Refer to the [Storage Access Control guide](https://supabase.com/docs/guides/storage/access-control) for detailed information on creating RLS policies.\n\n### Understanding Bucket Types\n\nSupabase Storage supports three types of buckets, each optimized for different use cases:\n\n#### 1. Regular Storage Buckets (File Storage)\n\nStandard buckets for storing files, images, videos, and other assets.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create regular storage bucket\nconst { data, error } = await storageClient.createBucket('my-files', {\n public: false,\n})\n\n// Upload files\nawait storageClient.from('my-files').upload('avatar.png', file)\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** User uploads, media assets, documents, backups\n\n#### 2. Vector Buckets (Embeddings Storage)\n\nSpecialized buckets for storing and querying high-dimensional vector embeddings.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create vector bucket\nawait storageClient.vectors.createBucket('embeddings-prod')\n\n// Create index and insert vectors\nconst bucket = storageClient.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents',\n dimension: 1536,\n distanceMetric: 'cosine',\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** Semantic search, AI-powered recommendations, similarity matching\n\n**[See full Vector Embeddings documentation below](#vector-embeddings)**\n\n#### 3. Analytics Buckets\n\nSpecialized buckets using Apache Iceberg table format, optimized for analytical queries and large-scale data processing.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create analytics bucket\nawait storageClient.analytics.createBucket('analytics-data')\n\n// List analytics buckets\nconst { data, error } = await storageClient.analytics.listBuckets()\n\n// Delete analytics bucket\nawait storageClient.analytics.deleteBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** Time-series data, analytical queries, data lakes, large-scale data processing, business intelligence\n\n**[See full Analytics Buckets documentation below](#analytics-buckets)**\n\n---\n\n### Handling resources\n\n#### Handling Storage Buckets\n\n- Create a new Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.createBucket(\n 'test_bucket', // Bucket name (must be unique)\n { public: false } // Bucket options\n )\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve the details of an existing Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.getBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Update a new Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.updateBucket(\n 'test_bucket', // Bucket name\n { public: false } // Bucket options\n )\n ```" - }, - { - "kind": "text", - "text": "\n\n- Remove all objects inside a single bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.emptyBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Delete an existing bucket (a bucket can't be deleted with existing objects inside it):\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.deleteBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve the details of all Storage buckets within an existing project:\n\n " - }, - { - "kind": "code", - "text": "```js\n // List all buckets\n const { data, error } = await storageClient.listBuckets()\n\n // List buckets with options (pagination, sorting, search)\n const { data, error } = await storageClient.listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod',\n })\n ```" - }, - { - "kind": "text", - "text": "\n\n#### Handling Files\n\n- Upload a file to an existing bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const fileBody = ... // load your file here\n\n const { data, error } = await storageClient.from('bucket').upload('path/to/file', fileBody)\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: \n > The path in " - }, - { - "kind": "code", - "text": "`data.Key`" - }, - { - "kind": "text", - "text": " is prefixed by the bucket ID and is not the value which should be passed to the " - }, - { - "kind": "code", - "text": "`download`" - }, - { - "kind": "text", - "text": " method in order to fetch the file. \n > To fetch the file via the " - }, - { - "kind": "code", - "text": "`download`" - }, - { - "kind": "text", - "text": " method, use " - }, - { - "kind": "code", - "text": "`data.path`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`data.bucketId`" - }, - { - "kind": "text", - "text": " as follows:\n >\n > " - }, - { - "kind": "code", - "text": "```javascript\n > const { data, error } = await storageClient.from('bucket').upload('/folder/file.txt', fileBody)\n > // check for errors\n > const { data2, error2 } = await storageClient.from(data.bucketId).download(data.path)\n > ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`upload`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).\n\n- Download a file from an exisiting bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').download('path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n- List all the files within a bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').list('folder')\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`list`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-list).\n\n- Replace an existing file at the specified path with a new one:\n\n " - }, - { - "kind": "code", - "text": "```js\n const fileBody = ... // load your file here\n\n const { data, error } = await storageClient\n .from('bucket')\n .update('path/to/file', fileBody)\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`upload`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).\n\n- Move an existing file:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient\n .from('bucket')\n .move('old/path/to/file', 'new/path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Delete files within the same bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').remove(['path/to/file'])\n ```" - }, - { - "kind": "text", - "text": "\n\n- Create signed URL to download file without requiring permissions:\n\n " - }, - { - "kind": "code", - "text": "```js\n const expireIn = 60\n\n const { data, error } = await storageClient\n .from('bucket')\n .createSignedUrl('path/to/file', expireIn)\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve URLs for assets in public buckets:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('public-bucket').getPublicUrl('path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n## Analytics Buckets\n\nSupabase Storage provides specialized analytics buckets using Apache Iceberg table format, optimized for analytical workloads and large-scale data processing. These buckets are designed for data lake architectures, time-series data, and business intelligence applications.\n\n### What are Analytics Buckets?\n\nAnalytics buckets use the Apache Iceberg open table format, providing:\n\n- **ACID transactions** for data consistency\n- **Schema evolution** without data rewrites\n- **Time travel** to query historical data\n- **Efficient metadata management** for large datasets\n- **Optimized for analytical queries** rather than individual file operations\n\n### When to Use Analytics Buckets\n\n**Use analytics buckets for:**\n\n- Time-series data (logs, metrics, events)\n- Data lake architectures\n- Business intelligence and reporting\n- Large-scale batch processing\n- Analytical workloads requiring ACID guarantees\n\n**Use regular storage buckets for:**\n\n- User file uploads (images, documents, videos)\n- Individual file management\n- Content delivery\n- Simple object storage needs\n\n### Quick Start\n\nYou can access analytics functionality through the " - }, - { - "kind": "code", - "text": "`analytics`" - }, - { - "kind": "text", - "text": " property on your storage client:\n\n#### Via Supabase Client\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')\n\n// Access analytics operations\nconst analytics = supabase.storage.analytics\n\n// Create an analytics bucket\nconst { data, error } = await analytics.createBucket('analytics-data')\nif (error) {\n console.error('Failed to create analytics bucket:', error.message)\n} else {\n console.log('Created bucket:', data.name)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Via StorageClient\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storageClient = new StorageClient('https://your-project.supabase.co/storage/v1', {\n apikey: 'YOUR_API_KEY',\n Authorization: 'Bearer YOUR_TOKEN',\n})\n\n// Access analytics operations\nconst analytics = storageClient.analytics\n\n// Create an analytics bucket\nawait analytics.createBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\n### API Reference\n\n#### Create Analytics Bucket\n\nCreates a new analytics bucket using Iceberg table format:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.createBucket('my-analytics-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n} else {\n console.log('Created bucket:', data)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: {\n id: string\n type: 'ANALYTICS'\n format: string\n created_at: string\n updated_at: string\n } | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### List Analytics Buckets\n\nRetrieves all analytics buckets in your project with optional filtering and pagination:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod',\n})\n\nif (data) {\n console.log(`Found ${data.length} analytics buckets`)\n data.forEach((bucket) => {\n console.log(`- ${bucket.id} (created: ${bucket.created_at})`)\n })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Parameters:**\n\n- " - }, - { - "kind": "code", - "text": "`limit?: number`" - }, - { - "kind": "text", - "text": " - Maximum number of buckets to return\n- " - }, - { - "kind": "code", - "text": "`offset?: number`" - }, - { - "kind": "text", - "text": " - Number of buckets to skip (for pagination)\n- " - }, - { - "kind": "code", - "text": "`sortColumn?: 'id' | 'name' | 'created_at' | 'updated_at'`" - }, - { - "kind": "text", - "text": " - Column to sort by\n- " - }, - { - "kind": "code", - "text": "`sortOrder?: 'asc' | 'desc'`" - }, - { - "kind": "text", - "text": " - Sort direction\n- " - }, - { - "kind": "code", - "text": "`search?: string`" - }, - { - "kind": "text", - "text": " - Search term to filter bucket names\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: AnalyticBucket[] | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Example with Pagination:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Fetch first page\nconst firstPage = await analytics.listBuckets({\n limit: 100,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n})\n\n// Fetch second page\nconst secondPage = await analytics.listBuckets({\n limit: 100,\n offset: 100,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Delete Analytics Bucket\n\nDeletes an analytics bucket. The bucket must be empty before deletion.\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.deleteBucket('old-analytics-bucket')\n\nif (error) {\n console.error('Failed to delete:', error.message)\n} else {\n console.log('Bucket deleted:', data.message)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: { message: string } | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n> **Note:** A bucket cannot be deleted if it contains data. You must empty the bucket first.\n\n#### Get Iceberg Catalog for Advanced Operations\n\nFor advanced operations like creating tables, namespaces, and querying Iceberg metadata, use the " - }, - { - "kind": "code", - "text": "`from()`" - }, - { - "kind": "text", - "text": " method to get a configured [iceberg-js](https://github.com/supabase/iceberg-js) client:\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Get an Iceberg REST Catalog client for your analytics bucket\nconst catalog = analytics.from('analytics-data')\n\n// Create a namespace\nawait catalog.createNamespace({ namespace: ['default'] }, { properties: { owner: 'data-team' } })\n\n// Create a table with schema\nawait catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false },\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1],\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: [],\n },\n 'write-order': {\n 'order-id': 0,\n fields: [],\n },\n properties: {\n 'write.format.default': 'parquet',\n },\n }\n)\n\n// List tables in namespace\nconst tables = await catalog.listTables({ namespace: ['default'] })\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n\n// Load table metadata\nconst table = await catalog.loadTable({ namespace: ['default'], name: 'events' })\n\n// Update table properties\nawait catalog.updateTable(\n { namespace: ['default'], name: 'events' },\n { properties: { 'read.split.target-size': '134217728' } }\n)\n\n// Drop table\nawait catalog.dropTable({ namespace: ['default'], name: 'events' })\n\n// Drop namespace\nawait catalog.dropNamespace({ namespace: ['default'] })\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:** " - }, - { - "kind": "code", - "text": "`IcebergRestCatalog`" - }, - { - "kind": "text", - "text": " instance from [iceberg-js](https://github.com/supabase/iceberg-js)\n\n> **Note:** The " - }, - { - "kind": "code", - "text": "`from()`" - }, - { - "kind": "text", - "text": " method returns an Iceberg REST Catalog client that provides full access to the Apache Iceberg REST API. For complete documentation of available operations, see the [iceberg-js documentation](https://supabase.github.io/iceberg-js/).\n\n### Error Handling\n\nAnalytics buckets use the same error handling pattern as the rest of the Storage SDK:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.createBucket('my-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n console.error('Status:', error.status)\n console.error('Status Code:', error.statusCode)\n // Handle error appropriately\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Throwing Errors\n\nYou can configure the client to throw errors instead of returning them:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst analytics = storageClient.analytics\nanalytics.throwOnError()\n\ntry {\n const { data } = await analytics.createBucket('my-bucket')\n // data is guaranteed to be present\n console.log('Success:', data)\n} catch (error) {\n if (error instanceof StorageApiError) {\n console.error('API Error:', error.statusCode, error.message)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### TypeScript Types\n\nThe library exports TypeScript types for analytics buckets:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport type { AnalyticBucket, BucketType, StorageError } from '@supabase/storage-js'\n\n// AnalyticBucket type\ninterface AnalyticBucket {\n id: string\n type: 'ANALYTICS'\n format: string\n created_at: string\n updated_at: string\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### Common Patterns\n\n#### Checking if a Bucket Exists\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function bucketExists(bucketName: string): Promise {\n const { data, error } = await analytics.listBuckets({\n search: bucketName,\n })\n\n if (error) {\n console.error('Error checking bucket:', error.message)\n return false\n }\n\n return data?.some((bucket) => bucket.id === bucketName) ?? false\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Creating Bucket with Error Handling\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function ensureAnalyticsBucket(bucketName: string) {\n // Try to create the bucket\n const { data, error } = await analytics.createBucket(bucketName)\n\n if (error) {\n // Check if bucket already exists (conflict error)\n if (error.statusCode === '409') {\n console.log(`Bucket '${bucketName}' already exists`)\n return { success: true, created: false }\n }\n\n // Other error occurred\n console.error('Failed to create bucket:', error.message)\n return { success: false, error }\n }\n\n console.log(`Created new bucket: '${bucketName}'`)\n return { success: true, created: true, data }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Listing All Buckets with Pagination\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function getAllAnalyticsBuckets() {\n const allBuckets: AnalyticBucket[] = []\n let offset = 0\n const limit = 100\n\n while (true) {\n const { data, error } = await analytics.listBuckets({\n limit,\n offset,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n })\n\n if (error) {\n console.error('Error fetching buckets:', error.message)\n break\n }\n\n if (!data || data.length === 0) {\n break\n }\n\n allBuckets.push(...data)\n\n // If we got fewer results than the limit, we've reached the end\n if (data.length < limit) {\n break\n }\n\n offset += limit\n }\n\n return allBuckets\n}\n```" - }, - { - "kind": "text", - "text": "\n\n## Vector Embeddings\n\nSupabase Storage provides built-in support for storing and querying high-dimensional vector embeddings, powered by S3 Vectors. This enables semantic search, similarity matching, and AI-powered applications without needing a separate vector database.\n\n> **Note:** Vector embeddings functionality is available in " - }, - { - "kind": "code", - "text": "`@supabase/storage-js`" - }, - { - "kind": "text", - "text": " v2.76 and later.\n\n### Features\n\n- **Vector Buckets**: Organize vector indexes into logical containers\n- **Vector Indexes**: Define schemas with configurable dimensions and distance metrics\n- **Batch Operations**: Insert/update/delete up to 500 vectors per request\n- **Similarity Search**: Query for nearest neighbors using cosine, euclidean, or dot product distance\n- **Metadata Filtering**: Store and filter vectors by arbitrary JSON metadata\n- **Pagination**: Efficiently scan large vector datasets\n- **Parallel Scanning**: Distribute scans across multiple workers for high throughput\n- **Cross-platform**: Works in Node.js, browsers, and edge runtimes\n\n### Quick Start\n\nYou can access vector functionality in three ways, depending on your use case:\n\n#### Option 1: Via Supabase Client (Most Common)\n\nIf you're using the full Supabase client:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')\n\n// Access vector operations through storage\nconst vectors = supabase.storage.vectors\n\n// Create a vector bucket\nawait vectors.createBucket('embeddings-prod')\n\n// Create an index\nconst bucket = vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents-openai',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine',\n})\n\n// Insert vectors\nconst index = bucket.index('documents-openai')\nawait index.putVectors({\n vectors: [\n {\n key: 'doc-1',\n data: { float32: [0.1, 0.2, 0.3 /* ...1536 dimensions */] },\n metadata: { title: 'Introduction', category: 'docs' },\n },\n ],\n})\n\n// Query similar vectors\nconst { data, error } = await index.queryVectors({\n queryVector: { float32: [0.15, 0.25, 0.35 /* ...1536 dimensions */] },\n topK: 5,\n returnDistance: true,\n returnMetadata: true,\n})\n\nif (data) {\n data.matches.forEach((match) => {\n console.log(`${match.key}: distance=${match.distance}`)\n console.log('Metadata:', match.metadata)\n })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 2: Via StorageClient\n\nIf you're using the standalone " - }, - { - "kind": "code", - "text": "`StorageClient`" - }, - { - "kind": "text", - "text": " for storage operations, access vectors through the " - }, - { - "kind": "code", - "text": "`vectors`" - }, - { - "kind": "text", - "text": " property:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storageClient = new StorageClient('https://your-project.supabase.co/storage/v1', {\n apikey: 'YOUR_API_KEY',\n Authorization: 'Bearer YOUR_TOKEN',\n})\n\n// Access vector operations\nconst vectors = storageClient.vectors\n\n// Use the same API as shown in Option 1\nawait vectors.createBucket('embeddings-prod')\nconst bucket = vectors.from('embeddings-prod')\n// ... rest of operations\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 3: Standalone Vector Client\n\nFor vector-only applications that don't need regular file storage operations:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\n// Initialize standalone vector client\nconst vectorClient = new StorageVectorsClient('https://your-project.supabase.co/storage/v1', {\n headers: { Authorization: 'Bearer YOUR_TOKEN' },\n})\n\n// Use the same API as shown in Option 1\nawait vectorClient.createBucket('embeddings-prod')\nconst bucket = vectorClient.from('embeddings-prod')\n// ... rest of operations\n```" - }, - { - "kind": "text", - "text": "\n\n> **When to use each approach:**\n>\n> - **Option 1**: When using other Supabase features (auth, database, realtime)\n> - **Option 2**: When working with both file storage and vectors\n> - **Option 3**: For dedicated vector-only applications without file storage\n\n### API Reference\n\n#### Client Initialization\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst vectorClient = new StorageVectorsClient(url, options?)\n```" - }, - { - "kind": "text", - "text": "\n\n**Options:**\n\n- " - }, - { - "kind": "code", - "text": "`headers?: Record`" - }, - { - "kind": "text", - "text": " - Custom HTTP headers (e.g., Authorization)\n- " - }, - { - "kind": "code", - "text": "`fetch?: Fetch`" - }, - { - "kind": "text", - "text": " - Custom fetch implementation\n\n#### Vector Buckets\n\nVector buckets are top-level containers for organizing vector indexes.\n\n##### Create Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.createBucket('my-bucket')\n```" - }, - { - "kind": "text", - "text": "\n\n##### Get Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.getBucket('my-bucket')\nconsole.log('Created at:', new Date(data.vectorBucket.creationTime! * 1000))\n```" - }, - { - "kind": "text", - "text": "\n\n##### List Buckets\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.listBuckets({\n prefix: 'prod-',\n maxResults: 100,\n})\n\n// Pagination\nif (data?.nextToken) {\n const next = await vectorClient.listBuckets({ nextToken: data.nextToken })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n##### Delete Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Bucket must be empty (all indexes deleted first)\nconst { error } = await vectorClient.deleteBucket('my-bucket')\n```" - }, - { - "kind": "text", - "text": "\n\n#### Vector Indexes\n\nVector indexes define the schema for embeddings including dimension and distance metric.\n\n##### Create Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst bucket = vectorClient.from('my-bucket')\n\nawait bucket.createIndex({\n indexName: 'my-index',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine', // 'cosine' | 'euclidean' | 'dotproduct'\n metadataConfiguration: {\n nonFilterableMetadataKeys: ['raw_text', 'internal_id'],\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Distance Metrics:**\n\n- " - }, - { - "kind": "code", - "text": "`cosine`" - }, - { - "kind": "text", - "text": " - Cosine similarity (normalized dot product)\n- " - }, - { - "kind": "code", - "text": "`euclidean`" - }, - { - "kind": "text", - "text": " - Euclidean distance (L2 norm)\n- " - }, - { - "kind": "code", - "text": "`dotproduct`" - }, - { - "kind": "text", - "text": " - Dot product similarity\n\n##### Get Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await bucket.getIndex('my-index')\nconsole.log('Dimension:', data?.index.dimension)\nconsole.log('Distance metric:', data?.index.distanceMetric)\n```" - }, - { - "kind": "text", - "text": "\n\n##### List Indexes\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await bucket.listIndexes({\n prefix: 'documents-',\n maxResults: 100,\n})\n```" - }, - { - "kind": "text", - "text": "\n\n##### Delete Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Deletes index and all its vectors\nawait bucket.deleteIndex('my-index')\n```" - }, - { - "kind": "text", - "text": "\n\n#### Vector Operations\n\n##### Insert/Update Vectors (Upsert)\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst index = vectorClient.from('my-bucket').index('my-index')\n\nawait index.putVectors({\n vectors: [\n {\n key: 'unique-id-1',\n data: {\n float32: [\n /* 1536 numbers */\n ],\n },\n metadata: {\n title: 'Document Title',\n category: 'technical',\n page: 1,\n },\n },\n // ... up to 500 vectors per request\n ],\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Limitations:**\n\n- 1-500 vectors per request\n- Vectors must match index dimension\n- Keys must be unique within index\n\n##### Get Vectors by Key\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await index.getVectors({\n keys: ['doc-1', 'doc-2', 'doc-3'],\n returnData: true, // Include embeddings\n returnMetadata: true, // Include metadata\n})\n\ndata?.vectors.forEach((v) => {\n console.log(v.key, v.metadata)\n})\n```" - }, - { - "kind": "text", - "text": "\n\n##### Query Similar Vectors (ANN Search)\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await index.queryVectors({\n queryVector: {\n float32: [\n /* 1536 numbers */\n ],\n },\n topK: 10,\n filter: {\n category: 'technical',\n published: true,\n },\n returnDistance: true,\n returnMetadata: true,\n})\n\n// Results ordered by similarity\ndata?.matches.forEach((match) => {\n console.log(`${match.key}: distance=${match.distance}`)\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Filter Syntax:**\nThe " - }, - { - "kind": "code", - "text": "`filter`" - }, - { - "kind": "text", - "text": " parameter accepts arbitrary JSON for metadata filtering. Non-filterable keys (configured at index creation) cannot be used in filters but can still be returned.\n\n##### List/Scan Vectors\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Simple pagination\nlet nextToken: string | undefined\ndo {\n const { data } = await index.listVectors({\n maxResults: 500,\n nextToken,\n returnMetadata: true,\n })\n\n console.log('Batch:', data?.vectors.length)\n nextToken = data?.nextToken\n} while (nextToken)\n\n// Parallel scanning (4 workers)\nconst workers = [0, 1, 2, 3].map(async (segmentIndex) => {\n const { data } = await index.listVectors({\n segmentCount: 4,\n segmentIndex,\n returnMetadata: true,\n })\n return data?.vectors || []\n})\n\nconst results = await Promise.all(workers)\nconst allVectors = results.flat()\n```" - }, - { - "kind": "text", - "text": "\n\n**Limitations:**\n\n- " - }, - { - "kind": "code", - "text": "`maxResults`" - }, - { - "kind": "text", - "text": ": 1-1000 (default: 500)\n- " - }, - { - "kind": "code", - "text": "`segmentCount`" - }, - { - "kind": "text", - "text": ": 1-16\n- Response may be limited by 1MB size\n\n##### Delete Vectors\n\n" - }, - { - "kind": "code", - "text": "```typescript\nawait index.deleteVectors({\n keys: ['doc-1', 'doc-2', 'doc-3'],\n // ... up to 500 keys per request\n})\n```" - }, - { - "kind": "text", - "text": "\n\n### Error Handling\n\nThe library uses a consistent error handling pattern:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.createBucket('my-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n console.error('Status:', error.status)\n console.error('Code:', error.statusCode)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Error Codes\n\n| Code | HTTP | Description |\n| ---------------------------- | ---- | ----------------------- |\n| " - }, - { - "kind": "code", - "text": "`InternalError`" - }, - { - "kind": "text", - "text": " | 500 | Internal server error |\n| " - }, - { - "kind": "code", - "text": "`S3VectorConflictException`" - }, - { - "kind": "text", - "text": " | 409 | Resource already exists |\n| " - }, - { - "kind": "code", - "text": "`S3VectorNotFoundException`" - }, - { - "kind": "text", - "text": " | 404 | Resource not found |\n| " - }, - { - "kind": "code", - "text": "`S3VectorBucketNotEmpty`" - }, - { - "kind": "text", - "text": " | 400 | Bucket contains indexes |\n| " - }, - { - "kind": "code", - "text": "`S3VectorMaxBucketsExceeded`" - }, - { - "kind": "text", - "text": " | 400 | Bucket quota exceeded |\n| " - }, - { - "kind": "code", - "text": "`S3VectorMaxIndexesExceeded`" - }, - { - "kind": "text", - "text": " | 400 | Index quota exceeded |\n\n#### Throwing Errors\n\nYou can configure the client to throw errors instead:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst vectorClient = new StorageVectorsClient(url, options)\nvectorClient.throwOnError()\n\ntry {\n const { data } = await vectorClient.createBucket('my-bucket')\n // data is guaranteed to be present\n} catch (error) {\n if (error instanceof StorageVectorsApiError) {\n console.error('API Error:', error.statusCode)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### Advanced Usage\n\n#### Scoped Clients\n\nCreate scoped clients for cleaner code:\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Bucket-scoped operations\nconst bucket = vectorClient.from('embeddings-prod')\nawait bucket.createIndex({\n /* ... */\n})\nawait bucket.listIndexes()\n\n// Index-scoped operations\nconst index = bucket.index('documents-openai')\nawait index.putVectors({\n /* ... */\n})\nawait index.queryVectors({\n /* ... */\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Custom Fetch\n\nProvide a custom fetch implementation:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\nconst vectorClient = new StorageVectorsClient(url, {\n fetch: customFetch,\n headers: {\n /* ... */\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Batch Processing\n\nProcess large datasets in batches:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function insertLargeDataset(vectors: VectorObject[]) {\n const batchSize = 500\n\n for (let i = 0; i < vectors.length; i += batchSize) {\n const batch = vectors.slice(i, i + batchSize)\n await index.putVectors({ vectors: batch })\n console.log(`Inserted ${i + batch.length}/${vectors.length}`)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Float32 Validation\n\nEnsure vectors are properly normalized to float32:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { normalizeToFloat32 } from '@supabase/storage-js'\n\nconst vector = normalizeToFloat32([0.1, 0.2, 0.3 /* ... */])\n```" - }, - { - "kind": "text", - "text": "\n\n### Type Definitions\n\nThe library exports comprehensive TypeScript types:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport type {\n VectorBucket,\n VectorIndex,\n VectorData,\n VectorObject,\n VectorMatch,\n VectorMetadata,\n DistanceMetric,\n ApiResponse,\n StorageVectorsError,\n} from '@supabase/storage-js'\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n#### Build Scripts Overview\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Build the package\npnpm nx build storage-js\n\n# Watch mode for development\npnpm nx build storage-js --watch\n\n# Generate documentation\npnpm nx docs storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\n**Important:** The storage-js tests require a local Supabase stack running via the Supabase CLI. Docker must be running since the Supabase CLI uses it internally.\n\n#### Prerequisites\n\n1. **Docker** must be installed and running (used by Supabase CLI internally)\n2. **Supabase CLI** — installed automatically via " - }, - { - "kind": "code", - "text": "`pnpm exec supabase`" - }, - { - "kind": "text", - "text": "\n\n#### Test Scripts Overview\n\n| Script | Description | What it does |\n| ----------------- | --------------------------------- | ----------------------------------------------------------------- |\n| " - }, - { - "kind": "code", - "text": "`test:storage`" - }, - { - "kind": "text", - "text": " | **Complete test workflow** | Runs the full test cycle: clean → start infra → run tests → clean |\n| " - }, - { - "kind": "code", - "text": "`test:suite`" - }, - { - "kind": "text", - "text": " | **Jest tests only** | Runs Jest tests with coverage (requires infra to be running) |\n| " - }, - { - "kind": "code", - "text": "`test:infra`" - }, - { - "kind": "text", - "text": " | **Start test infrastructure** | Starts Supabase CLI stack (PostgreSQL, Storage API, Kong, etc.) |\n| " - }, - { - "kind": "code", - "text": "`test:clean-post`" - }, - { - "kind": "text", - "text": " | **Stop and clean infrastructure** | Stops the Supabase CLI stack |\n\n#### Running Tests\n\n##### Option 1: Complete Test Run (Recommended)\n\nThis handles everything automatically - starting infrastructure, running tests, and cleaning up:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From monorepo root\npnpm nx test:storage storage-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command will:\n\n1. Stop any existing test containers\n2. Build and start fresh test infrastructure\n3. Wait for services to be ready\n4. Run all Jest tests with coverage\n5. Clean up all containers after tests complete\n\n##### Option 2: Manual Infrastructure Management\n\nUseful for development when you want to run tests multiple times without restarting Docker:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Step 1: Start the test infrastructure\n# From root\npnpm nx test:infra storage-js\n# This starts: PostgreSQL, Storage API, Kong Gateway, and imgproxy\n\n# Step 2: Run tests (can run multiple times)\npnpm nx test:suite storage-js\n\n# Step 3: When done, clean up the infrastructure\npnpm nx test:clean-post storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n##### Option 3: Development Mode\n\nFor actively developing and debugging tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Start infrastructure once (from root)\npnpm nx test:infra storage-js\n\n# Run tests in watch mode\npnpm nx test:suite storage-js --watch\n\n# Clean up when done\npnpm nx test:clean-post storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure Details\n\nThe test infrastructure is managed via the Supabase CLI (" - }, - { - "kind": "code", - "text": "`pnpm exec supabase start --workdir test`" - }, - { - "kind": "text", - "text": "), which starts a local Supabase stack defined by the config in " - }, - { - "kind": "code", - "text": "`test/`" - }, - { - "kind": "text", - "text": ". This includes PostgreSQL, the Storage API, Kong Gateway, and supporting services.\n\n#### Common Issues and Solutions\n\n| Issue | Solution |\n| --------------------------------- | ------------------------------------------------------------------------------------------------- |\n| Port conflicts | Another service is using a required port. Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:clean-post storage-js`" - }, - { - "kind": "text", - "text": " then try again |\n| \"request failed, reason:\" errors | Infrastructure isn't running. Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:infra storage-js`" - }, - { - "kind": "text", - "text": " first |\n| Tests fail with connection errors | Ensure Docker is running (Supabase CLI requires Docker) |\n| Stack already running | Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:clean-post storage-js`" - }, - { - "kind": "text", - "text": " to stop it before restarting |\n\n#### Understanding Test Failures\n\n- **StorageUnknownError with \"request failed\"**: Infrastructure not running\n- **Snapshot failures**: Expected test data has changed — review and update snapshots if needed\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 11 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "2": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "" - }, - "3": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "5": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default" - }, - "6": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "downloadFn" - }, - "7": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "8": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "9": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "shouldThrowOnError" - }, - "15": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.asStream" - }, - "16": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.asStream" - }, - "17": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "18": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "19": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult1" - }, - "20": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult2" - }, - "21": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "22": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "23": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "24": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "value" - }, - "25": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "26": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "27": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "28": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "29": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "30": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "31": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult" - }, - "32": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "33": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "34": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "35": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "36": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "37": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "38": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onfinally" - }, - "39": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "40": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "45": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.[toStringTag]" - }, - "46": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "" - }, - "47": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "WrappedIcebergRestCatalog" - }, - "48": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default" - }, - "49": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.__constructor" - }, - "50": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default" - }, - "51": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "url" - }, - "52": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "headers" - }, - "53": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "54": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.__index" - }, - "56": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "fetch" - }, - "57": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "58": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "59": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "60": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "61": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "62": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "63": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "64": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.createBucket" - }, - "65": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.createBucket" - }, - "66": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "name" - }, - "67": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "69": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "70": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "71": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "72": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "73": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.listBuckets" - }, - "74": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.listBuckets" - }, - "75": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "options" - }, - "76": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "77": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.limit" - }, - "78": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.offset" - }, - "79": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.sortColumn" - }, - "80": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.sortOrder" - }, - "81": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.search" - }, - "82": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "83": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "84": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "85": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "86": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "87": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "88": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.deleteBucket" - }, - "89": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.deleteBucket" - }, - "90": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "bucketName" - }, - "91": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "92": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "93": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.message" - }, - "95": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "96": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "97": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "98": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "99": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.from" - }, - "100": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.from" - }, - "101": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "bucketName" - }, - "117": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "118": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "119": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "120": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "121": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "122": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "135": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "" - }, - "136": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default" - }, - "137": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.__constructor" - }, - "138": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default" - }, - "139": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "url" - }, - "140": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "headers" - }, - "141": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "142": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.__index" - }, - "144": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "fetch" - }, - "145": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "146": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "147": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "148": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "149": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "150": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "151": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "152": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "opts" - }, - "153": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "154": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "155": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "156": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "157": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "158": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "159": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "160": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "161": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "162": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "163": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "164": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "165": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "166": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "167": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "168": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "169": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "170": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "171": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "172": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "173": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "174": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "175": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "176": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "177": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "178": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "179": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.type" - }, - "180": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "181": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "182": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "183": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "184": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "185": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "186": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "187": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "188": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "189": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "190": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "191": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "192": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "193": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "194": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "195": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "196": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "197": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "198": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "199": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "200": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "201": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "202": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "203": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "204": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "205": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "206": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "207": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "208": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "209": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "210": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "211": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "212": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "213": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "214": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "215": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "216": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "217": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "218": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "219": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "220": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "221": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "222": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "223": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "242": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "243": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "244": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "245": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "246": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "247": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "260": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "" - }, - "261": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default" - }, - "262": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.__constructor" - }, - "263": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default" - }, - "264": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "url" - }, - "265": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "headers" - }, - "266": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "267": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.__index" - }, - "269": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "bucketId" - }, - "270": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fetch" - }, - "271": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "272": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "273": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "274": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "275": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "276": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "277": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "295": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.upload" - }, - "296": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.upload" - }, - "297": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "298": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "299": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "300": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "301": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "302": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "303": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.id" - }, - "304": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "305": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.fullPath" - }, - "306": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "307": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "308": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "309": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "310": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.uploadToSignedUrl" - }, - "311": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.uploadToSignedUrl" - }, - "312": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "313": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "token" - }, - "314": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "315": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "316": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type" - }, - "317": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.data" - }, - "318": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.error" - }, - "319": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type" - }, - "320": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.data" - }, - "321": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object" - }, - "322": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object.path" - }, - "323": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object.fullPath" - }, - "324": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.error" - }, - "325": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUploadUrl" - }, - "326": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUploadUrl" - }, - "327": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "328": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "329": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "330": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.upsert" - }, - "331": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "332": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "333": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "334": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "335": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.token" - }, - "336": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "337": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "338": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "339": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "340": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "341": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.update" - }, - "342": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.update" - }, - "343": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "344": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "345": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "346": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "347": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "348": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "349": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.id" - }, - "350": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "351": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.fullPath" - }, - "352": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "353": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "354": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "355": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "356": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.move" - }, - "357": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.move" - }, - "358": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fromPath" - }, - "359": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "toPath" - }, - "360": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "361": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "362": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "363": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "364": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.message" - }, - "365": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "366": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "367": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "368": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "369": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.copy" - }, - "370": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.copy" - }, - "371": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fromPath" - }, - "372": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "toPath" - }, - "373": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "374": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "375": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "376": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "377": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "378": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "379": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "380": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "381": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "382": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrl" - }, - "383": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrl" - }, - "384": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "385": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "expiresIn" - }, - "386": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "387": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "388": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "389": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "390": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "391": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "392": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "393": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "394": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "395": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "396": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "397": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "398": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "399": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrls" - }, - "400": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrls" - }, - "401": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "paths" - }, - "402": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "expiresIn" - }, - "403": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "404": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "405": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "406": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "407": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "408": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "409": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "410": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "411": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "412": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "413": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "414": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "415": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "416": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "417": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.download" - }, - "418": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.download" - }, - "419": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "Options" - }, - "420": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "421": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "422": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "423": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "424": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "425": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "426": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.info" - }, - "427": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.info" - }, - "428": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "429": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "430": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "431": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "432": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "433": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "434": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "435": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.exists" - }, - "436": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.exists" - }, - "437": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "438": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "439": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "440": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "441": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "442": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "443": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "444": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.getPublicUrl" - }, - "445": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.getPublicUrl" - }, - "446": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "447": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "448": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "449": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "450": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "451": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "452": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "454": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "455": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.publicUrl" - }, - "456": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.remove" - }, - "457": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.remove" - }, - "458": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "paths" - }, - "459": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "460": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "461": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "462": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "463": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "464": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "465": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.list" - }, - "466": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.list" - }, - "467": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "468": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "469": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "470": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "471": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "472": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "473": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "474": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "475": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "476": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.listV2" - }, - "477": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.listV2" - }, - "478": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "479": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "480": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "481": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "482": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "483": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "484": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "485": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "489": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.toBase64" - }, - "490": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.toBase64" - }, - "491": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "data" - }, - "517": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "518": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "519": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "520": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "521": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "522": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "535": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "" - }, - "536": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions" - }, - "537": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions.headers" - }, - "538": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "539": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "541": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions.fetch" - }, - "542": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "543": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "544": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "545": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "546": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "547": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "548": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "549": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient" - }, - "550": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.__constructor" - }, - "551": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient" - }, - "552": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "553": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "554": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.from" - }, - "555": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.from" - }, - "556": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "557": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.createBucket" - }, - "558": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.createBucket" - }, - "559": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "560": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.getBucket" - }, - "561": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.getBucket" - }, - "562": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "563": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "564": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.vectorBucket" - }, - "565": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.listBuckets" - }, - "566": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.listBuckets" - }, - "567": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "568": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.deleteBucket" - }, - "569": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.deleteBucket" - }, - "570": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "586": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "587": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "588": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "589": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "590": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "591": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "604": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope" - }, - "605": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.__constructor" - }, - "606": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope" - }, - "607": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "608": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "headers" - }, - "609": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "610": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "612": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "613": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "fetch" - }, - "614": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "615": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "616": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "617": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "618": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "619": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "620": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "622": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.createIndex" - }, - "623": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.createIndex" - }, - "624": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "625": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.listIndexes" - }, - "626": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.listIndexes" - }, - "627": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "628": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.getIndex" - }, - "629": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.getIndex" - }, - "630": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "631": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "__type" - }, - "632": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "__type.index" - }, - "633": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.deleteIndex" - }, - "634": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.deleteIndex" - }, - "635": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "636": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.index" - }, - "637": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.index" - }, - "638": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "654": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "655": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "656": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "657": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "658": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "659": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "672": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope" - }, - "673": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.__constructor" - }, - "674": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope" - }, - "675": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "676": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "headers" - }, - "677": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "678": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "680": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "681": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "682": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "fetch" - }, - "683": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "684": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "685": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "686": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "687": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "688": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "689": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "692": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.putVectors" - }, - "693": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.putVectors" - }, - "694": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "695": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.getVectors" - }, - "696": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.getVectors" - }, - "697": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "698": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.listVectors" - }, - "699": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.listVectors" - }, - "700": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "701": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.queryVectors" - }, - "702": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.queryVectors" - }, - "703": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "704": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.deleteVectors" - }, - "705": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.deleteVectors" - }, - "706": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "722": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "723": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "724": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "725": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "726": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "727": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "740": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "" - }, - "741": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default" - }, - "742": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "743": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default" - }, - "744": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "downloadFn" - }, - "745": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "746": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "747": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "shouldThrowOnError" - }, - "753": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "754": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "755": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult1" - }, - "756": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult2" - }, - "757": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "758": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "760": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "value" - }, - "761": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "762": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "763": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "765": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "766": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "767": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult" - }, - "768": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "769": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "770": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "771": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "772": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "773": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "774": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onfinally" - }, - "775": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "776": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "781": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.[toStringTag]" - }, - "782": { - "sourceFileName": "src/packages/VectorBucketApi.ts", - "qualifiedName": "" - }, - "846": { - "sourceFileName": "src/packages/VectorDataApi.ts", - "qualifiedName": "" - }, - "911": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "" - }, - "912": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions" - }, - "913": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.vectorBucketName" - }, - "914": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.indexName" - }, - "915": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.dataType" - }, - "916": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.dimension" - }, - "917": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.distanceMetric" - }, - "918": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.metadataConfiguration" - }, - "984": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient" - }, - "985": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.__constructor" - }, - "986": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient" - }, - "987": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "url" - }, - "988": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "headers" - }, - "989": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "__type" - }, - "990": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "__type.__index" - }, - "992": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "fetch" - }, - "993": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "994": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "995": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "996": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "997": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "998": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "999": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1000": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "opts" - }, - "1001": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.from" - }, - "1002": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.from" - }, - "1003": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "id" - }, - "1004": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.vectors" - }, - "1005": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.vectors" - }, - "1006": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.analytics" - }, - "1007": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.analytics" - }, - "1008": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "1009": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "1010": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1011": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1012": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1013": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1014": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1015": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1016": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1017": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "1018": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "1019": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1020": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1021": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1022": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1023": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1024": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1025": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1026": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "1027": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "1028": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1029": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1030": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1031": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "1032": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "1033": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "1034": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.type" - }, - "1035": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1036": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1037": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1038": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1039": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1040": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1041": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "1042": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "1043": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1044": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1045": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1046": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "1047": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "1048": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "1049": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1050": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1051": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1052": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1053": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1054": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1055": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1056": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1057": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "1058": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "1059": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1060": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1061": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1062": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1063": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1064": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1065": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1066": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1067": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1068": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "1069": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "1070": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1071": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1072": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1073": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1074": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1075": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1076": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1077": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1078": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1094": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1095": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1096": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "1097": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "1098": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "1099": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "1112": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClientOptions" - }, - "1113": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClientOptions.useNewHostname" - }, - "1114": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageAnalyticsClient" - }, - "1115": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageVectorsClient" - }, - "1116": { - "sourceFileName": "src/index.ts", - "qualifiedName": "VectorBucketScope" - }, - "1117": { - "sourceFileName": "src/index.ts", - "qualifiedName": "VectorIndexScope" - }, - "1118": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageVectorsClientOptions" - }, - "1122": { - "sourceFileName": "src/index.ts", - "qualifiedName": "CreateIndexOptions" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "BucketType" - }, - "1124": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1125": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket" - }, - "1126": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.id" - }, - "1127": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.type" - }, - "1128": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.name" - }, - "1129": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.owner" - }, - "1130": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.file_size_limit" - }, - "1131": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.allowed_mime_types" - }, - "1132": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.created_at" - }, - "1133": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.updated_at" - }, - "1134": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.public" - }, - "1135": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions" - }, - "1136": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.limit" - }, - "1137": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.offset" - }, - "1138": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.sortColumn" - }, - "1139": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.sortOrder" - }, - "1140": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.search" - }, - "1141": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket" - }, - "1142": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.name" - }, - "1143": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.type" - }, - "1144": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.format" - }, - "1145": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.created_at" - }, - "1146": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.updated_at" - }, - "1147": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata" - }, - "1148": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.eTag" - }, - "1149": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.size" - }, - "1150": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.mimetype" - }, - "1151": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.cacheControl" - }, - "1152": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.lastModified" - }, - "1153": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.contentLength" - }, - "1154": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.httpStatusCode" - }, - "1155": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.__index" - }, - "1157": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject" - }, - "1158": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.name" - }, - "1159": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.id" - }, - "1160": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.updated_at" - }, - "1161": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.created_at" - }, - "1162": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.last_accessed_at" - }, - "1163": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.metadata" - }, - "1164": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.bucket_id" - }, - "1165": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.owner" - }, - "1166": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.buckets" - }, - "1167": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2" - }, - "1168": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.id" - }, - "1169": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.version" - }, - "1170": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.name" - }, - "1171": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.bucket_id" - }, - "1172": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.created_at" - }, - "1173": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.size" - }, - "1174": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.cache_control" - }, - "1175": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.content_type" - }, - "1176": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.etag" - }, - "1177": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.last_modified" - }, - "1178": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.metadata" - }, - "1179": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.updated_at" - }, - "1180": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy" - }, - "1181": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy.column" - }, - "1182": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy.order" - }, - "1183": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions" - }, - "1184": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.cacheControl" - }, - "1185": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.contentType" - }, - "1186": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.upsert" - }, - "1187": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.duplex" - }, - "1188": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.metadata" - }, - "1189": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.headers" - }, - "1190": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DestinationOptions" - }, - "1191": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DestinationOptions.destinationBucket" - }, - "1192": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions" - }, - "1193": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.limit" - }, - "1194": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.offset" - }, - "1195": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.sortBy" - }, - "1196": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.search" - }, - "1197": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2" - }, - "1198": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2.column" - }, - "1199": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2.order" - }, - "1200": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options" - }, - "1201": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.limit" - }, - "1202": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.prefix" - }, - "1203": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.cursor" - }, - "1204": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.with_delimiter" - }, - "1205": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.sortBy" - }, - "1206": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object" - }, - "1207": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.name" - }, - "1208": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.key" - }, - "1209": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.id" - }, - "1210": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.updated_at" - }, - "1211": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.created_at" - }, - "1212": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.metadata" - }, - "1213": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.last_accessed_at" - }, - "1214": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder" - }, - "1215": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder.name" - }, - "1216": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder.key" - }, - "1217": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result" - }, - "1218": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.hasNext" - }, - "1219": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.folders" - }, - "1220": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.objects" - }, - "1221": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.nextCursor" - }, - "1222": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters" - }, - "1223": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters.signal" - }, - "1224": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters.cache" - }, - "1225": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Metadata" - }, - "1226": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Metadata.name" - }, - "1227": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions" - }, - "1228": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.width" - }, - "1229": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.height" - }, - "1230": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.resize" - }, - "1231": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.quality" - }, - "1232": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.format" - }, - "1233": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Camelize" - }, - "1234": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1235": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DownloadResult" - }, - "1236": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1237": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1238": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1239": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1240": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1241": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1242": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1243": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration" - }, - "1244": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration.kmsKeyArn" - }, - "1245": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration.sseType" - }, - "1246": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket" - }, - "1247": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.vectorBucketName" - }, - "1248": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.creationTime" - }, - "1249": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.encryptionConfiguration" - }, - "1250": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MetadataConfiguration" - }, - "1251": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MetadataConfiguration.nonFilterableMetadataKeys" - }, - "1252": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorDataType" - }, - "1253": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1254": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DistanceMetric" - }, - "1255": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1256": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex" - }, - "1257": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.indexName" - }, - "1258": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.vectorBucketName" - }, - "1259": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.dataType" - }, - "1260": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.dimension" - }, - "1261": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.distanceMetric" - }, - "1262": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.metadataConfiguration" - }, - "1263": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.creationTime" - }, - "1264": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorData" - }, - "1265": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorData.float32" - }, - "1266": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMetadata" - }, - "1267": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject" - }, - "1268": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.key" - }, - "1269": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.data" - }, - "1270": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.metadata" - }, - "1271": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch" - }, - "1272": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.key" - }, - "1273": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.data" - }, - "1274": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.metadata" - }, - "1275": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.distance" - }, - "1276": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions" - }, - "1277": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.prefix" - }, - "1278": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.maxResults" - }, - "1279": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.nextToken" - }, - "1280": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse" - }, - "1281": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse.vectorBuckets" - }, - "1282": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1283": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.vectorBucketName" - }, - "1284": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse.nextToken" - }, - "1285": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions" - }, - "1286": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.vectorBucketName" - }, - "1287": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.prefix" - }, - "1288": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.maxResults" - }, - "1289": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.nextToken" - }, - "1290": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse" - }, - "1291": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse.indexes" - }, - "1292": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1293": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.indexName" - }, - "1294": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse.nextToken" - }, - "1295": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions" - }, - "1296": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.vectorBucketName" - }, - "1297": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.indexName" - }, - "1298": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.keys" - }, - "1299": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.returnData" - }, - "1300": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.returnMetadata" - }, - "1301": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsResponse" - }, - "1302": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsResponse.vectors" - }, - "1303": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions" - }, - "1304": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.vectorBucketName" - }, - "1305": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.indexName" - }, - "1306": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.vectors" - }, - "1307": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions" - }, - "1308": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.vectorBucketName" - }, - "1309": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.indexName" - }, - "1310": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.keys" - }, - "1311": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions" - }, - "1312": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.vectorBucketName" - }, - "1313": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.indexName" - }, - "1314": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.maxResults" - }, - "1315": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.nextToken" - }, - "1316": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.returnData" - }, - "1317": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.returnMetadata" - }, - "1318": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.segmentCount" - }, - "1319": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.segmentIndex" - }, - "1320": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse" - }, - "1321": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse.vectors" - }, - "1322": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse.nextToken" - }, - "1323": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFilter" - }, - "1324": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions" - }, - "1325": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.vectorBucketName" - }, - "1326": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.indexName" - }, - "1327": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.queryVector" - }, - "1328": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.topK" - }, - "1329": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.filter" - }, - "1330": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.returnDistance" - }, - "1331": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.returnMetadata" - }, - "1332": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse" - }, - "1333": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse.vectors" - }, - "1334": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse.distanceMetric" - }, - "1335": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFetchParameters" - }, - "1336": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFetchParameters.signal" - }, - "1337": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse" - }, - "1338": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.data" - }, - "1339": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.error" - }, - "1340": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.T" - }, - "1341": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse" - }, - "1342": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse.data" - }, - "1343": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse.error" - }, - "1344": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ApiResponse" - }, - "1345": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1346": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageError" - }, - "1347": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageError" - }, - "1348": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "error" - }, - "1349": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageVectorsError" - }, - "1350": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageVectorsError" - }, - "1351": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "error" - }, - "1352": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "1353": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "1354": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.__constructor" - }, - "1355": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "1356": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1357": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1358": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1359": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1362": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1363": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1364": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1365": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1366": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1368": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1369": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1370": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1371": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "1372": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.__constructor" - }, - "1373": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "1374": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1375": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1376": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1377": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1378": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "1379": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "1380": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1381": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1382": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1383": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1384": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1385": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1386": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1389": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError" - }, - "1390": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.__constructor" - }, - "1391": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError" - }, - "1392": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1393": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "originalError" - }, - "1394": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1395": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.originalError" - }, - "1398": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1399": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1400": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1401": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1402": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1404": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1405": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1406": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1407": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError" - }, - "1408": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError.__constructor" - }, - "1409": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError" - }, - "1410": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1413": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1414": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1415": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1416": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1417": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1418": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1419": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1420": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1421": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1422": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError" - }, - "1423": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError.__constructor" - }, - "1424": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError" - }, - "1425": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1426": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1427": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1428": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "1429": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "1430": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1431": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1432": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1433": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1434": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1435": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1436": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1439": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError" - }, - "1440": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError.__constructor" - }, - "1441": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError" - }, - "1442": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1443": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "originalError" - }, - "1444": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.originalError" - }, - "1447": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1448": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1449": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1450": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1451": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1452": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1453": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1454": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1455": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1456": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode" - }, - "1457": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.InternalError" - }, - "1458": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorConflictException" - }, - "1459": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorNotFoundException" - }, - "1460": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorBucketNotEmpty" - }, - "1461": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorMaxBucketsExceeded" - }, - "1462": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorMaxIndexesExceeded" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "src/packages/BlobDownloadBuilder.ts", - "3": "src/packages/StorageAnalyticsClient.ts", - "4": "src/packages/StorageBucketApi.ts", - "5": "src/packages/StorageFileApi.ts", - "6": "src/packages/StorageVectorsClient.ts", - "7": "src/packages/StreamDownloadBuilder.ts", - "8": "src/packages/VectorBucketApi.ts", - "9": "src/packages/VectorDataApi.ts", - "10": "src/packages/VectorIndexApi.ts", - "11": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 1, - "2": 2, - "3": 46, - "4": 135, - "5": 260, - "6": 535, - "7": 740, - "8": 782, - "9": 846, - "10": 911 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json deleted file mode 100644 index d121fa2e9f3..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json +++ /dev/null @@ -1,35693 +0,0 @@ -{ - "id": 0, - "name": "@supabase/storage-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1, - "name": "index", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 1456, - "name": "StorageVectorsErrorCode", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error codes specific to S3 Vectors API\nMaps AWS service errors to application-friendly error codes" - } - ] - }, - "children": [ - { - "id": 1457, - "name": "InternalError", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Internal server fault (HTTP 500)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 149, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L149" - } - ], - "type": { - "type": "literal", - "value": "InternalError" - } - }, - { - "id": 1460, - "name": "S3VectorBucketNotEmpty", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete bucket while not empty (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 155, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L155" - } - ], - "type": { - "type": "literal", - "value": "S3VectorBucketNotEmpty" - } - }, - { - "id": 1458, - "name": "S3VectorConflictException", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource already exists / conflict (HTTP 409)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 151, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L151" - } - ], - "type": { - "type": "literal", - "value": "S3VectorConflictException" - } - }, - { - "id": 1461, - "name": "S3VectorMaxBucketsExceeded", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exceeds bucket quota/limit (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 157, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L157" - } - ], - "type": { - "type": "literal", - "value": "S3VectorMaxBucketsExceeded" - } - }, - { - "id": 1462, - "name": "S3VectorMaxIndexesExceeded", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exceeds index quota/limit (HTTP 400)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 159, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L159" - } - ], - "type": { - "type": "literal", - "value": "S3VectorMaxIndexesExceeded" - } - }, - { - "id": 1459, - "name": "S3VectorNotFoundException", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource not found (HTTP 404)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 153, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L153" - } - ], - "type": { - "type": "literal", - "value": "S3VectorNotFoundException" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [1457, 1460, 1458, 1461, 1462, 1459] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 147, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L147" - } - ] - }, - { - "id": 1371, - "name": "StorageApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "API error returned from Storage service\nIncludes HTTP status code and service-specific error code" - } - ] - }, - "children": [ - { - "id": 1372, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L62" - } - ], - "signatures": [ - { - "id": 1373, - "name": "StorageApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 62, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L62" - } - ], - "parameters": [ - { - "id": 1374, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1375, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1376, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1377, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - } - ], - "type": { - "type": "reference", - "target": 1371, - "name": "StorageApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1378, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 59, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1379, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 60, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L60" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1380, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "signatures": [ - { - "id": 1381, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1382, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1384, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 76, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L76" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1383, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 75, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1385, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 77, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L77" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1386, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 78, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L78" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1384, 1383, 1385, 1386] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1372] - }, - { - "title": "Properties", - "children": [1378, 1379] - }, - { - "title": "Methods", - "children": [1380] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 58, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L58" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1422, - "name": "StorageVectorsApiError" - } - ] - }, - { - "id": 984, - "name": "StorageClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 985, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L36" - } - ], - "signatures": [ - { - "id": 986, - "name": "StorageClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a client for Storage buckets, files, analytics, and vectors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst avatars = supabase.storage.from('avatars')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {\n apikey: 'your-publishable-key',\n})\nconst avatars = storage.from('avatars')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L36" - } - ], - "parameters": [ - { - "id": 987, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 988, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 989, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 38, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L38" - } - ], - "indexSignatures": [ - { - "id": 990, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 38, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L38" - } - ], - "parameters": [ - { - "id": 991, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 992, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 993, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 994, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 995, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 996, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 997, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 998, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 999, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1000, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1112, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 984, - "name": "StorageClient", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 138, - "name": "default.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 137, - "name": "default.constructor" - } - }, - { - "id": 1006, - "name": "analytics", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 95, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L95" - } - ], - "getSignature": { - "id": 1007, - "name": "analytics", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access analytics storage operations using Iceberg tables.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A StorageAnalyticsClient instance configured with the current storage settings." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 95, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L95" - } - ], - "type": { - "type": "reference", - "target": 48, - "name": "StorageAnalyticsClient", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1004, - "name": "vectors", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L75" - } - ], - "getSignature": { - "id": 1005, - "name": "vectors", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access vector storage operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A StorageVectorsClient instance configured with the current storage settings." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 75, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L75" - } - ], - "type": { - "type": "reference", - "target": 549, - "name": "StorageVectorsClient", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1026, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "signatures": [ - { - "id": 1027, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created bucket name or error" - } - ] - }, - { - "tag": "@example", - "name": "Create bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "parameters": [ - { - "id": 1028, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are creating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1029, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1030, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1033, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L193" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1032, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 192, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L192" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1031, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 191, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1034, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "(private-beta) specifies the bucket type. see " - }, - { - "kind": "code", - "text": "`BucketType`" - }, - { - "kind": "text", - "text": " for more details.\n - default bucket type is " - }, - { - "kind": "code", - "text": "`STANDARD`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1033, 1032, 1031, 1034] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1035, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1036, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 200, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "name" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1037, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 201, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1036, 1037] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 199, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L199" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1039, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 204, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1040, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1039, 1040] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 203, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 172, - "name": "default.createBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 171, - "name": "default.createBucket" - } - }, - { - "id": 1068, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "signatures": [ - { - "id": 1069, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " - }, - { - "kind": "code", - "text": "`empty()`" - }, - { - "kind": "text", - "text": " the bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "parameters": [ - { - "id": 1070, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1071, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1072, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1074, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1074] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ] - } - } - }, - { - "id": 1075, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L381" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1072, 1075] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1076, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1077, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 384, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L384" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1078, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L385" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1077, 1078] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 383, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L383" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 214, - "name": "default.deleteBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 213, - "name": "default.deleteBucket" - } - }, - { - "id": 1057, - "name": "emptyBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "signatures": [ - { - "id": 1058, - "name": "emptyBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes all objects inside a single bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Empty bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "parameters": [ - { - "id": 1059, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to empty." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1060, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1061, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1062, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1063, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1063] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ] - } - } - }, - { - "id": 1064, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L334" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1061, 1064] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 332, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1065, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1066, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L337" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1067, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 338, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L338" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1066, 1067] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 336, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L336" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 203, - "name": "default.emptyBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 202, - "name": "default.emptyBucket" - } - }, - { - "id": 1001, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L58" - } - ], - "signatures": [ - { - "id": 1002, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform file operation in a bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Accessing a bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst avatars = supabase.storage.from('avatars')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 58, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L58" - } - ], - "parameters": [ - { - "id": 1003, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The bucket id to operate on." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 261, - "name": "StorageFileApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1017, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "signatures": [ - { - "id": 1018, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing Storage bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing bucket details or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "parameters": [ - { - "id": 1019, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to retrieve." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1020, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1021, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 131, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L131" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 1022, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 132, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1021, 1022] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 130, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1023, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1024, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L135" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1025, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 136, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L136" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1024, 1025] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 134, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 163, - "name": "default.getBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 162, - "name": "default.getBucket" - } - }, - { - "id": 1008, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "signatures": [ - { - "id": 1009, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Storage buckets within an existing project." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "List buckets with options", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "parameters": [ - { - "id": 1010, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reference", - "target": 1135, - "name": "ListBucketOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "limit": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ], - "offset": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ], - "sortColumn": [ - { - "kind": "text", - "text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')" - } - ], - "sortOrder": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ], - "search": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1011, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1012, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1013, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L74" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1012, 1013] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 72, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1014, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1015, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 77, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1016, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 78, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1015, 1016] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 154, - "name": "default.listBuckets" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 153, - "name": "default.listBuckets" - } - }, - { - "id": 1096, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 1097, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 1098, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1099, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 245, - "name": "default.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 244, - "name": "default.setHeader" - } - }, - { - "id": 1094, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 1095, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 243, - "name": "default.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 242, - "name": "default.throwOnError" - } - }, - { - "id": 1041, - "name": "updateBucket", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "signatures": [ - { - "id": 1042, - "name": "updateBucket", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Update bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "parameters": [ - { - "id": 1043, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are updating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1044, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1045, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1048, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 272, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1047, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 271, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1046, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 270, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L270" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1048, 1047, 1046] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 269, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L269" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1050, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1051, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1052, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1052] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ] - } - } - }, - { - "id": 1053, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1050, 1053] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1054, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1055, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 280, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L280" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1056, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 281, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L281" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1055, 1056] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L279" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 187, - "name": "default.updateBucket" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 186, - "name": "default.updateBucket" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [985] - }, - { - "title": "Accessors", - "children": [1006, 1004] - }, - { - "title": "Methods", - "children": [1026, 1068, 1057, 1001, 1017, 1008, 1096, 1094, 1041] - } - ], - "categories": [ - { - "title": "Other", - "children": [1096, 1094] - }, - { - "title": "Storage", - "children": [985, 1006, 1004, 1026, 1068, 1057, 1001, 1017, 1008, 1041] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L11" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 136, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1353, - "name": "StorageError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error class for all Storage errors\nSupports both 'storage' and 'vectors' namespaces" - } - ] - }, - "children": [ - { - "id": 1354, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L17" - } - ], - "signatures": [ - { - "id": 1355, - "name": "StorageError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L17" - } - ], - "parameters": [ - { - "id": 1356, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1357, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - }, - { - "id": 1358, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1359, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 1362, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1363, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1364, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1365, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1368, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1367, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1369, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1370, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1368, 1367, 1369, 1370] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1354] - }, - { - "title": "Properties", - "children": [1362, 1363] - }, - { - "title": "Methods", - "children": [1364] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L11" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1371, - "name": "StorageApiError" - }, - { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError" - }, - { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError" - } - ] - }, - { - "id": 1389, - "name": "StorageUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unknown error that doesn't match expected error patterns\nWraps the original error for debugging" - } - ] - }, - "children": [ - { - "id": 1390, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L93" - } - ], - "signatures": [ - { - "id": 1391, - "name": "StorageUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L93" - } - ], - "parameters": [ - { - "id": 1392, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1393, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1394, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1352, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "defaultValue": "'storage'" - } - ], - "type": { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1395, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 91, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L91" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1398, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1399, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1400, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1401, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1404, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1403, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1405, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1406, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1404, 1403, 1405, 1406] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1390] - }, - { - "title": "Properties", - "children": [1395, 1398, 1399] - }, - { - "title": "Methods", - "children": [1400] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 90, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L90" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1439, - "name": "StorageVectorsUnknownError" - } - ] - }, - { - "id": 1422, - "name": "StorageVectorsApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageApiError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1423, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L128" - } - ], - "signatures": [ - { - "id": 1424, - "name": "StorageVectorsApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 128, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L128" - } - ], - "parameters": [ - { - "id": 1425, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1426, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1427, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1422, - "name": "StorageVectorsApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1373, - "name": "StorageApiError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1372, - "name": "StorageApiError.constructor" - } - }, - { - "id": 1428, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 59, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1378, - "name": "StorageApiError.status" - } - }, - { - "id": 1429, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 60, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L60" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1379, - "name": "StorageApiError.statusCode" - } - }, - { - "id": 1430, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "signatures": [ - { - "id": 1431, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1432, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1434, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 76, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L76" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1433, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 75, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L75" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1435, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 77, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L77" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1436, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 78, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L78" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1434, 1433, 1435, 1436] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 74, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1381, - "name": "StorageApiError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1380, - "name": "StorageApiError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1423] - }, - { - "title": "Properties", - "children": [1428, 1429] - }, - { - "title": "Methods", - "children": [1430] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 127, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L127" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1371, - "name": "StorageApiError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1407, - "name": "StorageVectorsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1408, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L109" - } - ], - "signatures": [ - { - "id": 1409, - "name": "StorageVectorsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L109" - } - ], - "parameters": [ - { - "id": 1410, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1355, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1354, - "name": "StorageError.constructor" - } - }, - { - "id": 1413, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1362, - "name": "StorageError.status" - } - }, - { - "id": 1414, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1363, - "name": "StorageError.statusCode" - } - }, - { - "id": 1415, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1416, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1417, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1419, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1418, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1420, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1421, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1419, 1418, 1420, 1421] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1365, - "name": "StorageError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1364, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1408] - }, - { - "title": "Properties", - "children": [1413, 1414] - }, - { - "title": "Methods", - "children": [1415] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 108, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L108" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1439, - "name": "StorageVectorsUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use StorageUnknownError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" - } - ] - } - ] - }, - "children": [ - { - "id": 1440, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L138" - } - ], - "signatures": [ - { - "id": 1441, - "name": "StorageVectorsUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L138" - } - ], - "parameters": [ - { - "id": 1442, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1443, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 1439, - "name": "StorageVectorsUnknownError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": 1391, - "name": "StorageUnknownError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 1390, - "name": "StorageUnknownError.constructor" - } - }, - { - "id": 1444, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 91, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L91" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 1395, - "name": "StorageUnknownError.originalError" - } - }, - { - "id": 1447, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1398, - "name": "StorageUnknownError.status" - } - }, - { - "id": 1448, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1399, - "name": "StorageUnknownError.statusCode" - } - }, - { - "id": 1449, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "signatures": [ - { - "id": 1450, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1451, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1453, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 32, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1452, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 31, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1454, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 33, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1455, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 34, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1453, 1452, 1454, 1455] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1401, - "name": "StorageUnknownError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1400, - "name": "StorageUnknownError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1440] - }, - { - "title": "Properties", - "children": [1444, 1447, 1448] - }, - { - "title": "Methods", - "children": [1449] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 137, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L137" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1389, - "name": "StorageUnknownError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 1141, - "name": "AnalyticBucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents an Analytics Bucket using Apache Iceberg table format.\nAnalytics buckets are optimized for analytical queries and data processing." - } - ] - }, - "children": [ - { - "id": 1145, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ISO 8601 timestamp of bucket creation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 42, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L42" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1144, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage format used (e.g., 'iceberg')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 40, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L40" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1142, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 36, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L36" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1143, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bucket type - always 'ANALYTICS' for analytics buckets" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 38, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L38" - } - ], - "type": { - "type": "literal", - "value": "ANALYTICS" - } - }, - { - "id": 1146, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ISO 8601 timestamp of last update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 44, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1145, 1144, 1142, 1143, 1146] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 34, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L34" - } - ] - }, - { - "id": 1125, - "name": "Bucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1131, - "name": "allowed_mime_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 16, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L16" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1132, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 17, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L17" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1130, - "name": "file_size_limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 15, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L15" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1126, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 11, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L11" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1128, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L13" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1129, - "name": "owner", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L14" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1134, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 19, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L19" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1127, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 12, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L12" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - }, - { - "id": 1133, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L18" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1131, 1132, 1130, 1126, 1128, 1129, 1134, 1127, 1133] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 10, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L10" - } - ] - }, - { - "id": 1307, - "name": "DeleteVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch deleting vectors" - } - ] - }, - "children": [ - { - "id": 1309, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L549" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1310, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector keys to delete (1-500 items)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 550, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L550" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1308, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 548, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L548" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1309, 1310, 1308] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 547, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L547" - } - ] - }, - { - "id": 1190, - "name": "DestinationOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1191, - "name": "destinationBucket", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 176, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L176" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1191] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 175, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L175" - } - ] - }, - { - "id": 1243, - "name": "EncryptionConfiguration", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration for encryption at rest" - } - ] - }, - "children": [ - { - "id": 1244, - "name": "kmsKeyArn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ARN of the KMS key used for encryption" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 362, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L362" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1245, - "name": "sseType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server-side encryption type (e.g., 'KMS')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 363, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L363" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1244, 1245] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 361, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L361" - } - ] - }, - { - "id": 1341, - "name": "ErrorResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Standard response wrapper for failed operations" - } - ] - }, - "children": [ - { - "id": 1342, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Null on error" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 646, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L646" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1343, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "StorageError with details (named StorageVectorsError for vector operations)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 647, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L647" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1342, 1343] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 645, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L645" - } - ] - }, - { - "id": 1222, - "name": "FetchParameters", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1224, - "name": "cache", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Controls how the request interacts with the browser's HTTP cache.\n- 'default': Use standard cache behavior\n- 'no-store': Bypass cache entirely (useful in Edge Functions)\n- 'reload': Bypass cache but update it with response\n- 'no-cache': Validate with server before using cached response\n- 'force-cache': Use cache even if stale\n- 'only-if-cached': Only use cache, fail if not cached" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 296, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L296" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "default" - }, - { - "type": "literal", - "value": "no-store" - }, - { - "type": "literal", - "value": "reload" - }, - { - "type": "literal", - "value": "no-cache" - }, - { - "type": "literal", - "value": "force-cache" - }, - { - "type": "literal", - "value": "only-if-cached" - } - ] - } - }, - { - "id": 1223, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pass in an AbortController's signal to cancel the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 285, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L285" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1224, 1223] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 281, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L281" - } - ] - }, - { - "id": 1147, - "name": "FileMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata object returned by the Storage API for files\nContains information about file size, type, caching, and HTTP response details" - } - ] - }, - "children": [ - { - "id": 1151, - "name": "cacheControl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cache control directive (e.g., \"max-age=3600\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 59, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L59" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1153, - "name": "contentLength", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Content length in bytes (usually same as size)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 63, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L63" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1148, - "name": "eTag", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Entity tag for caching and conditional requests" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 53, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L53" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1154, - "name": "httpStatusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code from the storage backend" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 65, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L65" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1152, - "name": "lastModified", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last modification timestamp (ISO 8601)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 61, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L61" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1150, - "name": "mimetype", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "MIME type of the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 57, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L57" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1149, - "name": "size", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File size in bytes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L55" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1151, 1153, 1148, 1154, 1152, 1150, 1149] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 51, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L51" - } - ], - "indexSignatures": [ - { - "id": 1155, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Any additional custom metadata stored with the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 67, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L67" - } - ], - "parameters": [ - { - "id": 1156, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1157, - "name": "FileObject", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the List V1 API (list() method)\nNote: Folder entries will have null values for most fields except name\n\nWarning: Some fields may not be present in all API responses. Fields like\nbucket_id, owner, and buckets are not returned by list() operations." - } - ] - }, - "children": [ - { - "id": 1164, - "name": "bucket_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Bucket identifier - NOT returned by list() operations.\nMay be present in remove() responses. Do not rely on this field." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 94, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L94" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1166, - "name": "buckets", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Bucket object - NOT returned by list() or remove() operations.\nThis field should not be relied upon." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 104, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L104" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 1161, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 85, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L85" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1159, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 81, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L81" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1162, - "name": "last_accessed_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Last access timestamp (null for folders)" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 87, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L87" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1163, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File metadata including size, mimetype, etc. (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 89, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L89" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1158, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File or folder name (relative to the prefix) - always present" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L79" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1165, - "name": "owner", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Owner identifier - NOT returned by list() or remove() operations.\nThis field should not be relied upon." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 99, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L99" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1160, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last update timestamp (null for folders)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L83" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1164, 1166, 1161, 1159, 1162, 1163, 1158, 1165, 1160] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 77, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L77" - } - ] - }, - { - "id": 1167, - "name": "FileObjectV2", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the Info endpoint (info() method)\nContains detailed metadata for a specific file" - } - ] - }, - "children": [ - { - "id": 1171, - "name": "bucket_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bucket identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 119, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L119" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1174, - "name": "cache_control", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cache control header value" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 125, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L125" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1175, - "name": "content_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "MIME content type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 127, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L127" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1172, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 121, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L121" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1176, - "name": "etag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Entity tag for caching" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L129" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1168, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 113, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1177, - "name": "last_modified", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last modification timestamp (replaces updated_at)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 131, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L131" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1178, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom file metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 133, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L133" - } - ], - "type": { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - }, - { - "id": 1170, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 117, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L117" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1173, - "name": "size", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File size in bytes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 123, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L123" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1179, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The API returns last_modified instead.\nThis field may not be present in responses." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 138, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L138" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1169, - "name": "version", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File version identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 115, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L115" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1171, 1174, 1175, 1172, 1176, 1168, 1177, 1178, 1170, 1173, 1179, 1169] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 111, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L111" - } - ] - }, - { - "id": 1183, - "name": "FileOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1184, - "name": "cacheControl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " - }, - { - "kind": "code", - "text": "`Cache-Control: max-age=`" - }, - { - "kind": "text", - "text": " header. Defaults to 3600 seconds." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 150, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L150" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1185, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the " - }, - { - "kind": "code", - "text": "`Content-Type`" - }, - { - "kind": "text", - "text": " header value. Should be specified if using a " - }, - { - "kind": "code", - "text": "`fileBody`" - }, - { - "kind": "text", - "text": " that is neither " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": " nor " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " nor " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": ", otherwise will default to " - }, - { - "kind": "code", - "text": "`text/plain;charset=UTF-8`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 154, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L154" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1187, - "name": "duplex", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 162, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1189, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optionally add extra headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 172, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L172" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1188, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 167, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L167" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1186, - "name": "upsert", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 158, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L158" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1184, 1185, 1187, 1189, 1188, 1186] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 146, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L146" - } - ] - }, - { - "id": 1295, - "name": "GetVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch reading vectors" - } - ] - }, - "children": [ - { - "id": 1297, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L515" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1298, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector keys to retrieve" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 516, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L516" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1299, - "name": "returnData", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include vector data in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 517, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L517" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1300, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 518, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L518" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1296, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 514, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L514" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1297, 1298, 1299, 1300, 1296] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 513, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L513" - } - ] - }, - { - "id": 1301, - "name": "GetVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from getting vectors" - } - ] - }, - "children": [ - { - "id": 1302, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of retrieved vector objects" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 526, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L526" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1302] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 525, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L525" - } - ] - }, - { - "id": 1135, - "name": "ListBucketOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1136, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L23" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1137, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1140, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L27" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1138, - "name": "sortColumn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L25" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "id" - }, - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 1139, - "name": "sortOrder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L26" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1136, 1137, 1140, 1138, 1139] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 22, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L22" - } - ] - }, - { - "id": 1285, - "name": "ListIndexesOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing indexes within a bucket" - } - ] - }, - "children": [ - { - "id": 1288, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 100)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 491, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L491" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1289, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 492, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1287, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter indexes by name prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 490, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L490" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1286, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the parent vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 489, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L489" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1288, 1289, 1287, 1286] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 488, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L488" - } - ] - }, - { - "id": 1290, - "name": "ListIndexesResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing indexes" - } - ] - }, - "children": [ - { - "id": 1291, - "name": "indexes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of index names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1292, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1293, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1293] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 501, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501" - } - ] - } - } - } - }, - { - "id": 1294, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 502, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L502" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1291, 1294] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 500, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L500" - } - ] - }, - { - "id": 1276, - "name": "ListVectorBucketsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for fetching vector buckets" - } - ] - }, - "children": [ - { - "id": 1278, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 100)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 467, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L467" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1279, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 468, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L468" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1277, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter buckets by name prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 466, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L466" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1278, 1279, 1277] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 465, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L465" - } - ] - }, - { - "id": 1280, - "name": "ListVectorBucketsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing vector buckets" - } - ] - }, - "children": [ - { - "id": 1284, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 478, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L478" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1281, - "name": "vectorBuckets", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of bucket names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1282, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1283, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1283] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 477, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1284, 1281] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 476, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L476" - } - ] - }, - { - "id": 1311, - "name": "ListVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing/scanning vectors in an index\nSupports parallel scanning via segment configuration" - } - ] - }, - "children": [ - { - "id": 1313, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 567, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L567" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1314, - "name": "maxResults", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results to return (default: 500, max: 1000)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 568, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L568" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1315, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for pagination from previous response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 569, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L569" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1316, - "name": "returnData", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include vector data in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 570, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L570" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1317, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in response" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 571, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L571" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1318, - "name": "segmentCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of parallel segments (1-16)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 572, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L572" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1319, - "name": "segmentIndex", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Zero-based index of this segment (0 to segmentCount-1)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 573, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L573" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1312, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L566" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1313, 1314, 1315, 1316, 1317, 1318, 1319, 1312] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 565, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L565" - } - ] - }, - { - "id": 1320, - "name": "ListVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from listing vectors" - } - ] - }, - "children": [ - { - "id": 1322, - "name": "nextToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token for fetching next page (if more results exist)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 583, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L583" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1321, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vector objects" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 582, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L582" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1322, 1321] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 581, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L581" - } - ] - }, - { - "id": 1225, - "name": "Metadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1226, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1226] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 300, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L300" - } - ] - }, - { - "id": 1250, - "name": "MetadataConfiguration", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata configuration for vector index\nDefines which metadata keys should not be indexed for filtering" - } - ] - }, - "children": [ - { - "id": 1251, - "name": "nonFilterableMetadataKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of metadata keys that cannot be used in filters" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 384, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L384" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1251] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 383, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L383" - } - ] - }, - { - "id": 1303, - "name": "PutVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for batch inserting/updating vectors" - } - ] - }, - "children": [ - { - "id": 1305, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 537, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L537" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1304, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 536, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L536" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1306, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of vectors to insert/upsert (1-500 items)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 538, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L538" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1267, - "name": "VectorObject", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1305, 1304, 1306] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 535, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L535" - } - ] - }, - { - "id": 1324, - "name": "QueryVectorsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for querying similar vectors (ANN search)" - } - ] - }, - "children": [ - { - "id": 1329, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional JSON filter for metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 607, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L607" - } - ], - "type": { - "type": "reference", - "target": 1323, - "name": "VectorFilter", - "package": "@supabase/storage-js" - } - }, - { - "id": 1326, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 604, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L604" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1327, - "name": "queryVector", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query vector to find similar vectors" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 605, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L605" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1330, - "name": "returnDistance", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include distance scores" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 608, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L608" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1331, - "name": "returnMetadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include metadata in results" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 609, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L609" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1328, - "name": "topK", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of nearest neighbors to return (default: 10)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 606, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L606" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1325, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 603, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L603" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1329, 1326, 1327, 1330, 1331, 1328, 1325] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 602, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L602" - } - ] - }, - { - "id": 1332, - "name": "QueryVectorsResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from vector similarity query" - } - ] - }, - "children": [ - { - "id": 1334, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The distance metric used for the similarity search" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 619, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L619" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 1333, - "name": "vectors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of similar vectors ordered by distance" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 618, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L618" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1271, - "name": "VectorMatch", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1334, 1333] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 617, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L617" - } - ] - }, - { - "id": 1192, - "name": "SearchOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1193, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of files you want to be returned." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n100\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 184, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L184" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1194, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 189, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L189" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1196, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The search string to filter files by." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 199, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1195, - "name": "sortBy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to sort by. Can be any column inside a FileObject." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 194, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1180, - "name": "SortBy", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1193, 1194, 1196, 1195] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 179, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L179" - } - ] - }, - { - "id": 1214, - "name": "SearchV2Folder", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Folder entry returned by the List V2 API (listV2() method) when using with_delimiter: true" - } - ] - }, - "children": [ - { - "id": 1216, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full folder key/path" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 271, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L271" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1215, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Folder name/prefix" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 269, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L269" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1216, 1215] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 267, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L267" - } - ] - }, - { - "id": 1206, - "name": "SearchV2Object", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File object returned by the List V2 API (listV2() method)\nObjects and folders are returned in separate arrays - this type represents\nactual files only. Use SearchV2Folder for folder entries." - } - ] - }, - "children": [ - { - "id": 1211, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creation timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 257, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L257" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1209, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the file" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 253, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L253" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1208, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full object key/path" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 251, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L251" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1213, - "name": "last_accessed_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Last access timestamp" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 261, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L261" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1212, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File metadata including size, mimetype, etc. (null if not yet set)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 259, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L259" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1147, - "name": "FileMetadata", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1207, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "File name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 249, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L249" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1210, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last update timestamp" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 255, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L255" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1211, 1209, 1208, 1213, 1212, 1207, 1210] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 247, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L247" - } - ] - }, - { - "id": 1200, - "name": "SearchV2Options", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1203, - "name": "cursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cursor used for pagination. Pass the value received from nextCursor of the previous request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 222, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L222" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1201, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of files you want to be returned." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n1000\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 212, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L212" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1202, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix search string to filter files by." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 217, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L217" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1205, - "name": "sortBy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column and order to sort by" - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n'name asc'\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 239, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L239" - } - ], - "type": { - "type": "reference", - "target": 1197, - "name": "SortByV2", - "package": "@supabase/storage-js" - } - }, - { - "id": 1204, - "name": "with_delimiter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to emulate a hierarchical listing of objects using delimiters.\n\n- When " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " (default), all objects are listed as flat key/value pairs.\n- When " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the response groups objects by delimiter, making it appear\n like a file/folder hierarchy." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 233, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L233" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1203, 1201, 1202, 1205, 1204] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 207, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L207" - } - ] - }, - { - "id": 1217, - "name": "SearchV2Result", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1219, - "name": "folders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 276, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L276" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1214, - "name": "SearchV2Folder", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1218, - "name": "hasNext", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 275, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L275" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1221, - "name": "nextCursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 278, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L278" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1220, - "name": "objects", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 277, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L277" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1206, - "name": "SearchV2Object", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1219, 1218, 1221, 1220] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 274, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L274" - } - ] - }, - { - "id": 1180, - "name": "SortBy", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1181, - "name": "column", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 142, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L142" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1182, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 143, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L143" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1181, 1182] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 141, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L141" - } - ] - }, - { - "id": 1197, - "name": "SortByV2", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1198, - "name": "column", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 203, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L203" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 1199, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 204, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L204" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1198, 1199] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 202, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L202" - } - ] - }, - { - "id": 1112, - "name": "StorageClientOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1113, - "name": "useNewHostname", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L8" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/StorageClient.ts", - "line": 7, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L7" - } - ] - }, - { - "id": 1337, - "name": "SuccessResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Standard response wrapper for successful operations" - } - ] - }, - "children": [ - { - "id": 1338, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response data of type T" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 636, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L636" - } - ], - "type": { - "type": "reference", - "target": 1340, - "name": "T", - "package": "@supabase/storage-js", - "qualifiedName": "SuccessResponse.T", - "refersToTypeParameter": true - } - }, - { - "id": 1339, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Null on success" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 637, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L637" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1338, 1339] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L635" - } - ], - "typeParameters": [ - { - "id": 1340, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ] - }, - { - "id": 1227, - "name": "TransformOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1232, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 332, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L332" - } - ], - "type": { - "type": "literal", - "value": "origin" - } - }, - { - "id": 1229, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the image in pixels." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 312, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L312" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1231, - "name": "quality", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 325, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L325" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1230, - "name": "resize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 319, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L319" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "cover" - }, - { - "type": "literal", - "value": "contain" - }, - { - "type": "literal", - "value": "fill" - } - ] - } - }, - { - "id": 1228, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the image in pixels." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 308, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1232, 1229, 1231, 1230, 1228] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 304, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L304" - } - ] - }, - { - "id": 1246, - "name": "VectorBucket", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector bucket metadata" - } - ] - }, - "children": [ - { - "id": 1248, - "name": "creationTime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unix timestamp of when the bucket was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 374, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L374" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1249, - "name": "encryptionConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional encryption settings" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 375, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L375" - } - ], - "type": { - "type": "reference", - "target": 1243, - "name": "EncryptionConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 1247, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name of the vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 373, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L373" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1248, 1249, 1247] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 372, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L372" - } - ] - }, - { - "id": 1264, - "name": "VectorData", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector data representation\nVectors must be float32 arrays with dimensions matching the index" - } - ] - }, - "children": [ - { - "id": 1265, - "name": "float32", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of 32-bit floating point numbers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 424, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L424" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "number" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1265] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 423, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L423" - } - ] - }, - { - "id": 1335, - "name": "VectorFetchParameters", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fetch-specific parameters like abort signals" - } - ] - }, - "children": [ - { - "id": 1336, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AbortSignal for cancelling requests" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 627, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L627" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1336] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 626, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L626" - } - ] - }, - { - "id": 1256, - "name": "VectorIndex", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector index configuration and metadata" - } - ] - }, - "children": [ - { - "id": 1263, - "name": "creationTime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unix timestamp of when the index was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L415" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1259, - "name": "dataType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data type of vector components (currently only 'float32')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L411" - } - ], - "type": { - "type": "reference", - "target": 1252, - "name": "VectorDataType", - "package": "@supabase/storage-js" - } - }, - { - "id": 1260, - "name": "dimension", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Dimensionality of vectors (e.g., 384, 768, 1536)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 412, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L412" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1261, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Similarity metric used for queries" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 413, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L413" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 1257, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name of the index within the bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 409, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L409" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1262, - "name": "metadataConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration for metadata filtering" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 414, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L414" - } - ], - "type": { - "type": "reference", - "target": 1250, - "name": "MetadataConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 1258, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the parent vector bucket" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L410" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1263, 1259, 1260, 1261, 1257, 1262, 1258] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 408, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L408" - } - ] - }, - { - "id": 1271, - "name": "VectorMatch", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector object returned from queries with optional distance" - } - ] - }, - "children": [ - { - "id": 1273, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector embedding data (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 454, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L454" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1275, - "name": "distance", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Similarity distance from query vector (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 456, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L456" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1272, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the vector" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 453, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L453" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1274, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arbitrary metadata (if requested)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 455, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L455" - } - ], - "type": { - "type": "reference", - "target": 1266, - "name": "VectorMetadata", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1273, 1275, 1272, 1274] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 452, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L452" - } - ] - }, - { - "id": 1267, - "name": "VectorObject", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Single vector object for insertion/update" - } - ] - }, - "children": [ - { - "id": 1269, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector embedding data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 441, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L441" - } - ], - "type": { - "type": "reference", - "target": 1264, - "name": "VectorData", - "package": "@supabase/storage-js" - } - }, - { - "id": 1268, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the vector" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 440, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L440" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1270, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional arbitrary metadata" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 442, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L442" - } - ], - "type": { - "type": "reference", - "target": 1266, - "name": "VectorMetadata", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1269, 1268, 1270] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 439, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L439" - } - ] - }, - { - "id": 1344, - "name": "ApiResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Union type for all API responses\nFollows the pattern: { data: T, error: null } | { data: null, error: Error }" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 654, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L654" - } - ], - "typeParameters": [ - { - "id": 1345, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1337, - "typeArguments": [ - { - "type": "reference", - "target": 1345, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "SuccessResponse", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 1341, - "name": "ErrorResponse", - "package": "@supabase/storage-js" - } - ] - } - }, - { - "id": 1123, - "name": "BucketType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of storage bucket\n- STANDARD: Regular file storage buckets\n- ANALYTICS: Iceberg table-based buckets for analytical workloads" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 8, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L8" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "STANDARD" - }, - { - "type": "literal", - "value": "ANALYTICS" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1124, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 8, - "character": 62, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L8" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1233, - "name": "Camelize", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 339, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L339" - } - ], - "typeParameters": [ - { - "id": 1234, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1234, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1234, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - "nameType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "CamelCase" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Extract", - "package": "typescript" - } - ], - "name": "CamelCase", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 1254, - "name": "DistanceMetric", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Distance metrics for vector similarity search" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 396, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L396" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "cosine" - }, - { - "type": "literal", - "value": "euclidean" - }, - { - "type": "literal", - "value": "dotproduct" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1255, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 396, - "character": 79, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L396" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1235, - "name": "DownloadResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 343, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L343" - } - ], - "typeParameters": [ - { - "id": 1242, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1236, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1237, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 345, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L345" - } - ], - "type": { - "type": "reference", - "target": 1242, - "name": "T", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - { - "id": 1238, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 346, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L346" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1237, 1238] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 344, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L344" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1239, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1240, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 349, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L349" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1241, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 350, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L350" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1240, 1241] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 348, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L348" - } - ] - } - } - ] - } - }, - { - "id": 1352, - "name": "ErrorNamespace", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace type for error classes\nDetermines the error class names and type guards" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 5, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L5" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "storage" - }, - { - "type": "literal", - "value": "vectors" - } - ] - } - }, - { - "id": 1252, - "name": "VectorDataType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supported data types for vectors\nCurrently only float32 is supported" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 391, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L391" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "float32" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1253, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 391, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L391" - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1323, - "name": "VectorFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON filter expression for metadata filtering\nFormat and syntax depend on the S3 Vectors service implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 590, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L590" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1266, - "name": "VectorMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arbitrary JSON metadata attached to vectors\nKeys configured as non-filterable in the index can be stored but not queried" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/types.ts", - "line": 431, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L431" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1346, - "name": "isStorageError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L50" - } - ], - "signatures": [ - { - "id": 1347, - "name": "isStorageError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type guard to check if an error is a StorageError" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "True if the error is a StorageError" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 50, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L50" - } - ], - "parameters": [ - { - "id": 1348, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The error to check" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - } - ] - }, - { - "id": 1349, - "name": "isStorageVectorsError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 119, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L119" - } - ], - "signatures": [ - { - "id": 1350, - "name": "isStorageVectorsError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type guard to check if an error is a StorageVectorsError" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "True if the error is a StorageVectorsError" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/errors.ts", - "line": 119, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L119" - } - ], - "parameters": [ - { - "id": 1351, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The error to check" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 1407, - "name": "StorageVectorsError", - "package": "@supabase/storage-js" - } - } - } - ] - }, - { - "id": 1122, - "name": "CreateIndexOptions", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 15, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L15" - } - ], - "target": 912 - }, - { - "id": 1114, - "name": "StorageAnalyticsClient", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 3, - "character": 20, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L3" - } - ], - "target": 48 - }, - { - "id": 1115, - "name": "StorageVectorsClient", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 7, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L7" - } - ], - "target": 549 - }, - { - "id": 1118, - "name": "StorageVectorsClientOptions", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 11, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L11" - } - ], - "target": 536 - }, - { - "id": 1116, - "name": "VectorBucketScope", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L8" - } - ], - "target": 604 - }, - { - "id": 1117, - "name": "VectorIndexScope", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L9" - } - ], - "target": 672 - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [1456] - }, - { - "title": "Classes", - "children": [1371, 984, 1353, 1389, 1422, 1407, 1439] - }, - { - "title": "Interfaces", - "children": [ - 1141, 1125, 1307, 1190, 1243, 1341, 1222, 1147, 1157, 1167, 1183, 1295, 1301, 1135, - 1285, 1290, 1276, 1280, 1311, 1320, 1225, 1250, 1303, 1324, 1332, 1192, 1214, 1206, - 1200, 1217, 1180, 1197, 1112, 1337, 1227, 1246, 1264, 1335, 1256, 1271, 1267 - ] - }, - { - "title": "Type Aliases", - "children": [1344, 1123, 1233, 1254, 1235, 1352, 1252, 1323, 1266] - }, - { - "title": "Functions", - "children": [1346, 1349] - }, - { - "title": "References", - "children": [1122, 1114, 1115, 1118, 1116, 1117] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L1" - } - ] - }, - { - "id": 2, - "name": "packages/BlobDownloadBuilder", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 3, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L9" - } - ], - "signatures": [ - { - "id": 5, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L9" - } - ], - "parameters": [ - { - "id": 6, - "name": "downloadFn", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 7, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 10, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10" - } - ], - "signatures": [ - { - "id": 8, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 10, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 9, - "name": "shouldThrowOnError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": 3, - "name": "BlobDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 45, - "name": "[toStringTag]", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 6, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L6" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'BlobDownloadBuilder'", - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.[toStringTag]" - } - }, - { - "id": 15, - "name": "asStream", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14" - } - ], - "signatures": [ - { - "id": 16, - "name": "asStream", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 14, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14" - } - ], - "type": { - "type": "reference", - "target": 741, - "name": "StreamDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 29, - "name": "catch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L25" - } - ], - "signatures": [ - { - "id": 30, - "name": "catch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback for only the rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L25" - } - ], - "typeParameters": [ - { - "id": 31, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 32, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 33, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 26, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26" - } - ], - "signatures": [ - { - "id": 34, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 26, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26" - } - ], - "parameters": [ - { - "id": 35, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 31, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - }, - { - "id": 36, - "name": "finally", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "signatures": [ - { - "id": 37, - "name": "finally", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\nresolved value cannot be modified from the callback." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "parameters": [ - { - "id": 38, - "name": "onfinally", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is settled (fulfilled or rejected)." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 39, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "signatures": [ - { - "id": 40, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 31, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - }, - { - "id": 17, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18" - } - ], - "signatures": [ - { - "id": 18, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 18, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18" - } - ], - "typeParameters": [ - { - "id": 19, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - }, - { - "id": 20, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 21, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 22, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 19, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19" - } - ], - "signatures": [ - { - "id": 23, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 19, - "character": 19, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19" - } - ], - "parameters": [ - { - "id": 24, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 25, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 26, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 20, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20" - } - ], - "signatures": [ - { - "id": 27, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 20, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20" - } - ], - "parameters": [ - { - "id": 28, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 19, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 20, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [4] - }, - { - "title": "Properties", - "children": [45] - }, - { - "title": "Methods", - "children": [15, 29, 36, 17] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 5, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L5" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [3] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L1" - } - ] - }, - { - "id": 46, - "name": "packages/StorageAnalyticsClient", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 48, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client class for managing Analytics Buckets using Iceberg tables\nProvides methods for creating, listing, and deleting analytics buckets" - } - ] - }, - "children": [ - { - "id": 49, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "signatures": [ - { - "id": 50, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new StorageAnalyticsClient instance\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.storage.analytics.listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { StorageAnalyticsClient } from '@supabase/storage-js'\n\nconst client = new StorageAnalyticsClient(url, headers)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "parameters": [ - { - "id": 51, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The base URL for the storage API" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 52, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers to include in requests" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 53, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "indexSignatures": [ - { - "id": 54, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 50, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50" - } - ], - "parameters": [ - { - "id": 55, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 56, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom fetch implementation" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 57, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 58, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 59, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 60, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 61, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 62, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 63, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 48, - "name": "StorageAnalyticsClient", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 64, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 95, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L95" - } - ], - "signatures": [ - { - "id": 65, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new analytics bucket using Iceberg tables\nAnalytics buckets are optimized for analytical queries and data processing\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created analytics bucket or error" - } - ] - }, - { - "tag": "@example", - "name": "Create analytics bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Creates a new analytics bucket using Iceberg tables\n- Analytics buckets are optimized for analytical queries and data processing" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 95, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L95" - } - ], - "parameters": [ - { - "id": 66, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique name for the bucket you are creating" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 68, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 97, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L97" - } - ], - "type": { - "type": "reference", - "target": 1141, - "name": "AnalyticBucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 69, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 98, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L98" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [68, 69] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 96, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L96" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 70, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 71, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 101, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L101" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 72, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 102, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L102" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [71, 72] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 100, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L100" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 88, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 228, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L228" - } - ], - "signatures": [ - { - "id": 89, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing analytics bucket\nA bucket can't be deleted with existing objects inside it\nYou must first empty the bucket before deletion\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete analytics bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .deleteBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deletes an analytics bucket" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 228, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L228" - } - ], - "parameters": [ - { - "id": 90, - "name": "bucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 91, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 92, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 93, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 94, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [94] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 230, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230" - } - ] - } - } - }, - { - "id": 95, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 231, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L231" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [92, 95] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 229, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L229" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 96, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 97, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 234, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L234" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 98, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 235, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L235" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [97, 98] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 233, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L233" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 99, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 372, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L372" - } - ], - "signatures": [ - { - "id": 100, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get an Iceberg REST Catalog client configured for a specific analytics bucket\nUse this to perform advanced table and namespace operations within the bucket\nThe returned client provides full access to the Apache Iceberg REST Catalog API\nwith the Supabase " - }, - { - "kind": "code", - "text": "`{ data, error }`" - }, - { - "kind": "text", - "text": " pattern for consistent error handling on all operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The wrapped Iceberg catalog client" - } - ] - }, - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "If the bucket name is invalid" - } - ] - }, - { - "tag": "@example", - "name": "Get catalog and create table", - "content": [ - { - "kind": "code", - "text": "```js\n// First, create an analytics bucket\nconst { data: bucket, error: bucketError } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n\n// Get the Iceberg catalog for that bucket\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Create a namespace\nconst { error: nsError } = await catalog.createNamespace({ namespace: ['default'] })\n\n// Create a table with schema\nconst { data: tableMetadata, error: tableError } = await catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false }\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1]\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: []\n },\n 'write-order': {\n 'order-id': 0,\n fields: []\n },\n properties: {\n 'write.format.default': 'parquet'\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "List tables in namespace", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all tables in the default namespace\nconst { data: tables, error: listError } = await catalog.listTables({ namespace: ['default'] })\nif (listError) {\n if (listError.isNotFound()) {\n console.log('Namespace not found')\n }\n return\n}\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Working with namespaces", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all namespaces\nconst { data: namespaces } = await catalog.listNamespaces()\n\n// Create namespace with properties\nawait catalog.createNamespace(\n { namespace: ['production'] },\n { properties: { owner: 'data-team', env: 'prod' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup operations", - "content": [ - { - "kind": "code", - "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Drop table with purge option (removes all data)\nconst { error: dropError } = await catalog.dropTable(\n { namespace: ['default'], name: 'events' },\n { purge: true }\n)\n\nif (dropError?.isNotFound()) {\n console.log('Table does not exist')\n}\n\n// Drop namespace (must be empty)\nawait catalog.dropNamespace({ namespace: ['default'] })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "This method provides a bridge between Supabase's bucket management and the standard\nApache Iceberg REST Catalog API. The bucket name maps to the Iceberg warehouse parameter.\nAll authentication and configuration is handled automatically using your Supabase credentials.\n\n**Error Handling**: Invalid bucket names throw immediately. All catalog\noperations return " - }, - { - "kind": "code", - "text": "`{ data, error }`" - }, - { - "kind": "text", - "text": " where errors are " - }, - { - "kind": "code", - "text": "`IcebergError`" - }, - { - "kind": "text", - "text": " instances from iceberg-js.\nUse helper methods like " - }, - { - "kind": "code", - "text": "`error.isNotFound()`" - }, - { - "kind": "text", - "text": " or check " - }, - { - "kind": "code", - "text": "`error.status`" - }, - { - "kind": "text", - "text": " for specific error handling.\nUse " - }, - { - "kind": "code", - "text": "`.throwOnError()`" - }, - { - "kind": "text", - "text": " on the analytics client if you prefer exceptions for catalog operations.\n\n**Cleanup Operations**: When using " - }, - { - "kind": "code", - "text": "`dropTable`" - }, - { - "kind": "text", - "text": ", the " - }, - { - "kind": "code", - "text": "`purge: true`" - }, - { - "kind": "text", - "text": " option permanently\ndeletes all table data. Without it, the table is marked as deleted but data remains.\n\n**Library Dependency**: The returned catalog wraps " - }, - { - "kind": "code", - "text": "`IcebergRestCatalog`" - }, - { - "kind": "text", - "text": " from iceberg-js.\nFor complete API documentation and advanced usage, refer to the\n[iceberg-js documentation](https://supabase.github.io/iceberg-js/)." - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 372, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L372" - } - ], - "parameters": [ - { - "id": 101, - "name": "bucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the analytics bucket (warehouse) to connect to" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 47, - "name": "WrappedIcebergRestCatalog", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 73, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ], - "signatures": [ - { - "id": 74, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Analytics Storage buckets within an existing project\nOnly returns buckets of type 'ANALYTICS'\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Analytics Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of analytics buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List analytics buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc'\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Retrieves the details of all Analytics Storage buckets within an existing project\n- Only returns buckets of type 'ANALYTICS'" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ], - "parameters": [ - { - "id": 75, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 77, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 162, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L162" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 78, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 163, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L163" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 81, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 166, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L166" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 79, - "name": "sortColumn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Column to sort by ('name', 'created_at', 'updated_at')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 164, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L164" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" - } - ] - } - }, - { - "id": 80, - "name": "sortOrder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 165, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L165" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "asc" - }, - { - "type": "literal", - "value": "desc" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [77, 78, 81, 79, 80] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 161, - "character": 30, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 82, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 83, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 169, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L169" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1141, - "name": "AnalyticBucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 84, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 170, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L170" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [83, 84] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 168, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L168" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 86, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 173, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L173" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 87, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 174, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L174" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [86, 87] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 172, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L172" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 119, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 120, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 121, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 122, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 117, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 118, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [49] - }, - { - "title": "Methods", - "children": [64, 88, 99, 73, 119, 117] - } - ], - "categories": [ - { - "title": "Other", - "children": [119, 117] - }, - { - "title": "Storage", - "children": [49, 64, 88, 99, 73] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 21, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L21" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 47, - "name": "WrappedIcebergRestCatalog", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 13, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L13" - } - ], - "type": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/iceberg-js@0.8.1/node_modules/iceberg-js/dist/index.d.ts", - "qualifiedName": "IcebergRestCatalog" - }, - "name": "IcebergRestCatalog", - "package": "iceberg-js" - } - }, - "templateType": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "WrapAsyncMethod" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/iceberg-js@0.8.1/node_modules/iceberg-js/dist/index.d.ts", - "qualifiedName": "IcebergRestCatalog" - }, - "name": "IcebergRestCatalog", - "package": "iceberg-js" - } - } - ], - "name": "WrapAsyncMethod", - "package": "@supabase/storage-js" - } - } - } - ], - "groups": [ - { - "title": "Classes", - "children": [48] - }, - { - "title": "Type Aliases", - "children": [47] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L1" - } - ] - }, - { - "id": 135, - "name": "packages/StorageBucketApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 136, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 137, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L9" - } - ], - "signatures": [ - { - "id": 138, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 9, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L9" - } - ], - "parameters": [ - { - "id": 139, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 140, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 11, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L11" - } - ], - "indexSignatures": [ - { - "id": 142, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 11, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L11" - } - ], - "parameters": [ - { - "id": 143, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 144, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 145, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 146, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 147, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 148, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 149, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 150, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 151, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 152, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1112, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 136, - "name": "StorageBucketApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 171, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "signatures": [ - { - "id": 172, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing newly created bucket name or error" - } - ] - }, - { - "tag": "@example", - "name": "Create bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 188, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" - } - ], - "parameters": [ - { - "id": 173, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are creating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 174, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 178, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 193, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L193" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 177, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 192, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L192" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 176, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 191, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 179, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "(private-beta) specifies the bucket type. see " - }, - { - "kind": "code", - "text": "`BucketType`" - }, - { - "kind": "text", - "text": " for more details.\n - default bucket type is " - }, - { - "kind": "code", - "text": "`STANDARD`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 194, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L194" - } - ], - "type": { - "type": "reference", - "target": 1123, - "name": "BucketType", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [178, 177, 176, 179] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 190, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 181, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 200, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "name" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 182, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 201, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [181, 182] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 199, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L199" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 184, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 204, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 185, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 205, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [184, 185] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 203, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 213, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "signatures": [ - { - "id": 214, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " - }, - { - "kind": "code", - "text": "`empty()`" - }, - { - "kind": "text", - "text": " the bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 378, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" - } - ], - "parameters": [ - { - "id": 215, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to delete." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 216, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 217, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 218, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 219, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [219] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 380, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380" - } - ] - } - } - }, - { - "id": 220, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L381" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [217, 220] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 379, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 222, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 384, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L384" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 223, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L385" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [222, 223] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 383, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L383" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 202, - "name": "emptyBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "signatures": [ - { - "id": 203, - "name": "emptyBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes all objects inside a single bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Empty bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 331, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" - } - ], - "parameters": [ - { - "id": 204, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to empty." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 205, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 206, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 207, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 208, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [208] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 333, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" - } - ] - } - } - }, - { - "id": 209, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 334, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L334" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [206, 209] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 332, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 210, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 211, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 337, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L337" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 212, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 338, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L338" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [211, 212] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 336, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L336" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 162, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "signatures": [ - { - "id": 163, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing Storage bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing bucket details or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 129, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" - } - ], - "parameters": [ - { - "id": 164, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the bucket you would like to retrieve." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 166, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 131, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L131" - } - ], - "type": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - }, - { - "id": 167, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 132, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [166, 167] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 130, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 168, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 169, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 135, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L135" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 170, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 136, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L136" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [169, 170] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 134, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 153, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "signatures": [ - { - "id": 154, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of all Storage buckets within an existing project." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List buckets", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```" - } - ] - }, - { - "tag": "@example", - "name": "List buckets with options", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 71, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" - } - ], - "parameters": [ - { - "id": 155, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters for listing buckets" - } - ] - }, - "type": { - "type": "reference", - "target": 1135, - "name": "ListBucketOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "limit": [ - { - "kind": "text", - "text": "Maximum number of buckets to return" - } - ], - "offset": [ - { - "kind": "text", - "text": "Number of buckets to skip" - } - ], - "sortColumn": [ - { - "kind": "text", - "text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')" - } - ], - "sortOrder": [ - { - "kind": "text", - "text": "Sort order ('asc' or 'desc')" - } - ], - "search": [ - { - "kind": "text", - "text": "Search term to filter bucket names" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 156, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 157, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 73, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1125, - "name": "Bucket", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 158, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 74, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L74" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [157, 158] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 72, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 159, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 160, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 77, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 161, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 78, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [160, 161] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 76, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 244, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 245, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 246, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 247, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 242, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 243, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - }, - { - "id": 186, - "name": "updateBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "signatures": [ - { - "id": 187, - "name": "updateBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a Storage bucket" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Update bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 267, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" - } - ], - "parameters": [ - { - "id": 188, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for the bucket you are updating." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 189, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 190, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 193, - "name": "allowedMimeTypes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 272, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 192, - "name": "fileSizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 271, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 191, - "name": "public", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 270, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L270" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [193, 192, 191] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 269, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L269" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 194, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 195, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 197, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [197] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 276, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" - } - ] - } - } - }, - { - "id": 198, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 277, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [195, 198] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 275, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 199, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 200, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 280, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L280" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 201, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 281, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L281" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [200, 201] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 279, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L279" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [137] - }, - { - "title": "Methods", - "children": [171, 213, 202, 162, 153, 244, 242, 186] - } - ], - "categories": [ - { - "title": "Other", - "children": [137, 244, 242] - }, - { - "title": "Storage", - "children": [171, 213, 202, 162, 153, 186] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 8, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L8" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 984, - "name": "StorageClient" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [136] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L1" - } - ] - }, - { - "id": 260, - "name": "packages/StorageFileApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 261, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 262, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L55" - } - ], - "signatures": [ - { - "id": 263, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 55, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L55" - } - ], - "parameters": [ - { - "id": 264, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 265, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 266, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 57, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L57" - } - ], - "indexSignatures": [ - { - "id": 267, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 57, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L57" - } - ], - "parameters": [ - { - "id": 268, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "{}" - }, - { - "id": 269, - "name": "bucketId", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 270, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 271, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 272, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 273, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 274, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 275, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 276, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 277, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 261, - "name": "StorageFileApi", - "package": "@supabase/storage-js", - "qualifiedName": "default" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.constructor" - } - }, - { - "id": 369, - "name": "copy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 600, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L600" - } - ], - "signatures": [ - { - "id": 370, - "name": "copy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Copies an existing file to a new path in the same bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing copied file path or error" - } - ] - }, - { - "tag": "@example", - "name": "Copy file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .copy('public/avatar1.png', 'private/avatar2.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"avatars/private/avatar2.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 600, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L600" - } - ], - "parameters": [ - { - "id": 371, - "name": "fromPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The original file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 372, - "name": "toPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new file path, including the new file name. For example " - }, - { - "kind": "code", - "text": "`folder/image-copy.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 373, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The destination options." - } - ] - }, - "type": { - "type": "reference", - "target": 1190, - "name": "DestinationOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 374, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 375, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 376, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 377, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [377] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 606, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606" - } - ] - } - } - }, - { - "id": 378, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 607, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L607" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [375, 378] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 605, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L605" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 380, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 610, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L610" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 381, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 611, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L611" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [380, 381] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 609, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L609" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 325, - "name": "createSignedUploadUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L380" - } - ], - "signatures": [ - { - "id": 326, - "name": "createSignedUploadUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing signed upload URL, token, and path or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed Upload URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUploadUrl('folder/cat.jpg')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/upload/sign/avatars/folder/cat.jpg?token=\",\n \"path\": \"folder/cat.jpg\",\n \"token\": \"\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 380, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L380" - } - ], - "parameters": [ - { - "id": 327, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 328, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 330, - "name": "upsert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, allows the file to be overwritten if it already exists." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 382, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L382" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [330] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 382, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L382" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 332, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 333, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 336, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 50, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 334, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 335, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 35, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [336, 334, 335] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 385, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385" - } - ] - } - } - }, - { - "id": 337, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L386" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [332, 337] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 384, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L384" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 339, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 389, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L389" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 340, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 390, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L390" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [339, 340] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 388, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L388" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 382, - "name": "createSignedUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 689, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L689" - } - ], - "signatures": [ - { - "id": 383, - "name": "createSignedUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing signed URL or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a signed URL for an asset with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60, {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a signed URL which triggers the download of the asset", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60, {\n download: true,\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 689, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L689" - } - ], - "parameters": [ - { - "id": 384, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 385, - "name": "expiresIn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the signed URL expires. For example, " - }, - { - "kind": "code", - "text": "`60`" - }, - { - "kind": "text", - "text": " for a URL which is valid for one minute." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 386, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 387, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 390, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 695, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L695" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 388, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 693, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L693" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - }, - { - "id": 389, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform the asset before serving it to the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 694, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L694" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [390, 388, 389] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 692, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L692" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 392, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 393, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 394, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [394] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 699, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699" - } - ] - } - } - }, - { - "id": 395, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 700, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L700" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [392, 395] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 698, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L698" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 396, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 397, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 703, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L703" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 398, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 704, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L704" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [397, 398] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 702, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L702" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 399, - "name": "createSignedUrls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 784, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L784" - } - ], - "signatures": [ - { - "id": 400, - "name": "createSignedUrls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of objects with signedUrl, path, and error or error" - } - ] - }, - { - "tag": "@example", - "name": "Create Signed URLs", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"error\": null,\n \"path\": \"folder/avatar1.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar1.png?token=\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\"\n },\n {\n \"error\": null,\n \"path\": \"folder/avatar2.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar2.png?token=\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar2.png?token=\"\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 784, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L784" - } - ], - "parameters": [ - { - "id": 401, - "name": "paths", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file paths to be downloaded, including the current file names. For example " - }, - { - "kind": "code", - "text": "`['folder/image.png', 'folder2/image2.png']`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 402, - "name": "expiresIn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the signed URLs expire. For example, " - }, - { - "kind": "code", - "text": "`60`" - }, - { - "kind": "text", - "text": " for URLs which are valid for one minute." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 403, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 404, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 406, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [406, 405] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 787, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 407, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 408, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 409, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 410, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 411, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 38, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 412, - "name": "signedUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [410, 411, 412] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 790, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790" - } - ] - } - } - } - }, - { - "id": 413, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 791, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L791" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [408, 413] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 789, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L789" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 414, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 415, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 794, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L794" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 416, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 795, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L795" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [415, 416] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 793, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L793" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 417, - "name": "download", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "signatures": [ - { - "id": 418, - "name": "download", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from " - }, - { - "kind": "code", - "text": "`getPublicUrl`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "BlobDownloadBuilder instance for downloading the file" - } - ] - }, - { - "tag": "@example", - "name": "Download file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": ,\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download file with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n quality: 80\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download with cache control (useful in Edge Functions)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {}, { cache: 'no-store' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Download with abort signal", - "content": [ - { - "kind": "code", - "text": "```js\nconst controller = new AbortController()\nsetTimeout(() => controller.abort(), 5000)\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {}, { signal: controller.signal })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "typeParameters": [ - { - "id": 419, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 420, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 422, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 59, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 421, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 29, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [422, 421] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 889, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889" - } - ] - } - } - } - ], - "parameters": [ - { - "id": 423, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The full path and file name of the file to be downloaded. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 424, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 419, - "name": "Options", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - }, - { - "id": 425, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional fetch parameters like signal for cancellation. Supports standard fetch options including cache control." - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 3, - "name": "BlobDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 435, - "name": "exists", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 980, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L980" - } - ], - "signatures": [ - { - "id": 436, - "name": "exists", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Checks the existence of a file." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing boolean indicating file existence or error" - } - ] - }, - { - "tag": "@example", - "name": "Check file existence", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .exists('folder/avatar1.png')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 980, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L980" - } - ], - "parameters": [ - { - "id": 437, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 438, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 439, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 982, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L982" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 440, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 983, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L983" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [439, 440] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 981, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L981" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 441, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 442, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 986, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L986" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 443, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 987, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L987" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [442, 443] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 985, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L985" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 444, - "name": "getPublicUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1079" - } - ], - "signatures": [ - { - "id": 445, - "name": "getPublicUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Object with public URL" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL for an asset in a public bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"publicUrl\": \"https://example.supabase.co/storage/v1/object/public/public-bucket/folder/avatar1.png\"\n }\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL for an asset in a public bucket with transformations", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Returns the URL which triggers the download of an asset in a public bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n download: true,\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The bucket needs to be set to public, either via [updateBucket()](/docs/reference/javascript/storage-updatebucket) or by going to Storage on [supabase.com/dashboard](https://supabase.com/dashboard), clicking the overflow menu on a bucket and choosing \"Make public\"\n- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1079, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1079" - } - ], - "parameters": [ - { - "id": 446, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path and name of the file to generate the public URL for. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 447, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 448, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 451, - "name": "cacheNonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Append a cache nonce parameter to the URL to invalidate the cache." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1084, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1084" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 449, - "name": "download", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1082, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1082" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - }, - { - "id": 450, - "name": "transform", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform the asset before serving it to the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1083, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1083" - } - ], - "type": { - "type": "reference", - "target": 1227, - "name": "TransformOptions", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [451, 449, 450] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1081, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1081" - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 455, - "name": "publicUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [455] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [453] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1086, - "character": 5, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086" - } - ] - } - } - } - ] - }, - { - "id": 426, - "name": "info", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 943, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L943" - } - ], - "signatures": [ - { - "id": 427, - "name": "info", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the details of an existing file.\n\nReturns detailed file metadata including size, content type, and timestamps.\nNote: The API returns " - }, - { - "kind": "code", - "text": "`last_modified`" - }, - { - "kind": "text", - "text": " field, not " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get file info", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .info('folder/avatar1.png')\n\nif (data) {\n console.log('Last modified:', data.lastModified)\n console.log('Size:', data.size)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 943, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L943" - } - ], - "parameters": [ - { - "id": 428, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 429, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 430, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 945, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L945" - } - ], - "type": { - "type": "reference", - "target": 1233, - "typeArguments": [ - { - "type": "reference", - "target": 1167, - "name": "FileObjectV2", - "package": "@supabase/storage-js" - } - ], - "name": "Camelize", - "package": "@supabase/storage-js" - } - }, - { - "id": 431, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 946, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L946" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [430, 431] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 944, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L944" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 432, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 433, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 949, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L949" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 434, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 950, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L950" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [433, 434] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 948, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L948" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 465, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1308, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1308" - } - ], - "signatures": [ - { - "id": 466, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all the files and folders within a path of the bucket.\n\n**Important:** For folder entries, fields like " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`last_accessed_at`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`metadata`" - }, - { - "kind": "text", - "text": " will be " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ". Only files have these fields populated.\nAdditionally, deprecated fields like " - }, - { - "kind": "code", - "text": "`bucket_id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`owner`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " are NOT returned\nby this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of files/folders or error" - } - ] - }, - { - "tag": "@example", - "name": "List files in a bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .list('folder', {\n limit: 100,\n offset: 0,\n sortBy: { column: 'name', order: 'asc' },\n })\n\n// Handle files vs folders\ndata?.forEach(item => {\n if (item.id !== null) {\n // It's a file\n console.log('File:', item.name, 'Size:', item.metadata?.size)\n } else {\n // It's a folder\n console.log('Folder:', item.name)\n }\n})\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"avatar1.png\",\n \"id\": \"e668cf7f-821b-4a2f-9dce-7dfa5dd1cfd2\",\n \"updated_at\": \"2024-05-22T23:06:05.580Z\",\n \"created_at\": \"2024-05-22T23:04:34.443Z\",\n \"last_accessed_at\": \"2024-05-22T23:04:34.443Z\",\n \"metadata\": {\n \"eTag\": \"\\\"c5e8c553235d9af30ef4f6e280790b92\\\"\",\n \"size\": 32175,\n \"mimetype\": \"image/png\",\n \"cacheControl\": \"max-age=3600\",\n \"lastModified\": \"2024-05-22T23:06:05.574Z\",\n \"contentLength\": 32175,\n \"httpStatusCode\": 200\n }\n }\n ],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Search files in a bucket", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .list('folder', {\n limit: 100,\n offset: 0,\n sortBy: { column: 'name', order: 'asc' },\n search: 'jon'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1308, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1308" - } - ], - "parameters": [ - { - "id": 467, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The folder path." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 468, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search options including limit (defaults to 100), offset, sortBy, and search" - } - ] - }, - "type": { - "type": "reference", - "target": 1192, - "name": "SearchOptions", - "package": "@supabase/storage-js" - } - }, - { - "id": 469, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional fetch parameters including signal for cancellation" - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 471, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1314, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1314" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1157, - "name": "FileObject", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 472, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1315, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1315" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [471, 472] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1313, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1313" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 473, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 474, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1318, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1318" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 475, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1319, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1319" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [474, 475] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1317, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1317" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 476, - "name": "listV2", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1381" - } - ], - "signatures": [ - { - "id": 477, - "name": "listV2", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all the files and folders within a bucket using the V2 API with pagination support.\n\n**Important:** Folder entries in the " - }, - { - "kind": "code", - "text": "`folders`" - }, - { - "kind": "text", - "text": " array only contain " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " and optionally " - }, - { - "kind": "code", - "text": "`key`" - }, - { - "kind": "text", - "text": " —\nthey have no " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", timestamps, or " - }, - { - "kind": "code", - "text": "`metadata`" - }, - { - "kind": "text", - "text": " fields. Full file metadata is only available\non entries in the " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " array.\n\n this method signature might change in the future" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing folders/objects arrays with pagination info or error" - } - ] - }, - { - "tag": "@example", - "name": "List files with pagination", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .listV2({\n prefix: 'folder/',\n limit: 100,\n })\n\n// Handle pagination\nif (data?.hasNext) {\n const nextPage = await supabase\n .storage\n .from('avatars')\n .listV2({\n prefix: 'folder/',\n cursor: data.nextCursor,\n })\n}\n\n// Handle files vs folders\ndata?.objects.forEach(file => {\n if (file.id !== null) {\n console.log('File:', file.name, 'Size:', file.metadata?.size)\n }\n})\ndata?.folders.forEach(folder => {\n console.log('Folder:', folder.name)\n})\n```" - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1381, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1381" - } - ], - "parameters": [ - { - "id": 478, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search options including prefix, cursor for pagination, limit, with_delimiter" - } - ] - }, - "type": { - "type": "reference", - "target": 1200, - "name": "SearchV2Options", - "package": "@supabase/storage-js" - } - }, - { - "id": 479, - "name": "parameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional fetch parameters including signal for cancellation" - } - ] - }, - "type": { - "type": "reference", - "target": 1222, - "name": "FetchParameters", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 480, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 481, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1386, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1386" - } - ], - "type": { - "type": "reference", - "target": 1217, - "name": "SearchV2Result", - "package": "@supabase/storage-js" - } - }, - { - "id": 482, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1387, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1387" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [481, 482] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1385, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1385" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 483, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 484, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1390, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1390" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 485, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1391, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1391" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [484, 485] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1389, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1389" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 356, - "name": "move", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 537, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L537" - } - ], - "signatures": [ - { - "id": 357, - "name": "move", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Moves an existing file to a new path in the same bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing success message or error" - } - ] - }, - { - "tag": "@example", - "name": "Move file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .move('public/avatar1.png', 'private/avatar2.png')\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully moved\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 537, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L537" - } - ], - "parameters": [ - { - "id": 358, - "name": "fromPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The original file path, including the current file name. For example " - }, - { - "kind": "code", - "text": "`folder/image.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 359, - "name": "toPath", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new file path, including the new file name. For example " - }, - { - "kind": "code", - "text": "`folder/image-new.png`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The destination options." - } - ] - }, - "type": { - "type": "reference", - "target": 1190, - "name": "DestinationOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 361, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 362, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 364, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [364] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 543, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" - } - ] - } - } - }, - { - "id": 365, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 544, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L544" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [362, 365] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 542, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L542" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 367, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 547, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L547" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 368, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 548, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L548" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [367, 368] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 546, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L546" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 456, - "name": "remove", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1143" - } - ], - "signatures": [ - { - "id": 457, - "name": "remove", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes files within the same bucket\n\nReturns an array of FileObject entries for the deleted files. Note that deprecated\nfields like " - }, - { - "kind": "code", - "text": "`bucket_id`" - }, - { - "kind": "text", - "text": " may or may not be present in the response - do not rely on them." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing array of deleted file objects or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete file", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .remove(['folder/avatar1.png'])\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [],\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`delete`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1143, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1143" - } - ], - "parameters": [ - { - "id": 458, - "name": "paths", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of files to delete, including the path and file name. For example [" - }, - { - "kind": "code", - "text": "`'folder/image.png'`" - }, - { - "kind": "text", - "text": "]." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 459, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 460, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1145, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1145" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1157, - "name": "FileObject", - "package": "@supabase/storage-js" - } - } - }, - { - "id": 461, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1146, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1146" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [460, 461] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1144, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1144" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 463, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1149, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1149" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 464, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1150, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1150" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [463, 464] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1148, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1148" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 519, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 520, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 521, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 522, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.setHeader" - } - }, - { - "id": 517, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 518, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseApiClient.throwOnError" - } - }, - { - "id": 489, - "name": "toBase64", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1410" - } - ], - "signatures": [ - { - "id": 490, - "name": "toBase64", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1410, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1410" - } - ], - "parameters": [ - { - "id": 491, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 341, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 476, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L476" - } - ], - "signatures": [ - { - "id": 342, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Replaces an existing file at the specified path with a new one." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path, id, and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Update file", - "content": [ - { - "kind": "code", - "text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', avatarFile, {\n cacheControl: '3600'\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update file using `ArrayBuffer` from base64 file data", - "content": [ - { - "kind": "code", - "text": "```js\nimport {decode} from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": "\n- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " always replaces the file at the given path regardless of the " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option.\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\n- For React Native, using either " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " does not work as intended. Update file using " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " from base64 file data instead, see example below." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 476, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L476" - } - ], - "parameters": [ - { - "id": 343, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The relative file path. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to update." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "__global.NodeJS.ReadableStream" - }, - "name": "ReadableStream", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.ReadableStream" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URLSearchParams" - }, - "name": "URLSearchParams", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/buffer.buffer.d.ts", - "qualifiedName": "__global.Buffer" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "Buffer", - "package": "@types/node", - "qualifiedName": "__global.Buffer" - } - ] - } - }, - { - "id": 345, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional file upload options including cacheControl, contentType, and metadata.\n**Note:** The " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option has no effect here. " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " always replaces the\nfile at the given path, so the " - }, - { - "kind": "code", - "text": "`x-upsert`" - }, - { - "kind": "text", - "text": " header is not sent. To control upsert\nbehavior, use " - }, - { - "kind": "code", - "text": "`upload()`" - }, - { - "kind": "text", - "text": " instead." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 346, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 347, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 348, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 351, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 349, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 350, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [351, 349, 350] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 492, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" - } - ] - } - } - }, - { - "id": 352, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 493, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L493" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [347, 352] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 491, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L491" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 353, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 354, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 496, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L496" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 355, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 497, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L497" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [354, 355] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 495, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L495" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 295, - "name": "upload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 219, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L219" - } - ], - "signatures": [ - { - "id": 296, - "name": "upload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Uploads a file to an existing bucket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path, id, and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Upload file", - "content": [ - { - "kind": "code", - "text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile, {\n cacheControl: '3600',\n upsert: false\n })\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upload file using `ArrayBuffer` from base64 file data", - "content": [ - { - "kind": "code", - "text": "```js\nimport { decode } from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile)\n\nif (error) {\n // Log the full error so fields like `statusCode` and `error` (the\n // Storage error name, e.g. \"Duplicate\") aren't hidden behind `error.message`.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: only " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " when you are uploading new files and " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`insert`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`update`" - }, - { - "kind": "text", - "text": " when you are upserting files\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\n- For React Native, using either " - }, - { - "kind": "code", - "text": "`Blob`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`File`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`FormData`" - }, - { - "kind": "text", - "text": " does not work as intended. Upload file using " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " from base64 file data instead, see example below." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 219, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L219" - } - ], - "parameters": [ - { - "id": 297, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to upload." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 298, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "FileBody" - }, - "name": "FileBody", - "package": "@supabase/storage-js" - } - }, - { - "id": 299, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional file upload options including cacheControl, contentType, upsert, and metadata." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 300, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 301, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 302, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 305, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 303, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 304, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [305, 303, 304] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 225, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225" - } - ] - } - } - }, - { - "id": 306, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 226, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L226" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [301, 306] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 224, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L224" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 307, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 308, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 229, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L229" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 309, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 230, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L230" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [308, 309] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 228, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L228" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 310, - "name": "uploadToSignedUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L274" - } - ], - "signatures": [ - { - "id": 311, - "name": "uploadToSignedUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Upload a file with a token generated from " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "File Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing file path and fullPath or error" - } - ] - }, - { - "tag": "@example", - "name": "Upload to a signed URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .uploadToSignedUrl('folder/cat.jpg', 'token-from-createSignedUploadUrl', file)\n```" - }, - { - "kind": "text", - "text": "\n\nResponse:\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"path\": \"folder/cat.jpg\",\n \"fullPath\": \"avatars/folder/cat.jpg\"\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- RLS policy permissions required:\n - " - }, - { - "kind": "code", - "text": "`buckets`" - }, - { - "kind": "text", - "text": " table permissions: none\n - " - }, - { - "kind": "code", - "text": "`objects`" - }, - { - "kind": "text", - "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 274, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L274" - } - ], - "parameters": [ - { - "id": 312, - "name": "path", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The file path, including the file name. Should be of the format " - }, - { - "kind": "code", - "text": "`folder/subfolder/filename.png`" - }, - { - "kind": "text", - "text": ". The bucket must already exist before attempting to upload." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 313, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token generated from " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl`" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 314, - "name": "fileBody", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the file to be stored in the bucket." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "FileBody" - }, - "name": "FileBody", - "package": "@supabase/storage-js" - } - }, - { - "id": 315, - "name": "fileOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers (cacheControl, contentType, etc.).\n**Note:** The " - }, - { - "kind": "code", - "text": "`upsert`" - }, - { - "kind": "text", - "text": " option has no effect here. To enable upsert behavior,\npass " - }, - { - "kind": "code", - "text": "`{ upsert: true }`" - }, - { - "kind": "text", - "text": " when calling " - }, - { - "kind": "code", - "text": "`createSignedUploadUrl()`" - }, - { - "kind": "text", - "text": " instead." - } - ] - }, - "type": { - "type": "reference", - "target": 1183, - "name": "FileOptions", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 316, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 317, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 318, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 54, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [317, 318] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 319, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 320, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 323, - "name": "fullPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 32, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "defaultValue": "data.Key" - }, - { - "id": 322, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "cleanPath" - } - ], - "groups": [ - { - "title": "Properties", - "children": [323, 322] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 339, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" - } - ] - } - } - }, - { - "id": 324, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [320, 324] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 90, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90" - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [262] - }, - { - "title": "Methods", - "children": [ - 369, 325, 382, 399, 417, 435, 444, 426, 465, 476, 356, 456, 519, 517, 489, 341, 295, - 310 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [262, 519, 517, 489] - }, - { - "title": "Storage", - "children": [ - 369, 325, 382, 399, 417, 435, 444, 426, 465, 476, 356, 456, 341, 295, 310 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 52, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L52" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1353, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ], - "name": "default", - "package": "@supabase/storage-js" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [261] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1" - } - ] - }, - { - "id": 535, - "name": "packages/StorageVectorsClient", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 549, - "name": "StorageVectorsClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Main client for interacting with S3 Vectors API\nProvides access to bucket, index, and vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.\n\n**Usage Patterns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .createBucket('embeddings-prod')\n\n// Access index operations via buckets\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine'\n})\n\n// Access vector operations via index\nconst index = bucket.index('documents')\nawait index.putVectors({\n vectors: [\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\n ]\n})\n\n// Query similar vectors\nconst { data } = await index.queryVectors({\n queryVector: { float32: [...] },\n topK: 5,\n returnDistance: true\n})\n```" - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 550, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L109" - } - ], - "signatures": [ - { - "id": 551, - "name": "StorageVectorsClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\nconst client = new StorageVectorsClient(url, options)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 109, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L109" - } - ], - "parameters": [ - { - "id": 552, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base URL of the Storage Vectors REST API." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 553, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 536, - "name": "StorageVectorsClientOptions", - "package": "@supabase/storage-js", - "highlightedProperties": { - "headers": [ - { - "kind": "text", - "text": "Optional headers (for example " - }, - { - "kind": "code", - "text": "`Authorization`" - }, - { - "kind": "text", - "text": ") applied to every request." - } - ], - "fetch": [ - { - "kind": "text", - "text": "Optional custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation for non-browser runtimes." - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 549, - "name": "StorageVectorsClient", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.constructor" - } - }, - { - "id": 557, - "name": "createBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 158, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L158" - } - ], - "signatures": [ - { - "id": 558, - "name": "createBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new vector bucket\nVector buckets are containers for vector indexes and their data\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .createBucket('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 158, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L158" - } - ], - "parameters": [ - { - "id": 559, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name for the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.createBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.createBucket" - } - }, - { - "id": 568, - "name": "deleteBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 242, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L242" - } - ], - "signatures": [ - { - "id": 569, - "name": "deleteBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a vector bucket (bucket must be empty)\nAll indexes must be deleted before deleting the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .deleteBucket('embeddings-old')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 242, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L242" - } - ], - "parameters": [ - { - "id": 570, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.deleteBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.deleteBucket" - } - }, - { - "id": 554, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L132" - } - ], - "signatures": [ - { - "id": 555, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access operations for a specific vector bucket\nReturns a scoped client for index and vector operations within the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Bucket-scoped client with index and vector operations" - } - ] - }, - { - "tag": "@example", - "name": "Accessing a vector bucket", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 132, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L132" - } - ], - "parameters": [ - { - "id": 556, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 604, - "name": "VectorBucketScope", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 560, - "name": "getBucket", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "signatures": [ - { - "id": 561, - "name": "getBucket", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves metadata for a specific vector bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with bucket metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get bucket metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .getBucket('embeddings-prod')\n\nconsole.log('Bucket created:', data?.vectorBucket.creationTime)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "parameters": [ - { - "id": 562, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the vector bucket" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 563, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 564, - "name": "vectorBucket", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 67, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ], - "type": { - "type": "reference", - "target": 1246, - "name": "VectorBucket", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [564] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 185, - "character": 65, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185" - } - ] - } - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.getBucket" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.getBucket" - } - }, - { - "id": 565, - "name": "listBuckets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 214, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L214" - } - ], - "signatures": [ - { - "id": 566, - "name": "listBuckets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all vector buckets with optional filtering and pagination\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with list of buckets or error" - } - ] - }, - { - "tag": "@example", - "name": "List vector buckets", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .listBuckets({ prefix: 'embeddings-' })\n\ndata?.vectorBuckets.forEach(bucket => {\n console.log(bucket.vectorBucketName)\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 214, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L214" - } - ], - "parameters": [ - { - "id": 567, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional filters (prefix, maxResults, nextToken)" - } - ] - }, - "type": { - "type": "reference", - "target": 1276, - "name": "ListVectorBucketsOptions", - "package": "@supabase/storage-js" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1280, - "name": "ListVectorBucketsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.listBuckets" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.listBuckets" - } - }, - { - "id": 588, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 589, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 590, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 591, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.setHeader" - } - }, - { - "id": 586, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 587, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorBucketApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [550] - }, - { - "title": "Methods", - "children": [557, 568, 554, 560, 565, 588, 586] - } - ], - "categories": [ - { - "title": "Other", - "children": [588, 586] - }, - { - "title": "Storage", - "children": [550, 557, 568, 554, 560, 565] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 80, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L80" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 604, - "name": "VectorBucketScope", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scoped client for operations within a specific vector bucket\nProvides index management and access to vector operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 605, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 273, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L273" - } - ], - "signatures": [ - { - "id": 606, - "name": "VectorBucketScope", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a helper that automatically scopes all index operations to the provided bucket.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector bucket scope", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 273, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L273" - } - ], - "parameters": [ - { - "id": 607, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 608, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 609, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 275, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L275" - } - ], - "indexSignatures": [ - { - "id": 610, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 275, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L275" - } - ], - "parameters": [ - { - "id": 611, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 612, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 613, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 614, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 615, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 616, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 617, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 618, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 619, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 620, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 604, - "name": "VectorBucketScope", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.constructor" - } - }, - { - "id": 622, - "name": "createIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 311, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L311" - } - ], - "signatures": [ - { - "id": 623, - "name": "createIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new vector index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents-openai',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine',\n metadataConfiguration: {\n nonFilterableMetadataKeys: ['raw_text']\n }\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 311, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L311" - } - ], - "parameters": [ - { - "id": 624, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Index configuration (vectorBucketName is automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 912, - "name": "CreateIndexOptions", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "vectorBucketName" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.createIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.createIndex" - } - }, - { - "id": 633, - "name": "deleteIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 390, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L390" - } - ], - "signatures": [ - { - "id": 634, - "name": "deleteIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an index from this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.deleteIndex('old-index')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 390, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L390" - } - ], - "parameters": [ - { - "id": 635, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.deleteIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.deleteIndex" - } - }, - { - "id": 628, - "name": "getIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 366, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L366" - } - ], - "signatures": [ - { - "id": 629, - "name": "getIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves metadata for a specific index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with index metadata or error" - } - ] - }, - { - "tag": "@example", - "name": "Get index metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nconst { data } = await bucket.getIndex('documents-openai')\nconsole.log('Dimension:', data?.index.dimension)\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 366, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L366" - } - ], - "parameters": [ - { - "id": 630, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index to retrieve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 631, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 632, - "name": "index", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 58, - "character": 27, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58" - } - ], - "type": { - "type": "reference", - "target": 1256, - "name": "VectorIndex", - "package": "@supabase/storage-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [632] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 58, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58" - } - ] - } - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.getIndex" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.getIndex" - } - }, - { - "id": 636, - "name": "index", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L426" - } - ], - "signatures": [ - { - "id": 637, - "name": "index", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access operations for a specific index within this bucket\nReturns a scoped client for vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Index-scoped client with vector data operations" - } - ] - }, - { - "tag": "@example", - "name": "Accessing an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\n\n// Insert vectors\nawait index.putVectors({\n vectors: [\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\n ]\n})\n\n// Query similar vectors\nconst { data } = await index.queryVectors({\n queryVector: { float32: [...] },\n topK: 5\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 426, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L426" - } - ], - "parameters": [ - { - "id": 638, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the index" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 672, - "name": "VectorIndexScope", - "package": "@supabase/storage-js" - } - } - ] - }, - { - "id": 625, - "name": "listIndexes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 338, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L338" - } - ], - "signatures": [ - { - "id": 626, - "name": "listIndexes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists indexes in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing indexes array and pagination token or error" - } - ] - }, - { - "tag": "@example", - "name": "List indexes", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nconst { data } = await bucket.listIndexes({ prefix: 'documents-' })\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 338, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L338" - } - ], - "parameters": [ - { - "id": 627, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listing options (vectorBucketName is automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1285, - "name": "ListIndexesOptions", - "package": "@supabase/storage-js" - }, - { - "type": "literal", - "value": "vectorBucketName" - } - ], - "name": "Omit", - "package": "typescript" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1290, - "name": "ListIndexesResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.listIndexes" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.listIndexes" - } - }, - { - "id": 656, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 657, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 658, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 659, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.setHeader" - } - }, - { - "id": 654, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 655, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorIndexApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [605] - }, - { - "title": "Methods", - "children": [622, 633, 628, 636, 625, 656, 654] - } - ], - "categories": [ - { - "title": "Other", - "children": [656, 654] - }, - { - "title": "Storage", - "children": [605, 622, 633, 628, 636, 625] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 256, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L256" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 672, - "name": "VectorIndexScope", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scoped client for operations within a specific vector index\nProvides vector data operations (put, get, list, query, delete)\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 673, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L465" - } - ], - "signatures": [ - { - "id": 674, - "name": "VectorIndexScope", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a helper that automatically scopes all vector operations to the provided bucket/index names.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@example", - "name": "Creating a vector index scope", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 465, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L465" - } - ], - "parameters": [ - { - "id": 675, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 676, - "name": "headers", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 677, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 467, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L467" - } - ], - "indexSignatures": [ - { - "id": 678, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 467, - "character": 15, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L467" - } - ], - "parameters": [ - { - "id": 679, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 680, - "name": "vectorBucketName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 681, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 682, - "name": "fetch", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 684, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 685, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 686, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 687, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 688, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 689, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 672, - "name": "VectorIndexScope", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.constructor" - } - }, - { - "id": 704, - "name": "deleteVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L635" - } - ], - "signatures": [ - { - "id": 705, - "name": "deleteVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Delete vectors by keys", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nawait index.deleteVectors({\n keys: ['doc-1', 'doc-2', 'doc-3']\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 635, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L635" - } - ], - "parameters": [ - { - "id": 706, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletion options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1307, - "name": "DeleteVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.deleteVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.deleteVectors" - } - }, - { - "id": 695, - "name": "getVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 536, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L536" - } - ], - "signatures": [ - { - "id": 696, - "name": "getVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing vectors array or error" - } - ] - }, - { - "tag": "@example", - "name": "Get vectors by keys", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.getVectors({\n keys: ['doc-1', 'doc-2'],\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 536, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L536" - } - ], - "parameters": [ - { - "id": 697, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector retrieval options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1295, - "name": "GetVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1301, - "name": "GetVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.getVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.getVectors" - } - }, - { - "id": 698, - "name": "listVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 567, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L567" - } - ], - "signatures": [ - { - "id": 699, - "name": "listVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists vectors in this index with pagination\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing vectors array and pagination token or error" - } - ] - }, - { - "tag": "@example", - "name": "List vectors with pagination", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.listVectors({\n maxResults: 500,\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 567, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L567" - } - ], - "parameters": [ - { - "id": 700, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listing options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1311, - "name": "ListVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1320, - "name": "ListVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.listVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.listVectors" - } - }, - { - "id": 692, - "name": "putVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 505, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L505" - } - ], - "signatures": [ - { - "id": 693, - "name": "putVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inserts or updates vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with empty response on success or error" - } - ] - }, - { - "tag": "@example", - "name": "Insert vectors into an index", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nawait index.putVectors({\n vectors: [\n {\n key: 'doc-1',\n data: { float32: [0.1, 0.2, ...] },\n metadata: { title: 'Introduction', page: 1 }\n }\n ]\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 505, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L505" - } - ], - "parameters": [ - { - "id": 694, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Vector insertion options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1303, - "name": "PutVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "intrinsic", - "name": "undefined" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.putVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.putVectors" - } - }, - { - "id": 701, - "name": "queryVectors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 603, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L603" - } - ], - "signatures": [ - { - "id": 702, - "name": "queryVectors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Queries for similar vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Storage" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Vector Buckets" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise with response containing matches array of similar vectors ordered by distance or error" - } - ] - }, - { - "tag": "@example", - "name": "Query similar vectors", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.queryVectors({\n queryVector: { float32: [0.1, 0.2, ...] },\n topK: 5,\n filter: { category: 'technical' },\n returnDistance: true,\n returnMetadata: true\n})\n```" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 603, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L603" - } - ], - "parameters": [ - { - "id": 703, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query options (bucket and index names automatically set)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1324, - "name": "QueryVectorsOptions", - "package": "@supabase/storage-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "vectorBucketName" - }, - { - "type": "literal", - "value": "indexName" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1344, - "typeArguments": [ - { - "type": "reference", - "target": 1332, - "name": "QueryVectorsResponse", - "package": "@supabase/storage-js" - } - ], - "name": "ApiResponse", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.queryVectors" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.queryVectors" - } - }, - { - "id": 724, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "signatures": [ - { - "id": 725, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 58, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58" - } - ], - "parameters": [ - { - "id": 726, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 727, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Header value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.setHeader" - } - }, - { - "id": 722, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "signatures": [ - { - "id": 723, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "this - For method chaining" - } - ] - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", - "line": 45, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45" - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "VectorDataApi.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [673] - }, - { - "title": "Methods", - "children": [704, 695, 698, 692, 701, 724, 722] - } - ], - "categories": [ - { - "title": "Other", - "children": [724, 722] - }, - { - "title": "Storage", - "children": [673, 704, 695, 698, 692, 701] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 446, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L446" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": -1, - "name": "default", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 536, - "name": "StorageVectorsClientOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for the Storage Vectors client\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 541, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation (optional)\nUseful for testing or custom request handling" - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 35, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L35" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 542, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 543, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 544, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 545, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 546, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 547, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 548, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 537, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers to include in all requests" - } - ], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 538, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "indexSignatures": [ - { - "id": 539, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 30, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" - } - ], - "parameters": [ - { - "id": 540, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [541, 537] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 26, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L26" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [549, 604, 672] - }, - { - "title": "Interfaces", - "children": [536] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L1" - } - ] - }, - { - "id": 740, - "name": "packages/StreamDownloadBuilder", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 741, - "name": "default", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 742, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L8" - } - ], - "signatures": [ - { - "id": 743, - "name": "default", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 8, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L8" - } - ], - "parameters": [ - { - "id": 744, - "name": "downloadFn", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 9, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L9" - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 9, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L9" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 747, - "name": "shouldThrowOnError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": 741, - "name": "StreamDownloadBuilder", - "package": "@supabase/storage-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 781, - "name": "[toStringTag]", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 5, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L5" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "'StreamDownloadBuilder'", - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.[toStringTag]" - } - }, - { - "id": 765, - "name": "catch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L22" - } - ], - "signatures": [ - { - "id": 766, - "name": "catch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback for only the rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 22, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L22" - } - ], - "typeParameters": [ - { - "id": 767, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 768, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 23, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L23" - } - ], - "signatures": [ - { - "id": 770, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 23, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L23" - } - ], - "parameters": [ - { - "id": 771, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - }, - { - "type": "reference", - "target": 767, - "name": "TResult", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.catch" - } - }, - { - "id": 772, - "name": "finally", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "signatures": [ - { - "id": 773, - "name": "finally", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\nresolved value cannot be modified from the callback." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "parameters": [ - { - "id": 774, - "name": "onfinally", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is settled (fulfilled or rejected)." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "signatures": [ - { - "id": 776, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 28, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.finally" - } - }, - { - "id": 753, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L13" - } - ], - "signatures": [ - { - "id": 754, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 13, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L13" - } - ], - "typeParameters": [ - { - "id": 755, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - }, - { - "id": 756, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 757, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 758, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 15, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L15" - } - ], - "signatures": [ - { - "id": 759, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 15, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L15" - } - ], - "parameters": [ - { - "id": 760, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 761, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 762, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 17, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L17" - } - ], - "signatures": [ - { - "id": 763, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 17, - "character": 18, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L17" - } - ], - "parameters": [ - { - "id": 764, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 755, - "name": "TResult1", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 756, - "name": "TResult2", - "package": "@supabase/storage-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "Promise.then" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [742] - }, - { - "title": "Properties", - "children": [781] - }, - { - "title": "Methods", - "children": [765, 772, 753] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 4, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L4" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1235, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "name": "ReadableStream", - "package": "typescript" - } - ], - "name": "DownloadResult", - "package": "@supabase/storage-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - ], - "groups": [ - { - "title": "Classes", - "children": [741] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L1" - } - ] - }, - { - "id": 782, - "name": "packages/VectorBucketApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorBucketApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorBucketApi.ts#L1" - } - ] - }, - { - "id": 846, - "name": "packages/VectorDataApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorDataApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorDataApi.ts#L1" - } - ] - }, - { - "id": 911, - "name": "packages/VectorIndexApi", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 912, - "name": "CreateIndexOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for creating a vector index\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." - } - ], - "modifierTags": ["@alpha"] - }, - "children": [ - { - "id": 915, - "name": "dataType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 25, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L25" - } - ], - "type": { - "type": "reference", - "target": 1252, - "name": "VectorDataType", - "package": "@supabase/storage-js" - } - }, - { - "id": 916, - "name": "dimension", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 26, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L26" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 917, - "name": "distanceMetric", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 27, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L27" - } - ], - "type": { - "type": "reference", - "target": 1254, - "name": "DistanceMetric", - "package": "@supabase/storage-js" - } - }, - { - "id": 914, - "name": "indexName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 24, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L24" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 918, - "name": "metadataConfiguration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 28, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L28" - } - ], - "type": { - "type": "reference", - "target": 1250, - "name": "MetadataConfiguration", - "package": "@supabase/storage-js" - } - }, - { - "id": 913, - "name": "vectorBucketName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@alpha"] - }, - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 23, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L23" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [915, 916, 917, 914, 918, 913] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 22, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L22" - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [912] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "children": [1, 2, 46, 135, 260, 535, 740, 782, 846, 911] - } - ], - "packageName": "@supabase/storage-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase Storage JS SDK

    \n\n

    JavaScript SDK to interact with Supabase Storage, including file storage and vector embeddings.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/storage-js)](https://www.npmjs.com/package/@supabase/storage-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/storage-js)](https://pkg.pr.new/~/supabase/storage-js)\n\n
    \n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Features\n\n- **File Storage**: Upload, download, list, move, and delete files\n- **Access Control**: Public and private buckets with fine-grained permissions\n- **Signed URLs**: Generate time-limited URLs for secure file access\n- **Image Transformations**: On-the-fly image resizing and optimization\n- **Vector Embeddings**: Store and query high-dimensional embeddings with similarity search\n- **Analytics Buckets**: Iceberg table-based buckets optimized for analytical queries and data processing\n\n## Quick Start Guide\n\n### Installing the module\n\n" - }, - { - "kind": "code", - "text": "```bash\nnpm install @supabase/storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Connecting to the storage backend\n\nThere are two ways to use the Storage SDK:\n\n#### Option 1: Via Supabase Client (Recommended)\n\nIf you're already using " - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": ", access storage through the client:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Use publishable key for frontend applications\nconst supabase = createClient('https://.supabase.co', '')\n\n// Access storage\nconst storage = supabase.storage\n\n// Access different bucket types\nconst regularBucket = storage.from('my-bucket')\nconst vectorBucket = storage.vectors.from('embeddings-bucket')\nconst analyticsBucket = storage.analytics // Analytics API\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 2: Standalone StorageClient\n\nFor backend applications or when you need to bypass Row Level Security:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { StorageClient } from '@supabase/storage-js'\n\nconst STORAGE_URL = 'https://.supabase.co/storage/v1'\nconst SERVICE_KEY = '' // Use secret key for backend operations\n\nconst storageClient = new StorageClient(STORAGE_URL, {\n apikey: SERVICE_KEY,\n Authorization: `Bearer ${SERVICE_KEY}`,\n})\n\n// Access different bucket types\nconst regularBucket = storageClient.from('my-bucket')\nconst vectorBucket = storageClient.vectors.from('embeddings-bucket')\nconst analyticsBucket = storageClient.analytics // Analytics API\n```" - }, - { - "kind": "text", - "text": "\n\n> **When to use each approach:**\n>\n> - Use " - }, - { - "kind": "code", - "text": "`supabase.storage`" - }, - { - "kind": "text", - "text": " when working with other Supabase features (auth, database, etc.) in frontend applications\n> - Use " - }, - { - "kind": "code", - "text": "`new StorageClient()`" - }, - { - "kind": "text", - "text": " for backend applications, Edge Functions, or when you need to bypass RLS policies\n\n> **Note:** Refer to the [Storage Access Control guide](https://supabase.com/docs/guides/storage/access-control) for detailed information on creating RLS policies.\n\n### Understanding Bucket Types\n\nSupabase Storage supports three types of buckets, each optimized for different use cases:\n\n#### 1. Regular Storage Buckets (File Storage)\n\nStandard buckets for storing files, images, videos, and other assets.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create regular storage bucket\nconst { data, error } = await storageClient.createBucket('my-files', {\n public: false,\n})\n\n// Upload files\nawait storageClient.from('my-files').upload('avatar.png', file)\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** User uploads, media assets, documents, backups\n\n#### 2. Vector Buckets (Embeddings Storage)\n\nSpecialized buckets for storing and querying high-dimensional vector embeddings.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create vector bucket\nawait storageClient.vectors.createBucket('embeddings-prod')\n\n// Create index and insert vectors\nconst bucket = storageClient.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents',\n dimension: 1536,\n distanceMetric: 'cosine',\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** Semantic search, AI-powered recommendations, similarity matching\n\n**[See full Vector Embeddings documentation below](#vector-embeddings)**\n\n#### 3. Analytics Buckets\n\nSpecialized buckets using Apache Iceberg table format, optimized for analytical queries and large-scale data processing.\n\n" - }, - { - "kind": "code", - "text": "```js\n// Create analytics bucket\nawait storageClient.analytics.createBucket('analytics-data')\n\n// List analytics buckets\nconst { data, error } = await storageClient.analytics.listBuckets()\n\n// Delete analytics bucket\nawait storageClient.analytics.deleteBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\n**Use cases:** Time-series data, analytical queries, data lakes, large-scale data processing, business intelligence\n\n**[See full Analytics Buckets documentation below](#analytics-buckets)**\n\n---\n\n### Handling resources\n\n#### Handling Storage Buckets\n\n- Create a new Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.createBucket(\n 'test_bucket', // Bucket name (must be unique)\n { public: false } // Bucket options\n )\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve the details of an existing Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.getBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Update a new Storage bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.updateBucket(\n 'test_bucket', // Bucket name\n { public: false } // Bucket options\n )\n ```" - }, - { - "kind": "text", - "text": "\n\n- Remove all objects inside a single bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.emptyBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Delete an existing bucket (a bucket can't be deleted with existing objects inside it):\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.deleteBucket('test_bucket')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve the details of all Storage buckets within an existing project:\n\n " - }, - { - "kind": "code", - "text": "```js\n // List all buckets\n const { data, error } = await storageClient.listBuckets()\n\n // List buckets with options (pagination, sorting, search)\n const { data, error } = await storageClient.listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod',\n })\n ```" - }, - { - "kind": "text", - "text": "\n\n#### Handling Files\n\n- Upload a file to an existing bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const fileBody = ... // load your file here\n\n const { data, error } = await storageClient.from('bucket').upload('path/to/file', fileBody)\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: \n > The path in " - }, - { - "kind": "code", - "text": "`data.Key`" - }, - { - "kind": "text", - "text": " is prefixed by the bucket ID and is not the value which should be passed to the " - }, - { - "kind": "code", - "text": "`download`" - }, - { - "kind": "text", - "text": " method in order to fetch the file. \n > To fetch the file via the " - }, - { - "kind": "code", - "text": "`download`" - }, - { - "kind": "text", - "text": " method, use " - }, - { - "kind": "code", - "text": "`data.path`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`data.bucketId`" - }, - { - "kind": "text", - "text": " as follows:\n >\n > " - }, - { - "kind": "code", - "text": "```javascript\n > const { data, error } = await storageClient.from('bucket').upload('/folder/file.txt', fileBody)\n > // check for errors\n > const { data2, error2 } = await storageClient.from(data.bucketId).download(data.path)\n > ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`upload`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).\n\n- Download a file from an exisiting bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').download('path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n- List all the files within a bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').list('folder')\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`list`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-list).\n\n- Replace an existing file at the specified path with a new one:\n\n " - }, - { - "kind": "code", - "text": "```js\n const fileBody = ... // load your file here\n\n const { data, error } = await storageClient\n .from('bucket')\n .update('path/to/file', fileBody)\n ```" - }, - { - "kind": "text", - "text": "\n\n > Note: The " - }, - { - "kind": "code", - "text": "`upload`" - }, - { - "kind": "text", - "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).\n\n- Move an existing file:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient\n .from('bucket')\n .move('old/path/to/file', 'new/path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n- Delete files within the same bucket:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('bucket').remove(['path/to/file'])\n ```" - }, - { - "kind": "text", - "text": "\n\n- Create signed URL to download file without requiring permissions:\n\n " - }, - { - "kind": "code", - "text": "```js\n const expireIn = 60\n\n const { data, error } = await storageClient\n .from('bucket')\n .createSignedUrl('path/to/file', expireIn)\n ```" - }, - { - "kind": "text", - "text": "\n\n- Retrieve URLs for assets in public buckets:\n\n " - }, - { - "kind": "code", - "text": "```js\n const { data, error } = await storageClient.from('public-bucket').getPublicUrl('path/to/file')\n ```" - }, - { - "kind": "text", - "text": "\n\n## Analytics Buckets\n\nSupabase Storage provides specialized analytics buckets using Apache Iceberg table format, optimized for analytical workloads and large-scale data processing. These buckets are designed for data lake architectures, time-series data, and business intelligence applications.\n\n### What are Analytics Buckets?\n\nAnalytics buckets use the Apache Iceberg open table format, providing:\n\n- **ACID transactions** for data consistency\n- **Schema evolution** without data rewrites\n- **Time travel** to query historical data\n- **Efficient metadata management** for large datasets\n- **Optimized for analytical queries** rather than individual file operations\n\n### When to Use Analytics Buckets\n\n**Use analytics buckets for:**\n\n- Time-series data (logs, metrics, events)\n- Data lake architectures\n- Business intelligence and reporting\n- Large-scale batch processing\n- Analytical workloads requiring ACID guarantees\n\n**Use regular storage buckets for:**\n\n- User file uploads (images, documents, videos)\n- Individual file management\n- Content delivery\n- Simple object storage needs\n\n### Quick Start\n\nYou can access analytics functionality through the " - }, - { - "kind": "code", - "text": "`analytics`" - }, - { - "kind": "text", - "text": " property on your storage client:\n\n#### Via Supabase Client\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')\n\n// Access analytics operations\nconst analytics = supabase.storage.analytics\n\n// Create an analytics bucket\nconst { data, error } = await analytics.createBucket('analytics-data')\nif (error) {\n console.error('Failed to create analytics bucket:', error.message)\n} else {\n console.log('Created bucket:', data.name)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Via StorageClient\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storageClient = new StorageClient('https://your-project.supabase.co/storage/v1', {\n apikey: 'YOUR_API_KEY',\n Authorization: 'Bearer YOUR_TOKEN',\n})\n\n// Access analytics operations\nconst analytics = storageClient.analytics\n\n// Create an analytics bucket\nawait analytics.createBucket('analytics-data')\n```" - }, - { - "kind": "text", - "text": "\n\n### API Reference\n\n#### Create Analytics Bucket\n\nCreates a new analytics bucket using Iceberg table format:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.createBucket('my-analytics-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n} else {\n console.log('Created bucket:', data)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: {\n id: string\n type: 'ANALYTICS'\n format: string\n created_at: string\n updated_at: string\n } | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### List Analytics Buckets\n\nRetrieves all analytics buckets in your project with optional filtering and pagination:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod',\n})\n\nif (data) {\n console.log(`Found ${data.length} analytics buckets`)\n data.forEach((bucket) => {\n console.log(`- ${bucket.id} (created: ${bucket.created_at})`)\n })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Parameters:**\n\n- " - }, - { - "kind": "code", - "text": "`limit?: number`" - }, - { - "kind": "text", - "text": " - Maximum number of buckets to return\n- " - }, - { - "kind": "code", - "text": "`offset?: number`" - }, - { - "kind": "text", - "text": " - Number of buckets to skip (for pagination)\n- " - }, - { - "kind": "code", - "text": "`sortColumn?: 'id' | 'name' | 'created_at' | 'updated_at'`" - }, - { - "kind": "text", - "text": " - Column to sort by\n- " - }, - { - "kind": "code", - "text": "`sortOrder?: 'asc' | 'desc'`" - }, - { - "kind": "text", - "text": " - Sort direction\n- " - }, - { - "kind": "code", - "text": "`search?: string`" - }, - { - "kind": "text", - "text": " - Search term to filter bucket names\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: AnalyticBucket[] | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Example with Pagination:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Fetch first page\nconst firstPage = await analytics.listBuckets({\n limit: 100,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n})\n\n// Fetch second page\nconst secondPage = await analytics.listBuckets({\n limit: 100,\n offset: 100,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Delete Analytics Bucket\n\nDeletes an analytics bucket. The bucket must be empty before deletion.\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.deleteBucket('old-analytics-bucket')\n\nif (error) {\n console.error('Failed to delete:', error.message)\n} else {\n console.log('Bucket deleted:', data.message)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:**\n\n" - }, - { - "kind": "code", - "text": "```typescript\n{\n data: { message: string } | null\n error: StorageError | null\n}\n```" - }, - { - "kind": "text", - "text": "\n\n> **Note:** A bucket cannot be deleted if it contains data. You must empty the bucket first.\n\n#### Get Iceberg Catalog for Advanced Operations\n\nFor advanced operations like creating tables, namespaces, and querying Iceberg metadata, use the " - }, - { - "kind": "code", - "text": "`from()`" - }, - { - "kind": "text", - "text": " method to get a configured [iceberg-js](https://github.com/supabase/iceberg-js) client:\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Get an Iceberg REST Catalog client for your analytics bucket\nconst catalog = analytics.from('analytics-data')\n\n// Create a namespace\nawait catalog.createNamespace({ namespace: ['default'] }, { properties: { owner: 'data-team' } })\n\n// Create a table with schema\nawait catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false },\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1],\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: [],\n },\n 'write-order': {\n 'order-id': 0,\n fields: [],\n },\n properties: {\n 'write.format.default': 'parquet',\n },\n }\n)\n\n// List tables in namespace\nconst tables = await catalog.listTables({ namespace: ['default'] })\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n\n// Load table metadata\nconst table = await catalog.loadTable({ namespace: ['default'], name: 'events' })\n\n// Update table properties\nawait catalog.updateTable(\n { namespace: ['default'], name: 'events' },\n { properties: { 'read.split.target-size': '134217728' } }\n)\n\n// Drop table\nawait catalog.dropTable({ namespace: ['default'], name: 'events' })\n\n// Drop namespace\nawait catalog.dropNamespace({ namespace: ['default'] })\n```" - }, - { - "kind": "text", - "text": "\n\n**Returns:** " - }, - { - "kind": "code", - "text": "`IcebergRestCatalog`" - }, - { - "kind": "text", - "text": " instance from [iceberg-js](https://github.com/supabase/iceberg-js)\n\n> **Note:** The " - }, - { - "kind": "code", - "text": "`from()`" - }, - { - "kind": "text", - "text": " method returns an Iceberg REST Catalog client that provides full access to the Apache Iceberg REST API. For complete documentation of available operations, see the [iceberg-js documentation](https://supabase.github.io/iceberg-js/).\n\n### Error Handling\n\nAnalytics buckets use the same error handling pattern as the rest of the Storage SDK:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await analytics.createBucket('my-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n console.error('Status:', error.status)\n console.error('Status Code:', error.statusCode)\n // Handle error appropriately\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Throwing Errors\n\nYou can configure the client to throw errors instead of returning them:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst analytics = storageClient.analytics\nanalytics.throwOnError()\n\ntry {\n const { data } = await analytics.createBucket('my-bucket')\n // data is guaranteed to be present\n console.log('Success:', data)\n} catch (error) {\n if (error instanceof StorageApiError) {\n console.error('API Error:', error.statusCode, error.message)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### TypeScript Types\n\nThe library exports TypeScript types for analytics buckets:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport type { AnalyticBucket, BucketType, StorageError } from '@supabase/storage-js'\n\n// AnalyticBucket type\ninterface AnalyticBucket {\n id: string\n type: 'ANALYTICS'\n format: string\n created_at: string\n updated_at: string\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### Common Patterns\n\n#### Checking if a Bucket Exists\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function bucketExists(bucketName: string): Promise {\n const { data, error } = await analytics.listBuckets({\n search: bucketName,\n })\n\n if (error) {\n console.error('Error checking bucket:', error.message)\n return false\n }\n\n return data?.some((bucket) => bucket.id === bucketName) ?? false\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Creating Bucket with Error Handling\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function ensureAnalyticsBucket(bucketName: string) {\n // Try to create the bucket\n const { data, error } = await analytics.createBucket(bucketName)\n\n if (error) {\n // Check if bucket already exists (conflict error)\n if (error.statusCode === '409') {\n console.log(`Bucket '${bucketName}' already exists`)\n return { success: true, created: false }\n }\n\n // Other error occurred\n console.error('Failed to create bucket:', error.message)\n return { success: false, error }\n }\n\n console.log(`Created new bucket: '${bucketName}'`)\n return { success: true, created: true, data }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Listing All Buckets with Pagination\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function getAllAnalyticsBuckets() {\n const allBuckets: AnalyticBucket[] = []\n let offset = 0\n const limit = 100\n\n while (true) {\n const { data, error } = await analytics.listBuckets({\n limit,\n offset,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n })\n\n if (error) {\n console.error('Error fetching buckets:', error.message)\n break\n }\n\n if (!data || data.length === 0) {\n break\n }\n\n allBuckets.push(...data)\n\n // If we got fewer results than the limit, we've reached the end\n if (data.length < limit) {\n break\n }\n\n offset += limit\n }\n\n return allBuckets\n}\n```" - }, - { - "kind": "text", - "text": "\n\n## Vector Embeddings\n\nSupabase Storage provides built-in support for storing and querying high-dimensional vector embeddings, powered by S3 Vectors. This enables semantic search, similarity matching, and AI-powered applications without needing a separate vector database.\n\n> **Note:** Vector embeddings functionality is available in " - }, - { - "kind": "code", - "text": "`@supabase/storage-js`" - }, - { - "kind": "text", - "text": " v2.76 and later.\n\n### Features\n\n- **Vector Buckets**: Organize vector indexes into logical containers\n- **Vector Indexes**: Define schemas with configurable dimensions and distance metrics\n- **Batch Operations**: Insert/update/delete up to 500 vectors per request\n- **Similarity Search**: Query for nearest neighbors using cosine, euclidean, or dot product distance\n- **Metadata Filtering**: Store and filter vectors by arbitrary JSON metadata\n- **Pagination**: Efficiently scan large vector datasets\n- **Parallel Scanning**: Distribute scans across multiple workers for high throughput\n- **Cross-platform**: Works in Node.js, browsers, and edge runtimes\n\n### Quick Start\n\nYou can access vector functionality in three ways, depending on your use case:\n\n#### Option 1: Via Supabase Client (Most Common)\n\nIf you're using the full Supabase client:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')\n\n// Access vector operations through storage\nconst vectors = supabase.storage.vectors\n\n// Create a vector bucket\nawait vectors.createBucket('embeddings-prod')\n\n// Create an index\nconst bucket = vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents-openai',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine',\n})\n\n// Insert vectors\nconst index = bucket.index('documents-openai')\nawait index.putVectors({\n vectors: [\n {\n key: 'doc-1',\n data: { float32: [0.1, 0.2, 0.3 /* ...1536 dimensions */] },\n metadata: { title: 'Introduction', category: 'docs' },\n },\n ],\n})\n\n// Query similar vectors\nconst { data, error } = await index.queryVectors({\n queryVector: { float32: [0.15, 0.25, 0.35 /* ...1536 dimensions */] },\n topK: 5,\n returnDistance: true,\n returnMetadata: true,\n})\n\nif (data) {\n data.matches.forEach((match) => {\n console.log(`${match.key}: distance=${match.distance}`)\n console.log('Metadata:', match.metadata)\n })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 2: Via StorageClient\n\nIf you're using the standalone " - }, - { - "kind": "code", - "text": "`StorageClient`" - }, - { - "kind": "text", - "text": " for storage operations, access vectors through the " - }, - { - "kind": "code", - "text": "`vectors`" - }, - { - "kind": "text", - "text": " property:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storageClient = new StorageClient('https://your-project.supabase.co/storage/v1', {\n apikey: 'YOUR_API_KEY',\n Authorization: 'Bearer YOUR_TOKEN',\n})\n\n// Access vector operations\nconst vectors = storageClient.vectors\n\n// Use the same API as shown in Option 1\nawait vectors.createBucket('embeddings-prod')\nconst bucket = vectors.from('embeddings-prod')\n// ... rest of operations\n```" - }, - { - "kind": "text", - "text": "\n\n#### Option 3: Standalone Vector Client\n\nFor vector-only applications that don't need regular file storage operations:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\n// Initialize standalone vector client\nconst vectorClient = new StorageVectorsClient('https://your-project.supabase.co/storage/v1', {\n headers: { Authorization: 'Bearer YOUR_TOKEN' },\n})\n\n// Use the same API as shown in Option 1\nawait vectorClient.createBucket('embeddings-prod')\nconst bucket = vectorClient.from('embeddings-prod')\n// ... rest of operations\n```" - }, - { - "kind": "text", - "text": "\n\n> **When to use each approach:**\n>\n> - **Option 1**: When using other Supabase features (auth, database, realtime)\n> - **Option 2**: When working with both file storage and vectors\n> - **Option 3**: For dedicated vector-only applications without file storage\n\n### API Reference\n\n#### Client Initialization\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst vectorClient = new StorageVectorsClient(url, options?)\n```" - }, - { - "kind": "text", - "text": "\n\n**Options:**\n\n- " - }, - { - "kind": "code", - "text": "`headers?: Record`" - }, - { - "kind": "text", - "text": " - Custom HTTP headers (e.g., Authorization)\n- " - }, - { - "kind": "code", - "text": "`fetch?: Fetch`" - }, - { - "kind": "text", - "text": " - Custom fetch implementation\n\n#### Vector Buckets\n\nVector buckets are top-level containers for organizing vector indexes.\n\n##### Create Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.createBucket('my-bucket')\n```" - }, - { - "kind": "text", - "text": "\n\n##### Get Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.getBucket('my-bucket')\nconsole.log('Created at:', new Date(data.vectorBucket.creationTime! * 1000))\n```" - }, - { - "kind": "text", - "text": "\n\n##### List Buckets\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.listBuckets({\n prefix: 'prod-',\n maxResults: 100,\n})\n\n// Pagination\nif (data?.nextToken) {\n const next = await vectorClient.listBuckets({ nextToken: data.nextToken })\n}\n```" - }, - { - "kind": "text", - "text": "\n\n##### Delete Bucket\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Bucket must be empty (all indexes deleted first)\nconst { error } = await vectorClient.deleteBucket('my-bucket')\n```" - }, - { - "kind": "text", - "text": "\n\n#### Vector Indexes\n\nVector indexes define the schema for embeddings including dimension and distance metric.\n\n##### Create Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst bucket = vectorClient.from('my-bucket')\n\nawait bucket.createIndex({\n indexName: 'my-index',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine', // 'cosine' | 'euclidean' | 'dotproduct'\n metadataConfiguration: {\n nonFilterableMetadataKeys: ['raw_text', 'internal_id'],\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Distance Metrics:**\n\n- " - }, - { - "kind": "code", - "text": "`cosine`" - }, - { - "kind": "text", - "text": " - Cosine similarity (normalized dot product)\n- " - }, - { - "kind": "code", - "text": "`euclidean`" - }, - { - "kind": "text", - "text": " - Euclidean distance (L2 norm)\n- " - }, - { - "kind": "code", - "text": "`dotproduct`" - }, - { - "kind": "text", - "text": " - Dot product similarity\n\n##### Get Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await bucket.getIndex('my-index')\nconsole.log('Dimension:', data?.index.dimension)\nconsole.log('Distance metric:', data?.index.distanceMetric)\n```" - }, - { - "kind": "text", - "text": "\n\n##### List Indexes\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await bucket.listIndexes({\n prefix: 'documents-',\n maxResults: 100,\n})\n```" - }, - { - "kind": "text", - "text": "\n\n##### Delete Index\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Deletes index and all its vectors\nawait bucket.deleteIndex('my-index')\n```" - }, - { - "kind": "text", - "text": "\n\n#### Vector Operations\n\n##### Insert/Update Vectors (Upsert)\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst index = vectorClient.from('my-bucket').index('my-index')\n\nawait index.putVectors({\n vectors: [\n {\n key: 'unique-id-1',\n data: {\n float32: [\n /* 1536 numbers */\n ],\n },\n metadata: {\n title: 'Document Title',\n category: 'technical',\n page: 1,\n },\n },\n // ... up to 500 vectors per request\n ],\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Limitations:**\n\n- 1-500 vectors per request\n- Vectors must match index dimension\n- Keys must be unique within index\n\n##### Get Vectors by Key\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await index.getVectors({\n keys: ['doc-1', 'doc-2', 'doc-3'],\n returnData: true, // Include embeddings\n returnMetadata: true, // Include metadata\n})\n\ndata?.vectors.forEach((v) => {\n console.log(v.key, v.metadata)\n})\n```" - }, - { - "kind": "text", - "text": "\n\n##### Query Similar Vectors (ANN Search)\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await index.queryVectors({\n queryVector: {\n float32: [\n /* 1536 numbers */\n ],\n },\n topK: 10,\n filter: {\n category: 'technical',\n published: true,\n },\n returnDistance: true,\n returnMetadata: true,\n})\n\n// Results ordered by similarity\ndata?.matches.forEach((match) => {\n console.log(`${match.key}: distance=${match.distance}`)\n})\n```" - }, - { - "kind": "text", - "text": "\n\n**Filter Syntax:**\nThe " - }, - { - "kind": "code", - "text": "`filter`" - }, - { - "kind": "text", - "text": " parameter accepts arbitrary JSON for metadata filtering. Non-filterable keys (configured at index creation) cannot be used in filters but can still be returned.\n\n##### List/Scan Vectors\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Simple pagination\nlet nextToken: string | undefined\ndo {\n const { data } = await index.listVectors({\n maxResults: 500,\n nextToken,\n returnMetadata: true,\n })\n\n console.log('Batch:', data?.vectors.length)\n nextToken = data?.nextToken\n} while (nextToken)\n\n// Parallel scanning (4 workers)\nconst workers = [0, 1, 2, 3].map(async (segmentIndex) => {\n const { data } = await index.listVectors({\n segmentCount: 4,\n segmentIndex,\n returnMetadata: true,\n })\n return data?.vectors || []\n})\n\nconst results = await Promise.all(workers)\nconst allVectors = results.flat()\n```" - }, - { - "kind": "text", - "text": "\n\n**Limitations:**\n\n- " - }, - { - "kind": "code", - "text": "`maxResults`" - }, - { - "kind": "text", - "text": ": 1-1000 (default: 500)\n- " - }, - { - "kind": "code", - "text": "`segmentCount`" - }, - { - "kind": "text", - "text": ": 1-16\n- Response may be limited by 1MB size\n\n##### Delete Vectors\n\n" - }, - { - "kind": "code", - "text": "```typescript\nawait index.deleteVectors({\n keys: ['doc-1', 'doc-2', 'doc-3'],\n // ... up to 500 keys per request\n})\n```" - }, - { - "kind": "text", - "text": "\n\n### Error Handling\n\nThe library uses a consistent error handling pattern:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await vectorClient.createBucket('my-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n console.error('Status:', error.status)\n console.error('Code:', error.statusCode)\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Error Codes\n\n| Code | HTTP | Description |\n| ---------------------------- | ---- | ----------------------- |\n| " - }, - { - "kind": "code", - "text": "`InternalError`" - }, - { - "kind": "text", - "text": " | 500 | Internal server error |\n| " - }, - { - "kind": "code", - "text": "`S3VectorConflictException`" - }, - { - "kind": "text", - "text": " | 409 | Resource already exists |\n| " - }, - { - "kind": "code", - "text": "`S3VectorNotFoundException`" - }, - { - "kind": "text", - "text": " | 404 | Resource not found |\n| " - }, - { - "kind": "code", - "text": "`S3VectorBucketNotEmpty`" - }, - { - "kind": "text", - "text": " | 400 | Bucket contains indexes |\n| " - }, - { - "kind": "code", - "text": "`S3VectorMaxBucketsExceeded`" - }, - { - "kind": "text", - "text": " | 400 | Bucket quota exceeded |\n| " - }, - { - "kind": "code", - "text": "`S3VectorMaxIndexesExceeded`" - }, - { - "kind": "text", - "text": " | 400 | Index quota exceeded |\n\n#### Throwing Errors\n\nYou can configure the client to throw errors instead:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nconst vectorClient = new StorageVectorsClient(url, options)\nvectorClient.throwOnError()\n\ntry {\n const { data } = await vectorClient.createBucket('my-bucket')\n // data is guaranteed to be present\n} catch (error) {\n if (error instanceof StorageVectorsApiError) {\n console.error('API Error:', error.statusCode)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n### Advanced Usage\n\n#### Scoped Clients\n\nCreate scoped clients for cleaner code:\n\n" - }, - { - "kind": "code", - "text": "```typescript\n// Bucket-scoped operations\nconst bucket = vectorClient.from('embeddings-prod')\nawait bucket.createIndex({\n /* ... */\n})\nawait bucket.listIndexes()\n\n// Index-scoped operations\nconst index = bucket.index('documents-openai')\nawait index.putVectors({\n /* ... */\n})\nawait index.queryVectors({\n /* ... */\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Custom Fetch\n\nProvide a custom fetch implementation:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\nconst vectorClient = new StorageVectorsClient(url, {\n fetch: customFetch,\n headers: {\n /* ... */\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n#### Batch Processing\n\nProcess large datasets in batches:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nasync function insertLargeDataset(vectors: VectorObject[]) {\n const batchSize = 500\n\n for (let i = 0; i < vectors.length; i += batchSize) {\n const batch = vectors.slice(i, i + batchSize)\n await index.putVectors({ vectors: batch })\n console.log(`Inserted ${i + batch.length}/${vectors.length}`)\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n#### Float32 Validation\n\nEnsure vectors are properly normalized to float32:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { normalizeToFloat32 } from '@supabase/storage-js'\n\nconst vector = normalizeToFloat32([0.1, 0.2, 0.3 /* ... */])\n```" - }, - { - "kind": "text", - "text": "\n\n### Type Definitions\n\nThe library exports comprehensive TypeScript types:\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport type {\n VectorBucket,\n VectorIndex,\n VectorData,\n VectorObject,\n VectorMatch,\n VectorMetadata,\n DistanceMetric,\n ApiResponse,\n StorageVectorsError,\n} from '@supabase/storage-js'\n```" - }, - { - "kind": "text", - "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n#### Build Scripts Overview\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Build the package\npnpm nx build storage-js\n\n# Watch mode for development\npnpm nx build storage-js --watch\n\n# Generate documentation\npnpm nx docs storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\n**Important:** The storage-js tests require a local Supabase stack running via the Supabase CLI. Docker must be running since the Supabase CLI uses it internally.\n\n#### Prerequisites\n\n1. **Docker** must be installed and running (used by Supabase CLI internally)\n2. **Supabase CLI** — installed automatically via " - }, - { - "kind": "code", - "text": "`pnpm exec supabase`" - }, - { - "kind": "text", - "text": "\n\n#### Test Scripts Overview\n\n| Script | Description | What it does |\n| ----------------- | --------------------------------- | ----------------------------------------------------------------- |\n| " - }, - { - "kind": "code", - "text": "`test:storage`" - }, - { - "kind": "text", - "text": " | **Complete test workflow** | Runs the full test cycle: clean → start infra → run tests → clean |\n| " - }, - { - "kind": "code", - "text": "`test:suite`" - }, - { - "kind": "text", - "text": " | **Jest tests only** | Runs Jest tests with coverage (requires infra to be running) |\n| " - }, - { - "kind": "code", - "text": "`test:infra`" - }, - { - "kind": "text", - "text": " | **Start test infrastructure** | Starts Supabase CLI stack (PostgreSQL, Storage API, Kong, etc.) |\n| " - }, - { - "kind": "code", - "text": "`test:clean-post`" - }, - { - "kind": "text", - "text": " | **Stop and clean infrastructure** | Stops the Supabase CLI stack |\n\n#### Running Tests\n\n##### Option 1: Complete Test Run (Recommended)\n\nThis handles everything automatically - starting infrastructure, running tests, and cleaning up:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From monorepo root\npnpm nx test:storage storage-js\n```" - }, - { - "kind": "text", - "text": "\n\nThis command will:\n\n1. Stop any existing test containers\n2. Build and start fresh test infrastructure\n3. Wait for services to be ready\n4. Run all Jest tests with coverage\n5. Clean up all containers after tests complete\n\n##### Option 2: Manual Infrastructure Management\n\nUseful for development when you want to run tests multiple times without restarting Docker:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Step 1: Start the test infrastructure\n# From root\npnpm nx test:infra storage-js\n# This starts: PostgreSQL, Storage API, Kong Gateway, and imgproxy\n\n# Step 2: Run tests (can run multiple times)\npnpm nx test:suite storage-js\n\n# Step 3: When done, clean up the infrastructure\npnpm nx test:clean-post storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n##### Option 3: Development Mode\n\nFor actively developing and debugging tests:\n\n" - }, - { - "kind": "code", - "text": "```bash\n# Start infrastructure once (from root)\npnpm nx test:infra storage-js\n\n# Run tests in watch mode\npnpm nx test:suite storage-js --watch\n\n# Clean up when done\npnpm nx test:clean-post storage-js\n```" - }, - { - "kind": "text", - "text": "\n\n#### Test Infrastructure Details\n\nThe test infrastructure is managed via the Supabase CLI (" - }, - { - "kind": "code", - "text": "`pnpm exec supabase start --workdir test`" - }, - { - "kind": "text", - "text": "), which starts a local Supabase stack defined by the config in " - }, - { - "kind": "code", - "text": "`test/`" - }, - { - "kind": "text", - "text": ". This includes PostgreSQL, the Storage API, Kong Gateway, and supporting services.\n\n#### Common Issues and Solutions\n\n| Issue | Solution |\n| --------------------------------- | ------------------------------------------------------------------------------------------------- |\n| Port conflicts | Another service is using a required port. Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:clean-post storage-js`" - }, - { - "kind": "text", - "text": " then try again |\n| \"request failed, reason:\" errors | Infrastructure isn't running. Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:infra storage-js`" - }, - { - "kind": "text", - "text": " first |\n| Tests fail with connection errors | Ensure Docker is running (Supabase CLI requires Docker) |\n| Stack already running | Run " - }, - { - "kind": "code", - "text": "`pnpm nx test:clean-post storage-js`" - }, - { - "kind": "text", - "text": " to stop it before restarting |\n\n#### Understanding Test Failures\n\n- **StorageUnknownError with \"request failed\"**: Infrastructure not running\n- **Snapshot failures**: Expected test data has changed — review and update snapshots if needed\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 11 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." - } - ], - "symbolIdMap": { - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "2": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "" - }, - "3": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default" - }, - "4": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "5": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default" - }, - "6": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "downloadFn" - }, - "7": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "8": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "9": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "shouldThrowOnError" - }, - "15": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.asStream" - }, - "16": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.asStream" - }, - "17": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "18": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "19": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult1" - }, - "20": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult2" - }, - "21": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "22": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "23": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "24": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "value" - }, - "25": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "26": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "27": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "28": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "29": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "30": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "31": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "TResult" - }, - "32": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "33": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "34": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "35": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "36": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "37": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "38": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "onfinally" - }, - "39": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "40": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "45": { - "sourceFileName": "src/packages/BlobDownloadBuilder.ts", - "qualifiedName": "default.[toStringTag]" - }, - "46": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "" - }, - "47": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "WrappedIcebergRestCatalog" - }, - "48": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default" - }, - "49": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.__constructor" - }, - "50": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default" - }, - "51": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "url" - }, - "52": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "headers" - }, - "53": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "54": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.__index" - }, - "56": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "fetch" - }, - "57": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "58": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "59": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "60": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "61": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "62": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "63": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "64": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.createBucket" - }, - "65": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.createBucket" - }, - "66": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "name" - }, - "67": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "68": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "69": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "70": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "71": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "72": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "73": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.listBuckets" - }, - "74": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.listBuckets" - }, - "75": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "options" - }, - "76": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "77": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.limit" - }, - "78": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.offset" - }, - "79": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.sortColumn" - }, - "80": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.sortOrder" - }, - "81": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.search" - }, - "82": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "83": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "84": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "85": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "86": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "87": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "88": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.deleteBucket" - }, - "89": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.deleteBucket" - }, - "90": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "bucketName" - }, - "91": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "92": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "93": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "94": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.message" - }, - "95": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "96": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type" - }, - "97": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.data" - }, - "98": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "__type.error" - }, - "99": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.from" - }, - "100": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "default.from" - }, - "101": { - "sourceFileName": "src/packages/StorageAnalyticsClient.ts", - "qualifiedName": "bucketName" - }, - "117": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "118": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "119": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "120": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "121": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "122": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "135": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "" - }, - "136": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default" - }, - "137": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.__constructor" - }, - "138": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default" - }, - "139": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "url" - }, - "140": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "headers" - }, - "141": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "142": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.__index" - }, - "144": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "fetch" - }, - "145": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "146": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "147": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "148": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "149": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "150": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "151": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "152": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "opts" - }, - "153": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "154": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "155": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "156": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "157": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "158": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "159": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "160": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "161": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "162": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "163": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "164": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "165": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "166": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "167": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "168": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "169": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "170": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "171": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "172": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "173": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "174": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "175": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "176": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "177": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "178": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "179": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.type" - }, - "180": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "181": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "182": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "183": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "184": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "185": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "186": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "187": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "188": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "189": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "190": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "191": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "192": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "193": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "194": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "195": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "196": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "197": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "198": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "199": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "200": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "201": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "202": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "203": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "204": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "205": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "206": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "207": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "208": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "209": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "210": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "211": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "212": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "213": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "214": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "215": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "216": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "217": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "218": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "219": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "220": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "221": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "222": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "223": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "242": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "243": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "244": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "245": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "246": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "247": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "260": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "" - }, - "261": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default" - }, - "262": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.__constructor" - }, - "263": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default" - }, - "264": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "url" - }, - "265": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "headers" - }, - "266": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "267": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.__index" - }, - "269": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "bucketId" - }, - "270": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fetch" - }, - "271": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "272": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "273": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "274": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "275": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "276": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "277": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "295": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.upload" - }, - "296": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.upload" - }, - "297": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "298": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "299": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "300": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "301": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "302": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "303": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.id" - }, - "304": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "305": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.fullPath" - }, - "306": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "307": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "308": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "309": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "310": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.uploadToSignedUrl" - }, - "311": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.uploadToSignedUrl" - }, - "312": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "313": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "token" - }, - "314": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "315": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "316": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type" - }, - "317": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.data" - }, - "318": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.error" - }, - "319": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type" - }, - "320": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.data" - }, - "321": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object" - }, - "322": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object.path" - }, - "323": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__object.fullPath" - }, - "324": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "__type.error" - }, - "325": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUploadUrl" - }, - "326": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUploadUrl" - }, - "327": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "328": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "329": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "330": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.upsert" - }, - "331": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "332": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "333": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "334": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "335": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.token" - }, - "336": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "337": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "338": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "339": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "340": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "341": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.update" - }, - "342": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.update" - }, - "343": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "344": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileBody" - }, - "345": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fileOptions" - }, - "346": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "347": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "348": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "349": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.id" - }, - "350": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "351": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.fullPath" - }, - "352": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "353": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "354": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "355": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "356": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.move" - }, - "357": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.move" - }, - "358": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fromPath" - }, - "359": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "toPath" - }, - "360": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "361": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "362": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "363": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "364": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.message" - }, - "365": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "366": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "367": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "368": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "369": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.copy" - }, - "370": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.copy" - }, - "371": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "fromPath" - }, - "372": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "toPath" - }, - "373": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "374": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "375": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "376": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "377": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "378": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "379": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "380": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "381": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "382": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrl" - }, - "383": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrl" - }, - "384": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "385": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "expiresIn" - }, - "386": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "387": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "388": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "389": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "390": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "391": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "392": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "393": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "394": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "395": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "396": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "397": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "398": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "399": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrls" - }, - "400": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.createSignedUrls" - }, - "401": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "paths" - }, - "402": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "expiresIn" - }, - "403": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "404": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "405": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "406": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "407": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "408": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "409": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "410": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "411": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.path" - }, - "412": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.signedUrl" - }, - "413": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "414": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "415": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "416": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "417": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.download" - }, - "418": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.download" - }, - "419": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "Options" - }, - "420": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "421": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "422": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "423": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "424": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "425": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "426": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.info" - }, - "427": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.info" - }, - "428": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "429": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "430": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "431": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "432": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "433": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "434": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "435": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.exists" - }, - "436": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.exists" - }, - "437": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "438": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "439": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "440": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "441": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "442": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "443": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "444": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.getPublicUrl" - }, - "445": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.getPublicUrl" - }, - "446": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "447": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "448": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "449": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.download" - }, - "450": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.transform" - }, - "451": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.cacheNonce" - }, - "452": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "454": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "455": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.publicUrl" - }, - "456": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.remove" - }, - "457": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.remove" - }, - "458": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "paths" - }, - "459": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "460": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "461": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "462": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "463": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "464": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "465": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.list" - }, - "466": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.list" - }, - "467": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "path" - }, - "468": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "469": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "470": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "471": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "472": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "473": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "474": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "475": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "476": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.listV2" - }, - "477": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.listV2" - }, - "478": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "options" - }, - "479": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "parameters" - }, - "480": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "481": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "482": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "483": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type" - }, - "484": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.data" - }, - "485": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "__type.error" - }, - "489": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.toBase64" - }, - "490": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "default.toBase64" - }, - "491": { - "sourceFileName": "src/packages/StorageFileApi.ts", - "qualifiedName": "data" - }, - "517": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "518": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "519": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "520": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "521": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "522": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "535": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "" - }, - "536": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions" - }, - "537": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions.headers" - }, - "538": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "539": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "541": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClientOptions.fetch" - }, - "542": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "543": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "544": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "545": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "546": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "547": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "548": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "549": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient" - }, - "550": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.__constructor" - }, - "551": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient" - }, - "552": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "553": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "554": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.from" - }, - "555": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.from" - }, - "556": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "557": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.createBucket" - }, - "558": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.createBucket" - }, - "559": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "560": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.getBucket" - }, - "561": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.getBucket" - }, - "562": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "563": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "564": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.vectorBucket" - }, - "565": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.listBuckets" - }, - "566": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.listBuckets" - }, - "567": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "568": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.deleteBucket" - }, - "569": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "StorageVectorsClient.deleteBucket" - }, - "570": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "586": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "587": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "588": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "589": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "590": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "591": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "604": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope" - }, - "605": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.__constructor" - }, - "606": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope" - }, - "607": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "608": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "headers" - }, - "609": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "610": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "612": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "613": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "fetch" - }, - "614": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "615": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "616": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "617": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "618": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "619": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "620": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "622": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.createIndex" - }, - "623": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.createIndex" - }, - "624": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "625": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.listIndexes" - }, - "626": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.listIndexes" - }, - "627": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "628": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.getIndex" - }, - "629": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.getIndex" - }, - "630": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "631": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "__type" - }, - "632": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "__type.index" - }, - "633": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.deleteIndex" - }, - "634": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.deleteIndex" - }, - "635": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "636": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.index" - }, - "637": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorBucketScope.index" - }, - "638": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "654": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "655": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "656": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "657": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "658": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "659": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "672": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope" - }, - "673": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.__constructor" - }, - "674": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope" - }, - "675": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "url" - }, - "676": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "headers" - }, - "677": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type" - }, - "678": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "__type.__index" - }, - "680": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "vectorBucketName" - }, - "681": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "indexName" - }, - "682": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "fetch" - }, - "683": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "684": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "685": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "686": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "687": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "688": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "689": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "692": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.putVectors" - }, - "693": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.putVectors" - }, - "694": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "695": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.getVectors" - }, - "696": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.getVectors" - }, - "697": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "698": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.listVectors" - }, - "699": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.listVectors" - }, - "700": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "701": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.queryVectors" - }, - "702": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.queryVectors" - }, - "703": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "704": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.deleteVectors" - }, - "705": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "VectorIndexScope.deleteVectors" - }, - "706": { - "sourceFileName": "src/packages/StorageVectorsClient.ts", - "qualifiedName": "options" - }, - "722": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "723": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "724": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "725": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "726": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "727": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "740": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "" - }, - "741": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default" - }, - "742": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.__constructor" - }, - "743": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default" - }, - "744": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "downloadFn" - }, - "745": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "746": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "747": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "shouldThrowOnError" - }, - "753": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "754": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.then" - }, - "755": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult1" - }, - "756": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult2" - }, - "757": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onfulfilled" - }, - "758": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "759": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "760": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "value" - }, - "761": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "762": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "763": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "764": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "765": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "766": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.catch" - }, - "767": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "TResult" - }, - "768": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onrejected" - }, - "769": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "770": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "771": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "reason" - }, - "772": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "773": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.finally" - }, - "774": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "onfinally" - }, - "775": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "776": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "__type" - }, - "781": { - "sourceFileName": "src/packages/StreamDownloadBuilder.ts", - "qualifiedName": "default.[toStringTag]" - }, - "782": { - "sourceFileName": "src/packages/VectorBucketApi.ts", - "qualifiedName": "" - }, - "846": { - "sourceFileName": "src/packages/VectorDataApi.ts", - "qualifiedName": "" - }, - "911": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "" - }, - "912": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions" - }, - "913": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.vectorBucketName" - }, - "914": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.indexName" - }, - "915": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.dataType" - }, - "916": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.dimension" - }, - "917": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.distanceMetric" - }, - "918": { - "sourceFileName": "src/packages/VectorIndexApi.ts", - "qualifiedName": "CreateIndexOptions.metadataConfiguration" - }, - "984": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient" - }, - "985": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.__constructor" - }, - "986": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient" - }, - "987": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "url" - }, - "988": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "headers" - }, - "989": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "__type" - }, - "990": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "__type.__index" - }, - "992": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "fetch" - }, - "993": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "994": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "995": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "996": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "997": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "998": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "999": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1000": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "opts" - }, - "1001": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.from" - }, - "1002": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.from" - }, - "1003": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "id" - }, - "1004": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.vectors" - }, - "1005": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.vectors" - }, - "1006": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.analytics" - }, - "1007": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClient.analytics" - }, - "1008": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "1009": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.listBuckets" - }, - "1010": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1011": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1012": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1013": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1014": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1015": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1016": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1017": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "1018": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.getBucket" - }, - "1019": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1020": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1021": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1022": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1023": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1024": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1025": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1026": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "1027": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.createBucket" - }, - "1028": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1029": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1030": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1031": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "1032": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "1033": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "1034": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.type" - }, - "1035": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1036": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1037": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1038": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1039": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1040": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1041": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "1042": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.updateBucket" - }, - "1043": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1044": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "options" - }, - "1045": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1046": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.public" - }, - "1047": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.fileSizeLimit" - }, - "1048": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.allowedMimeTypes" - }, - "1049": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1050": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1051": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1052": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1053": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1054": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1055": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1056": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1057": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "1058": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.emptyBucket" - }, - "1059": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1060": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1061": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1062": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1063": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1064": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1065": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1066": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1067": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1068": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "1069": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "default.deleteBucket" - }, - "1070": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "id" - }, - "1071": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1072": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1073": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1074": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.message" - }, - "1075": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1076": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type" - }, - "1077": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.data" - }, - "1078": { - "sourceFileName": "src/packages/StorageBucketApi.ts", - "qualifiedName": "__type.error" - }, - "1094": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1095": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1096": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "1097": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "default.setHeader" - }, - "1098": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "name" - }, - "1099": { - "sourceFileName": "src/lib/common/BaseApiClient.ts", - "qualifiedName": "value" - }, - "1112": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClientOptions" - }, - "1113": { - "sourceFileName": "src/StorageClient.ts", - "qualifiedName": "StorageClientOptions.useNewHostname" - }, - "1114": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageAnalyticsClient" - }, - "1115": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageVectorsClient" - }, - "1116": { - "sourceFileName": "src/index.ts", - "qualifiedName": "VectorBucketScope" - }, - "1117": { - "sourceFileName": "src/index.ts", - "qualifiedName": "VectorIndexScope" - }, - "1118": { - "sourceFileName": "src/index.ts", - "qualifiedName": "StorageVectorsClientOptions" - }, - "1122": { - "sourceFileName": "src/index.ts", - "qualifiedName": "CreateIndexOptions" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "BucketType" - }, - "1124": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1125": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket" - }, - "1126": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.id" - }, - "1127": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.type" - }, - "1128": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.name" - }, - "1129": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.owner" - }, - "1130": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.file_size_limit" - }, - "1131": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.allowed_mime_types" - }, - "1132": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.created_at" - }, - "1133": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.updated_at" - }, - "1134": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Bucket.public" - }, - "1135": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions" - }, - "1136": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.limit" - }, - "1137": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.offset" - }, - "1138": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.sortColumn" - }, - "1139": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.sortOrder" - }, - "1140": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListBucketOptions.search" - }, - "1141": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket" - }, - "1142": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.name" - }, - "1143": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.type" - }, - "1144": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.format" - }, - "1145": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.created_at" - }, - "1146": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "AnalyticBucket.updated_at" - }, - "1147": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata" - }, - "1148": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.eTag" - }, - "1149": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.size" - }, - "1150": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.mimetype" - }, - "1151": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.cacheControl" - }, - "1152": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.lastModified" - }, - "1153": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.contentLength" - }, - "1154": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.httpStatusCode" - }, - "1155": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileMetadata.__index" - }, - "1157": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject" - }, - "1158": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.name" - }, - "1159": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.id" - }, - "1160": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.updated_at" - }, - "1161": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.created_at" - }, - "1162": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.last_accessed_at" - }, - "1163": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.metadata" - }, - "1164": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.bucket_id" - }, - "1165": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.owner" - }, - "1166": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObject.buckets" - }, - "1167": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2" - }, - "1168": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.id" - }, - "1169": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.version" - }, - "1170": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.name" - }, - "1171": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.bucket_id" - }, - "1172": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.created_at" - }, - "1173": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.size" - }, - "1174": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.cache_control" - }, - "1175": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.content_type" - }, - "1176": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.etag" - }, - "1177": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.last_modified" - }, - "1178": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.metadata" - }, - "1179": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileObjectV2.updated_at" - }, - "1180": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy" - }, - "1181": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy.column" - }, - "1182": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortBy.order" - }, - "1183": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions" - }, - "1184": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.cacheControl" - }, - "1185": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.contentType" - }, - "1186": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.upsert" - }, - "1187": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.duplex" - }, - "1188": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.metadata" - }, - "1189": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FileOptions.headers" - }, - "1190": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DestinationOptions" - }, - "1191": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DestinationOptions.destinationBucket" - }, - "1192": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions" - }, - "1193": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.limit" - }, - "1194": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.offset" - }, - "1195": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.sortBy" - }, - "1196": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchOptions.search" - }, - "1197": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2" - }, - "1198": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2.column" - }, - "1199": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SortByV2.order" - }, - "1200": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options" - }, - "1201": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.limit" - }, - "1202": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.prefix" - }, - "1203": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.cursor" - }, - "1204": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.with_delimiter" - }, - "1205": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Options.sortBy" - }, - "1206": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object" - }, - "1207": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.name" - }, - "1208": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.key" - }, - "1209": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.id" - }, - "1210": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.updated_at" - }, - "1211": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.created_at" - }, - "1212": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.metadata" - }, - "1213": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Object.last_accessed_at" - }, - "1214": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder" - }, - "1215": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder.name" - }, - "1216": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Folder.key" - }, - "1217": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result" - }, - "1218": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.hasNext" - }, - "1219": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.folders" - }, - "1220": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.objects" - }, - "1221": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SearchV2Result.nextCursor" - }, - "1222": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters" - }, - "1223": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters.signal" - }, - "1224": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "FetchParameters.cache" - }, - "1225": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Metadata" - }, - "1226": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Metadata.name" - }, - "1227": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions" - }, - "1228": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.width" - }, - "1229": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.height" - }, - "1230": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.resize" - }, - "1231": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.quality" - }, - "1232": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TransformOptions.format" - }, - "1233": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Camelize" - }, - "1234": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1235": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DownloadResult" - }, - "1236": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1237": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1238": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1239": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1240": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1241": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1242": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1243": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration" - }, - "1244": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration.kmsKeyArn" - }, - "1245": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "EncryptionConfiguration.sseType" - }, - "1246": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket" - }, - "1247": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.vectorBucketName" - }, - "1248": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.creationTime" - }, - "1249": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorBucket.encryptionConfiguration" - }, - "1250": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MetadataConfiguration" - }, - "1251": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "MetadataConfiguration.nonFilterableMetadataKeys" - }, - "1252": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorDataType" - }, - "1253": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1254": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DistanceMetric" - }, - "1255": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1256": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex" - }, - "1257": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.indexName" - }, - "1258": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.vectorBucketName" - }, - "1259": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.dataType" - }, - "1260": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.dimension" - }, - "1261": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.distanceMetric" - }, - "1262": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.metadataConfiguration" - }, - "1263": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorIndex.creationTime" - }, - "1264": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorData" - }, - "1265": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorData.float32" - }, - "1266": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMetadata" - }, - "1267": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject" - }, - "1268": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.key" - }, - "1269": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.data" - }, - "1270": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorObject.metadata" - }, - "1271": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch" - }, - "1272": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.key" - }, - "1273": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.data" - }, - "1274": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.metadata" - }, - "1275": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorMatch.distance" - }, - "1276": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions" - }, - "1277": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.prefix" - }, - "1278": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.maxResults" - }, - "1279": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsOptions.nextToken" - }, - "1280": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse" - }, - "1281": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse.vectorBuckets" - }, - "1282": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1283": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.vectorBucketName" - }, - "1284": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorBucketsResponse.nextToken" - }, - "1285": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions" - }, - "1286": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.vectorBucketName" - }, - "1287": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.prefix" - }, - "1288": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.maxResults" - }, - "1289": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesOptions.nextToken" - }, - "1290": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse" - }, - "1291": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse.indexes" - }, - "1292": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1293": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.indexName" - }, - "1294": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListIndexesResponse.nextToken" - }, - "1295": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions" - }, - "1296": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.vectorBucketName" - }, - "1297": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.indexName" - }, - "1298": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.keys" - }, - "1299": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.returnData" - }, - "1300": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsOptions.returnMetadata" - }, - "1301": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsResponse" - }, - "1302": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "GetVectorsResponse.vectors" - }, - "1303": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions" - }, - "1304": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.vectorBucketName" - }, - "1305": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.indexName" - }, - "1306": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "PutVectorsOptions.vectors" - }, - "1307": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions" - }, - "1308": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.vectorBucketName" - }, - "1309": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.indexName" - }, - "1310": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DeleteVectorsOptions.keys" - }, - "1311": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions" - }, - "1312": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.vectorBucketName" - }, - "1313": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.indexName" - }, - "1314": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.maxResults" - }, - "1315": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.nextToken" - }, - "1316": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.returnData" - }, - "1317": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.returnMetadata" - }, - "1318": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.segmentCount" - }, - "1319": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsOptions.segmentIndex" - }, - "1320": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse" - }, - "1321": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse.vectors" - }, - "1322": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ListVectorsResponse.nextToken" - }, - "1323": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFilter" - }, - "1324": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions" - }, - "1325": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.vectorBucketName" - }, - "1326": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.indexName" - }, - "1327": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.queryVector" - }, - "1328": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.topK" - }, - "1329": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.filter" - }, - "1330": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.returnDistance" - }, - "1331": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsOptions.returnMetadata" - }, - "1332": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse" - }, - "1333": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse.vectors" - }, - "1334": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryVectorsResponse.distanceMetric" - }, - "1335": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFetchParameters" - }, - "1336": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "VectorFetchParameters.signal" - }, - "1337": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse" - }, - "1338": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.data" - }, - "1339": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.error" - }, - "1340": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SuccessResponse.T" - }, - "1341": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse" - }, - "1342": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse.data" - }, - "1343": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ErrorResponse.error" - }, - "1344": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "ApiResponse" - }, - "1345": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1346": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageError" - }, - "1347": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageError" - }, - "1348": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "error" - }, - "1349": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageVectorsError" - }, - "1350": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "isStorageVectorsError" - }, - "1351": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "error" - }, - "1352": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "1353": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "1354": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.__constructor" - }, - "1355": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "1356": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1357": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1358": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1359": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1362": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1363": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1364": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1365": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1366": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1368": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1369": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1370": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1371": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "1372": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.__constructor" - }, - "1373": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "1374": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1375": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1376": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1377": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1378": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "1379": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "1380": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1381": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1382": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1383": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1384": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1385": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1386": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1389": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError" - }, - "1390": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.__constructor" - }, - "1391": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError" - }, - "1392": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1393": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "originalError" - }, - "1394": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "1395": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.originalError" - }, - "1398": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1399": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1400": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1401": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1402": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1404": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1405": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1406": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1407": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError" - }, - "1408": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError.__constructor" - }, - "1409": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsError" - }, - "1410": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1413": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1414": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1415": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1416": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1417": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1418": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1419": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1420": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1421": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1422": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError" - }, - "1423": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError.__constructor" - }, - "1424": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsApiError" - }, - "1425": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1426": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "1427": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "1428": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "1429": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "1430": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1431": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "1432": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1433": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1434": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1435": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1436": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1439": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError" - }, - "1440": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError.__constructor" - }, - "1441": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsUnknownError" - }, - "1442": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "1443": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "originalError" - }, - "1444": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageUnknownError.originalError" - }, - "1447": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.status" - }, - "1448": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.statusCode" - }, - "1449": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1450": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageError.toJSON" - }, - "1451": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "1452": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "1453": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "1454": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "1455": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "1456": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode" - }, - "1457": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.InternalError" - }, - "1458": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorConflictException" - }, - "1459": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorNotFoundException" - }, - "1460": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorBucketNotEmpty" - }, - "1461": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorMaxBucketsExceeded" - }, - "1462": { - "sourceFileName": "src/lib/common/errors.ts", - "qualifiedName": "StorageVectorsErrorCode.S3VectorMaxIndexesExceeded" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "src/packages/BlobDownloadBuilder.ts", - "3": "src/packages/StorageAnalyticsClient.ts", - "4": "src/packages/StorageBucketApi.ts", - "5": "src/packages/StorageFileApi.ts", - "6": "src/packages/StorageVectorsClient.ts", - "7": "src/packages/StreamDownloadBuilder.ts", - "8": "src/packages/VectorBucketApi.ts", - "9": "src/packages/VectorDataApi.ts", - "10": "src/packages/VectorIndexApi.ts", - "11": "../../../CONTRIBUTING.md" - }, - "reflections": { - "1": 1, - "2": 2, - "3": 46, - "4": 135, - "5": 260, - "6": 535, - "7": 740, - "8": 782, - "9": 846, - "10": 911 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/supabase.json b/apps/docs/spec/enrichments/tsdoc_v2/supabase.json deleted file mode 100644 index 3716a5110c9..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/supabase.json +++ /dev/null @@ -1,111365 +0,0 @@ -{ - "id": 0, - "name": "@supabase/supabase-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 12, - "name": "cors", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Canonical CORS configuration for Supabase Edge Functions\n\nThis module exports CORS headers that stay synchronized with the Supabase SDK.\nWhen new headers are added to the SDK, they are automatically included here,\npreventing CORS errors in Edge Functions." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Basic usage", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { corsHeaders } from '@supabase/supabase-js/cors'\n\nDeno.serve(async (req) => {\n if (req.method === 'OPTIONS') {\n return new Response('ok', { headers: corsHeaders })\n }\n\n return new Response(\n JSON.stringify({ data: 'Hello' }),\n { headers: { ...corsHeaders, 'Content-Type': 'application/json' } }\n )\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 13, - "name": "CorsHeaders", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type representing CORS headers as a record of header names to values" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 54, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L54" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 14, - "name": "corsHeaders", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default CORS headers for Supabase Edge Functions.\n\nIncludes all headers sent by Supabase client libraries and allows all standard HTTP methods.\nUse this for simple CORS configurations with wildcard origin." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Basic usage", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { corsHeaders } from '@supabase/supabase-js/cors'\n\nDeno.serve(async (req) => {\n if (req.method === 'OPTIONS') {\n return new Response('ok', { headers: corsHeaders })\n }\n\n return new Response(\n JSON.stringify({ data: 'Hello' }),\n { headers: { ...corsHeaders, 'Content-Type': 'application/json' } }\n )\n})\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 80, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L80" - } - ], - "type": { - "type": "reference", - "target": 13, - "name": "CorsHeaders", - "package": "@supabase/supabase-js" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Type Aliases", - "children": [13] - }, - { - "title": "Variables", - "children": [14] - } - ], - "categories": [ - { - "title": "Edge Functions", - "children": [14] - }, - { - "title": "Other", - "children": [13] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L1" - } - ] - }, - { - "id": 1, - "name": "index", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 925, - "name": "FunctionRegion", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 926, - "name": "Any", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "any" - } - }, - { - "id": 927, - "name": "ApNortheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-1" - } - }, - { - "id": 928, - "name": "ApNortheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 79, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-2" - } - }, - { - "id": 929, - "name": "ApSouth1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 80, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-south-1" - } - }, - { - "id": 930, - "name": "ApSoutheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 81, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-1" - } - }, - { - "id": 931, - "name": "ApSoutheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 82, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-2" - } - }, - { - "id": 932, - "name": "CaCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 83, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ca-central-1" - } - }, - { - "id": 933, - "name": "EuCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 84, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-central-1" - } - }, - { - "id": 934, - "name": "EuWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 85, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-1" - } - }, - { - "id": 935, - "name": "EuWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 86, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-2" - } - }, - { - "id": 936, - "name": "EuWest3", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 87, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-3" - } - }, - { - "id": 937, - "name": "SaEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 88, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "sa-east-1" - } - }, - { - "id": 938, - "name": "UsEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 89, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-east-1" - } - }, - { - "id": 939, - "name": "UsWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 90, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-west-1" - } - }, - { - "id": 940, - "name": "UsWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 91, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-west-2" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 926, 927, 928, 929, 930, 931, 932, 933, 934, 935, 936, 937, 938, 939, 940 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 76, - "character": 20 - } - ] - }, - { - "id": 3393, - "name": "REALTIME_LISTEN_TYPES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3394, - "name": "BROADCAST", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 123, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3396, - "name": "POSTGRES_CHANGES", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 125, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 3395, - "name": "PRESENCE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 124, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 3397, - "name": "SYSTEM", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 126, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "system" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3394, 3396, 3395, 3397] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 122, - "character": 20 - } - ] - }, - { - "id": 3398, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3399, - "name": "ALL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 117, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "*" - } - }, - { - "id": 3402, - "name": "DELETE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 120, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "DELETE" - } - }, - { - "id": 3400, - "name": "INSERT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 118, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "INSERT" - } - }, - { - "id": 3401, - "name": "UPDATE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 119, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3399, 3402, 3400, 3401] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 116, - "character": 20 - } - ] - }, - { - "id": 3403, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3405, - "name": "JOIN", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "join" - } - }, - { - "id": 3406, - "name": "LEAVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - }, - { - "id": 3404, - "name": "SYNC", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3405, 3406, 3404] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 28, - "character": 20 - } - ] - }, - { - "id": 3407, - "name": "REALTIME_SUBSCRIBE_STATES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3411, - "name": "CHANNEL_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 132, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - } - }, - { - "id": 3410, - "name": "CLOSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 131, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - } - }, - { - "id": 3408, - "name": "SUBSCRIBED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 129, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - } - }, - { - "id": 3409, - "name": "TIMED_OUT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 130, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3411, 3410, 3408, 3409] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 128, - "character": 20 - } - ] - }, - { - "id": 2561, - "name": "AuthApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error returned directly from the GoTrue REST API." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthApiError } from '@supabase/auth-js'\n\nthrow new AuthApiError('Invalid credentials', 400, 'invalid_credentials')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2562, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 45, - "character": 4 - } - ], - "signatures": [ - { - "id": 2563, - "name": "AuthApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 45, - "character": 4 - } - ], - "parameters": [ - { - "id": 2564, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2565, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2566, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2561, - "name": "AuthApiError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2570, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2568, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2569, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2567, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2571, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2572, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2573, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2577, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2578, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2575, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2574, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2576, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2577, 2575, 2574, 2576] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2562] - }, - { - "title": "Properties", - "children": [2570, 2568, 2567] - }, - { - "title": "Methods", - "children": [2571] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 43, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2543, - "name": "AuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error thrown by Supabase Auth helpers." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthError } from '@supabase/auth-js'\n\nthrow new AuthError('Unexpected auth error', 500, 'unexpected')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2544, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 24, - "character": 4 - } - ], - "signatures": [ - { - "id": 2545, - "name": "AuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 2546, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2547, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2548, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 2552, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2549, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2550, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2551, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 2553, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2554, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2555, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2559, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2560, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2557, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2556, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2558, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2559, 2557, 2556, 2558] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2544] - }, - { - "title": "Properties", - "children": [2552, 2549, 2551] - }, - { - "title": "Methods", - "children": [2553] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 13, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2561, - "name": "AuthApiError" - }, - { - "type": "reference", - "target": 2579, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError" - } - ] - }, - { - "id": 2666, - "name": "AuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when implicit grant redirects contain an error." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthImplicitGrantRedirectError } from '@supabase/auth-js'\n\nthrow new AuthImplicitGrantRedirectError('OAuth redirect failed', {\n error: 'access_denied',\n code: 'oauth_error',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2667, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 4 - } - ], - "signatures": [ - { - "id": 2668, - "name": "AuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 4 - } - ], - "parameters": [ - { - "id": 2669, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2670, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2671, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2673, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 141, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2672, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 140, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2673, 2672] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 43 - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2694, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2692, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2693, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2674, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 135, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2675, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2677, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 137, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2676, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 136, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2677, 2676] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 135, - "character": 13 - } - ] - } - } - ] - } - }, - { - "id": 2690, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2691, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2678, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 4 - } - ], - "signatures": [ - { - "id": 2679, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2680, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2684, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 147, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2685, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2686, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 148, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2687, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2689, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 150, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2688, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 149, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2689, 2688] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 148, - "character": 17 - } - ] - } - } - ] - } - }, - { - "id": 2682, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 145, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2681, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 144, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2683, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 146, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2684, 2686, 2682, 2681, 2683] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2667] - }, - { - "title": "Properties", - "children": [2694, 2692, 2674, 2690, 2691] - }, - { - "title": "Methods", - "children": [2678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 134, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2649, - "name": "AuthInvalidCredentialsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when email/password credentials are invalid." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidCredentialsError } from '@supabase/auth-js'\n\nthrow new AuthInvalidCredentialsError('Email or password is incorrect')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2650, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 119, - "character": 4 - } - ], - "signatures": [ - { - "id": 2651, - "name": "AuthInvalidCredentialsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 119, - "character": 4 - } - ], - "parameters": [ - { - "id": 2652, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2649, - "name": "AuthInvalidCredentialsError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2657, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2655, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2653, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2654, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2658, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2659, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2660, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2664, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2665, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2662, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2661, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2663, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2664, 2662, 2661, 2663] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2650] - }, - { - "title": "Properties", - "children": [2657, 2655, 2653, 2654] - }, - { - "title": "Methods", - "children": [2658] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 118, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2796, - "name": "AuthInvalidJwtError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a JWT cannot be verified or parsed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidJwtError } from '@supabase/auth-js'\n\nthrow new AuthInvalidJwtError('Token signature is invalid')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2797, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 280, - "character": 4 - } - ], - "signatures": [ - { - "id": 2798, - "name": "AuthInvalidJwtError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 280, - "character": 4 - } - ], - "parameters": [ - { - "id": 2799, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2796, - "name": "AuthInvalidJwtError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2804, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2802, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2803, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2800, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2801, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2805, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2806, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2807, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2811, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2812, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2809, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2808, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2810, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2811, 2809, 2808, 2810] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2797] - }, - { - "title": "Properties", - "children": [2804, 2802, 2800, 2801] - }, - { - "title": "Methods", - "children": [2805] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 279, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2633, - "name": "AuthInvalidTokenResponseError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the token response is malformed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidTokenResponseError } from '@supabase/auth-js'\n\nthrow new AuthInvalidTokenResponseError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2634, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 106, - "character": 4 - } - ], - "signatures": [ - { - "id": 2635, - "name": "AuthInvalidTokenResponseError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2633, - "name": "AuthInvalidTokenResponseError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2640, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2638, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2639, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2636, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2637, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2641, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2642, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2643, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2647, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2648, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2645, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2644, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2646, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2647, 2645, 2644, 2646] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2634] - }, - { - "title": "Properties", - "children": [2640, 2638, 2636, 2637] - }, - { - "title": "Methods", - "children": [2641] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 105, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the PKCE code verifier is not found in storage.\nThis typically happens when the auth flow was initiated in a different\nbrowser, device, or the storage was cleared." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCECodeVerifierMissingError } from '@supabase/auth-js'\n\nthrow new AuthPKCECodeVerifierMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2725, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 198, - "character": 4 - } - ], - "signatures": [ - { - "id": 2726, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 198, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2731, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2729, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2730, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2727, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2728, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2732, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2733, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2734, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2738, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2739, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2736, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2735, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2737, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2738, 2736, 2735, 2737] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2725] - }, - { - "title": "Properties", - "children": [2731, 2729, 2727, 2728] - }, - { - "title": "Methods", - "children": [2732] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 197, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2695, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown during PKCE code exchanges." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'\n\nthrow new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2696, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 4 - } - ], - "signatures": [ - { - "id": 2697, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 4 - } - ], - "parameters": [ - { - "id": 2698, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2699, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2700, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2702, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 172, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2701, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 171, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2702, 2701] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 43 - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2695, - "name": "AuthPKCEGrantCodeExchangeError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2723, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2721, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2722, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2703, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 166, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2704, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2706, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 168, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2705, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 167, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2706, 2705] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 166, - "character": 13 - } - ] - } - } - ] - } - }, - { - "id": 2719, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2720, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2707, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 4 - } - ], - "signatures": [ - { - "id": 2708, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2709, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2713, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 178, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2714, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2715, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 179, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2716, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2718, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 181, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2717, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 180, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2718, 2717] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 179, - "character": 17 - } - ] - } - } - ] - } - }, - { - "id": 2711, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 176, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2710, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 175, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2712, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 177, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2713, 2715, 2711, 2710, 2712] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2696] - }, - { - "title": "Properties", - "children": [2723, 2721, 2703, 2719, 2720] - }, - { - "title": "Methods", - "children": [2707] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 165, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2758, - "name": "AuthRefreshDiscardedError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returned when the server rotated a refresh token successfully but the\nclient chose not to persist the rotated tokens because the local session\nchanged mid-flight. Usually means a concurrent " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " cleared storage\nbetween when the refresh started and when it came back.\n\nSet on the " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " field of the refresh result so callers can tell \"we\ngot rotated tokens but threw them away\" apart from \"the refresh failed.\"\nThe rotated session on the server will be picked up on the next refresh\nvia GoTrue's parent-of-active path." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { isAuthRefreshDiscardedError } from '@supabase/auth-js'\n\nif (isAuthRefreshDiscardedError(error)) {\n // Concurrent signOut/sign-in raced our refresh. Treat as a no-op.\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2759, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 236, - "character": 4 - } - ], - "signatures": [ - { - "id": 2760, - "name": "AuthRefreshDiscardedError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 236, - "character": 4 - } - ], - "parameters": [ - { - "id": 2761, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2766, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2764, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2765, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2762, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2763, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2767, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2768, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2773, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2774, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2771, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2770, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2772, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2773, 2771, 2770, 2772] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2759] - }, - { - "title": "Properties", - "children": [2766, 2764, 2762, 2763] - }, - { - "title": "Methods", - "children": [2767] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 235, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2740, - "name": "AuthRetryableFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a transient fetch issue occurs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthRetryableFetchError } from '@supabase/auth-js'\n\nthrow new AuthRetryableFetchError('Service temporarily unavailable', 503)\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2741, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 212, - "character": 4 - } - ], - "signatures": [ - { - "id": 2742, - "name": "AuthRetryableFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 212, - "character": 4 - } - ], - "parameters": [ - { - "id": 2743, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2744, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2749, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2747, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2748, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2745, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2746, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2750, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2751, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2756, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2757, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2754, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2753, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2755, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2756, 2754, 2753, 2755] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2741] - }, - { - "title": "Properties", - "children": [2749, 2747, 2745, 2746] - }, - { - "title": "Methods", - "children": [2750] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 211, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2617, - "name": "AuthSessionMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when an operation requires a session but none is present." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthSessionMissingError } from '@supabase/auth-js'\n\nthrow new AuthSessionMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2618, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 92, - "character": 4 - } - ], - "signatures": [ - { - "id": 2619, - "name": "AuthSessionMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 92, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2624, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2622, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2623, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2620, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2621, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2625, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2626, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2627, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2631, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2632, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2629, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2628, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2630, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2631, 2629, 2628, 2630] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2618] - }, - { - "title": "Properties", - "children": [2624, 2622, 2620, 2621] - }, - { - "title": "Methods", - "children": [2625] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 91, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2579, - "name": "AuthUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps non-standard errors so callers can inspect the root cause." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthUnknownError } from '@supabase/auth-js'\n\ntry {\n await someAuthCall()\n} catch (err) {\n throw new AuthUnknownError('Auth failed', err)\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2580, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 64, - "character": 4 - } - ], - "signatures": [ - { - "id": 2581, - "name": "AuthUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 64, - "character": 4 - } - ], - "parameters": [ - { - "id": 2582, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2583, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 2579, - "name": "AuthUnknownError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2588, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2585, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2586, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2584, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 2587, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2589, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2590, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2591, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2595, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2593, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2592, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2594, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2595, 2593, 2592, 2594] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2580] - }, - { - "title": "Properties", - "children": [2588, 2585, 2584, 2587] - }, - { - "title": "Methods", - "children": [2589] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 62, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2775, - "name": "AuthWeakPasswordError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a supplied password is considered weak." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthWeakPasswordError } from '@supabase/auth-js'\n\nthrow new AuthWeakPasswordError('Password too short', 400, ['min_length'])\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2776, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 259, - "character": 4 - } - ], - "signatures": [ - { - "id": 2777, - "name": "AuthWeakPasswordError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 259, - "character": 4 - } - ], - "parameters": [ - { - "id": 2778, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2779, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2780, - "name": "reasons", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2795, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2793, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2791, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2781, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reasons why the password is deemed weak." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 258, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 2792, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2782, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 4 - } - ], - "signatures": [ - { - "id": 2783, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2784, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2788, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 264, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2789, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2786, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 262, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2785, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 261, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2790, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 265, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 2787, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 263, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2788, 2786, 2785, 2790, 2787] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2776] - }, - { - "title": "Properties", - "children": [2795, 2793, 2791, 2781, 2792] - }, - { - "title": "Methods", - "children": [2782] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 254, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2597, - "name": "CustomAuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Flexible error class used to create named auth errors at runtime." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { CustomAuthError } from '@supabase/auth-js'\n\nthrow new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2598, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 79, - "character": 4 - } - ], - "signatures": [ - { - "id": 2599, - "name": "CustomAuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 79, - "character": 4 - } - ], - "parameters": [ - { - "id": 2600, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2601, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2602, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2603, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2608, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2606, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2607, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2604, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "AuthError.name" - } - }, - { - "id": 2605, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2609, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2610, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2611, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2615, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2616, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2613, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2612, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2614, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2615, 2613, 2612, 2614] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2598] - }, - { - "title": "Properties", - "children": [2608, 2606, 2604, 2605] - }, - { - "title": "Methods", - "children": [2609] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 76, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "target": 2633, - "name": "AuthInvalidTokenResponseError" - }, - { - "type": "reference", - "target": 2649, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "target": 2695, - "name": "AuthPKCEGrantCodeExchangeError" - }, - { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError" - }, - { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError" - }, - { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError" - }, - { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError" - }, - { - "type": "reference", - "target": 2796, - "name": "AuthInvalidJwtError" - } - ] - }, - { - "id": 912, - "name": "FunctionsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error for Supabase Edge Function invocations." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsError } from '@supabase/functions-js'\n\nthrow new FunctionsError('Unexpected error invoking function', 'FunctionsError', {\n requestId: 'abc123',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 913, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 30, - "character": 4 - } - ], - "signatures": [ - { - "id": 914, - "name": "FunctionsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 30, - "character": 4 - } - ], - "parameters": [ - { - "id": 915, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 917, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 918, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 919, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 920, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 921, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 924, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 923, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 922, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [924, 923, 922] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [913] - }, - { - "title": "Properties", - "children": [918] - }, - { - "title": "Methods", - "children": [919] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 28, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 879, - "name": "FunctionsHttpError" - }, - { - "type": "reference", - "target": 890, - "name": "FunctionsFetchError" - }, - { - "type": "reference", - "target": 901, - "name": "FunctionsRelayError" - } - ] - }, - { - "id": 890, - "name": "FunctionsFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the network request to an Edge Function fails." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsFetchError } from '@supabase/functions-js'\n\nthrow new FunctionsFetchError({ requestId: 'abc123' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 891, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 48, - "character": 4 - } - ], - "signatures": [ - { - "id": 892, - "name": "FunctionsFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 48, - "character": 4 - } - ], - "parameters": [ - { - "id": 893, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 890, - "name": "FunctionsFetchError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 894, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 895, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 896, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 897, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 900, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 899, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 898, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [900, 899, 898] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [891] - }, - { - "title": "Properties", - "children": [894] - }, - { - "title": "Methods", - "children": [895] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 47, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 879, - "name": "FunctionsHttpError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Edge Function returns a non-2xx status code." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsHttpError } from '@supabase/functions-js'\n\nthrow new FunctionsHttpError({ status: 500 })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 880, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 74, - "character": 4 - } - ], - "signatures": [ - { - "id": 881, - "name": "FunctionsHttpError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 74, - "character": 4 - } - ], - "parameters": [ - { - "id": 882, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 879, - "name": "FunctionsHttpError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 883, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 884, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 885, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 886, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 889, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 888, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 887, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [889, 888, 887] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [880] - }, - { - "title": "Properties", - "children": [883] - }, - { - "title": "Methods", - "children": [884] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 73, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 901, - "name": "FunctionsRelayError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Supabase relay cannot reach the Edge Function." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsRelayError } from '@supabase/functions-js'\n\nthrow new FunctionsRelayError({ region: 'us-east-1' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 902, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 61, - "character": 4 - } - ], - "signatures": [ - { - "id": 903, - "name": "FunctionsRelayError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 61, - "character": 4 - } - ], - "parameters": [ - { - "id": 904, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 901, - "name": "FunctionsRelayError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 905, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 906, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 907, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 908, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 911, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 910, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 909, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [911, 910, 909] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [902] - }, - { - "title": "Properties", - "children": [905] - }, - { - "title": "Methods", - "children": [906] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 60, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 1124, - "name": "GoTrueAdminApi", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1125, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 4 - } - ], - "signatures": [ - { - "id": 1126, - "name": "GoTrueAdminApi", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an admin API client that can be used to manage users and OAuth clients." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\nconst { data, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueAdminApi } from '@supabase/auth-js'\n\nconst admin = new GoTrueAdminApi({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { Authorization: `Bearer ${process.env.SUPABASE_SECRET_KEY}` },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 4 - } - ], - "parameters": [ - { - "id": 1127, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1128, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1142, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1134, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1135, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1136, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1137, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1138, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1139, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1140, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1141, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1130, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 49, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 49, - "character": 18 - } - ], - "indexSignatures": [ - { - "id": 1132, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 50, - "character": 12 - } - ], - "parameters": [ - { - "id": 1133, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1129, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 48, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1142, 1134, 1130, 1129] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 56 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1145, - "name": "customProviders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2343, - "name": "GoTrueAdminCustomProvidersApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1160, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 25, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1152, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 24, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1154, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1155, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1156, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1157, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1158, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1159, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1148, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 21, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1149, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 21, - "character": 23 - } - ], - "indexSignatures": [ - { - "id": 1150, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 22, - "character": 8 - } - ], - "parameters": [ - { - "id": 1151, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1143, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all MFA administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 6, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2096, - "name": "GoTrueAdminMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1144, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 11, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2228, - "name": "GoTrueAdminOAuthApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1146, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all passkey administration methods.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2512, - "name": "GoTrueAdminPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1147, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 20, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1178, - "name": "createUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 335, - "character": 4 - } - ], - "signatures": [ - { - "id": 1179, - "name": "createUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To confirm the user's email address or phone number, set " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " to true. Both arguments default to false.\n- " - }, - { - "kind": "code", - "text": "`createUser()`" - }, - { - "kind": "text", - "text": " will not send a confirmation email to the user. You can use [" - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " param to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "With custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n password: 'password',\n user_metadata: { name: 'Yoda' }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With custom user metadata\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n email_confirm: true\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n phone: '1234567890',\n phone_confirm: true\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 335, - "character": 4 - } - ], - "parameters": [ - { - "id": 1180, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1750, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1202, - "name": "deleteUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 613, - "character": 4 - } - ], - "signatures": [ - { - "id": 1203, - "name": "deleteUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a user. Requires a " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`deleteUser()`" - }, - { - "kind": "text", - "text": " method requires the user's ID, which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Removes a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.deleteUser(\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Removes a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {}\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 613, - "character": 4 - } - ], - "parameters": [ - { - "id": 1204, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user id you want to remove." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1205, - "name": "shouldSoftDelete", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1175, - "name": "generateLink", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 254, - "character": 4 - } - ], - "signatures": [ - { - "id": 1176, - "name": "generateLink", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates email links and OTPs to be sent via a custom email provider." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The following types can be passed into " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": ": " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_current`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_new`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " only generates the email link for " - }, - { - "kind": "code", - "text": "`email_change_email`" - }, - { - "kind": "text", - "text": " if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " handles the creation of the user for " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Generate a signup link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'signup',\n email: 'email@example.com',\n password: 'secret'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Generate a signup link\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"properties\": {\n \"action_link\": \"\",\n \"email_otp\": \"999999\",\n \"hashed_token\": \"\",\n \"verification_type\": \"signup\"\n },\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"email@example.com\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"email@example.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate an invite link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'invite',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a magic link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'magiclink',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a recovery link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'recovery',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate links to change current email address", - "content": [ - { - "kind": "code", - "text": "```js\n// generate an email change link to be sent to the current email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_current',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n\n// generate an email change link to be sent to the new email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_new',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 254, - "character": 4 - } - ], - "parameters": [ - { - "id": 1177, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1964, - "name": "GenerateLinkParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1965, - "name": "GenerateLinkResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1195, - "name": "getUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 435, - "character": 4 - } - ], - "signatures": [ - { - "id": 1196, - "name": "getUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get user by id." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Fetches the user object from the database based on the user's id.\n- The " - }, - { - "kind": "code", - "text": "`getUserById()`" - }, - { - "kind": "text", - "text": " method requires the user's id which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Fetch the user object using the access_token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.getUserById(1)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Fetch the user object using the access_token jwt\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 435, - "character": 4 - } - ], - "parameters": [ - { - "id": 1197, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1168, - "name": "inviteUserByEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 4 - } - ], - "signatures": [ - { - "id": 1169, - "name": "inviteUserByEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends an invite link to an email address." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Sends an invite link to the user's email address.\n- The " - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": " method is typically used by administrators to invite users to join the application.\n- Note that PKCE is not supported when using " - }, - { - "kind": "code", - "text": "`inviteUserByEmail`" - }, - { - "kind": "text", - "text": ". This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow." - } - ] - }, - { - "tag": "@example", - "name": "Invite a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Invite a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"invited_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 4 - } - ], - "parameters": [ - { - "id": 1170, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1171, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options to be included when inviting." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1172, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1173, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store additional metadata about the user. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.user_metadata`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 133, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1174, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 135, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1173, 1174] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 47 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1181, - "name": "listUsers", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 4 - } - ], - "signatures": [ - { - "id": 1182, - "name": "listUsers", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Defaults to return 50 users per page." - } - ] - }, - { - "tag": "@example", - "name": "Get a page of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Paginated list of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\n page: 1,\n perPage: 1000\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 4 - } - ], - "parameters": [ - { - "id": 1183, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object which supports " - }, - { - "kind": "code", - "text": "`page`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`perPage`" - }, - { - "kind": "text", - "text": " as numbers, to alter the paginated results." - } - ] - }, - "type": { - "type": "reference", - "target": 2117, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1184, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1185, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 362, - "character": 8 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1186, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1188, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 364, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1187, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 363, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1188, 1187] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 362, - "character": 14 - } - ] - } - }, - { - "type": "reference", - "target": 2110, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1189, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 366, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1185, 1189] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 44 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1190, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1191, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 368, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1192, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1193, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 369, - "character": 12 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1193] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 368, - "character": 14 - } - ] - } - } - }, - { - "id": 1194, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 371, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1191, 1194] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 367, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1161, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 4 - } - ], - "signatures": [ - { - "id": 1162, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a logged-in session." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 4 - } - ], - "parameters": [ - { - "id": 1163, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A valid, logged-in JWT." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1164, - "name": "scope", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logout sope." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1166, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 64, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1167, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 65, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1166, 1167] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 56 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1198, - "name": "updateUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 580, - "character": 4 - } - ], - "signatures": [ - { - "id": 1199, - "name": "updateUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the user data. Changes are applied directly without confirmation flows." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "**Important:** This is a server-side operation and does **not** trigger client-side\n" - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " listeners. The admin API has no connection to client state.\n\nTo sync changes to the client after calling this method:\n1. On the client, call " - }, - { - "kind": "code", - "text": "`supabase.auth.refreshSession()`" - }, - { - "kind": "text", - "text": " to fetch the updated user data\n2. This will trigger the " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event and notify all listeners" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\n// Server-side (Edge Function)\nconst { data, error } = await supabase.auth.admin.updateUserById(\n userId,\n { user_metadata: { preferences: { theme: 'dark' } } }\n)\n\n// Client-side (to sync the changes)\nconst { data, error } = await supabase.auth.refreshSession()\n// onAuthStateChange listeners will now be notified with updated user\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.refreshSession", - "target": 1405 - }, - { - "kind": "text", - "text": " for syncing admin changes to the client" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.updateUser", - "target": 1381 - }, - { - "kind": "text", - "text": " for client-side user updates (triggers listeners automatically)" - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '11111111-1111-1111-1111-111111111111',\n { email: 'new@email.com' }\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updates a user's email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"new@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { password: 'new_password' }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { user_metadata: { hello: 'world' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's app_metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { app_metadata: { plan: 'trial' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's email address", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { email_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { phone_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Ban a user for 100 years", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { ban_duration: '876000h' }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 580, - "character": 4 - } - ], - "parameters": [ - { - "id": 1200, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1201, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "reference", - "target": 1750, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1125] - }, - { - "title": "Properties", - "children": [1145, 1160, 1152, 1148, 1143, 1144, 1146, 1147] - }, - { - "title": "Methods", - "children": [1178, 1202, 1175, 1195, 1168, 1181, 1161, 1198] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1178, 1202, 1175, 1195, 1168, 1181, 1161, 1198] - }, - { - "title": "Other", - "children": [1125, 1145, 1160, 1152, 1148, 1143, 1144, 1146, 1147] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 4, - "character": 21 - } - ] - }, - { - "id": 1221, - "name": "GoTrueClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1223, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 134, - "character": 4 - } - ], - "signatures": [ - { - "id": 1224, - "name": "GoTrueClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueClient } from '@supabase/auth-js'\n\nconst auth = new GoTrueClient({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { apikey: 'your-publishable-key' },\n storageKey: 'supabase-auth',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 134, - "character": 4 - } - ], - "parameters": [ - { - "id": 1225, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1599, - "name": "GoTrueClientOptions", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": 1221, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1260, - "name": "_sessionRemovalEpoch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Monotonic counter incremented at the top of " - }, - { - "kind": "code", - "text": "`_removeSession`" - }, - { - "kind": "text", - "text": ", before any\n" - }, - { - "kind": "code", - "text": "`await`" - }, - { - "kind": "text", - "text": ". The commit guard inside " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": " captures this value\nbefore " - }, - { - "kind": "code", - "text": "`_saveSession`" - }, - { - "kind": "text", - "text": " and re-checks it after, so a " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " that\ninterleaves inside " - }, - { - "kind": "code", - "text": "`_saveSession`" - }, - { - "kind": "text", - "text": "'s storage-write awaits is still caught\n(the post-fetch storage snapshot alone misses that window)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 69, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1227, - "name": "admin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - }, - { - "id": 1254, - "name": "autoRefreshTicker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 58, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/timers.d.ts", - "qualifiedName": "__global.NodeJS.Timeout" - }, - "name": "Timeout", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.Timeout" - } - ] - } - }, - { - "id": 1255, - "name": "autoRefreshTickTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 59, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/timers.d.ts", - "qualifiedName": "__global.NodeJS.Timeout" - }, - "name": "Timeout", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.Timeout" - } - ] - } - }, - { - "id": 1245, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 47, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1291, - "name": "broadcastChannel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to broadcast state change events to other tabs listening." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 109, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "BroadcastChannel" - }, - "name": "BroadcastChannel", - "package": "typescript" - } - ] - } - }, - { - "id": 1262, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1263, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 45 - } - ], - "signatures": [ - { - "id": 1264, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 45 - } - ], - "parameters": [ - { - "id": 1265, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1266, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1267, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 64 - } - ], - "indexSignatures": [ - { - "id": 1268, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 78, - "character": 8 - } - ], - "parameters": [ - { - "id": 1269, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1290, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. Defaults to an empty object.\nSee " - }, - { - "kind": "code", - "text": "`GoTrueClientOptions.experimental`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 105, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1277, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 86, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1278, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1279, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1280, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1281, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1282, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1283, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1284, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1232, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 35, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1810, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1275, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 84, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1271, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 81, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1272, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 81, - "character": 23 - } - ], - "indexSignatures": [ - { - "id": 1273, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 82, - "character": 8 - } - ], - "parameters": [ - { - "id": 1274, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1261, - "name": "initializePromise", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Keeps track of the async client initialization.\nWhen null or not yet resolved the auth state is " - }, - { - "kind": "code", - "text": "`unknown`" - }, - { - "kind": "text", - "text": "\nOnce resolved the auth state is known and it's safe to call any further client methods.\nKeep extra care to never reject or throw uncaught errors" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 76, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2106, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - }, - { - "id": 1285, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom lock function passed via " - }, - { - "kind": "code", - "text": "`settings.lock`" - }, - { - "kind": "text", - "text": ". When non-null, every auth\noperation runs inside " - }, - { - "kind": "code", - "text": "`_acquireLock`" - }, - { - "kind": "text", - "text": ". When null (the default), the client\nuses its lockless coordination (refresh single-flight + commit guard).\nTODO(v3): remove along with the legacy lock path." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 93, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1590, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1286, - "name": "lockAcquired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 94, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1289, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is supplied. TODO(v3): remove." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 100, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1292, - "name": "logDebugMessages", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 110, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1293, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1294, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 22 - } - ], - "signatures": [ - { - "id": 1295, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 22 - } - ], - "parameters": [ - { - "id": 1296, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1297, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 1249, - "name": "memoryStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 54, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1250, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 54, - "character": 29 - } - ], - "indexSignatures": [ - { - "id": 1251, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 55, - "character": 8 - } - ], - "parameters": [ - { - "id": 1252, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ] - } - }, - { - "id": 1228, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the MFA methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2025, - "name": "GoTrueMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1229, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the OAuth 2.1 authorization server methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\nUsed to implement the authorization code flow on the consent page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2392, - "name": "AuthOAuthServerApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1230, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for passkey methods.\nIncludes lower-level two-step registration/authentication and passkey management.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2492, - "name": "AuthPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1287, - "name": "pendingInLock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 95, - "character": 14 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - }, - { - "id": 1246, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 48, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1259, - "name": "refreshingDeferred", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 61, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/helpers.ts", - "qualifiedName": "Deferred" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2109, - "name": "CallRefreshTokenResult", - "package": "@supabase/auth-js" - } - ], - "name": "Deferred", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1253, - "name": "stateChangeEmitters", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 57, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.collection.d.ts", - "qualifiedName": "Map" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - ], - "name": "Map", - "package": "typescript" - } - }, - { - "id": 1247, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 49, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 1231, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The storage key used to identify the values saved in localStorage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 34, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1276, - "name": "suppressGetSessionWarning", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 85, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1288, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 96, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1270, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 80, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1248, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 53, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1256, - "name": "visibilityChangedCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1257, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 42 - } - ], - "signatures": [ - { - "id": 1258, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 42 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 1233, - "name": "jwks", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 18 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 18 - } - ], - "getSignature": { - "id": 1234, - "name": "jwks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The JWKS used for verifying asymmetric JWTs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 18 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1235, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1236, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 40, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1236] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 26 - } - ] - } - } - }, - "setSignature": { - "id": 1237, - "name": "jwks", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 18 - } - ], - "parameters": [ - { - "id": 1238, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1239, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1240, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 43, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1240] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 30 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 1241, - "name": "jwks_cached_at", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 45, - "character": 18 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 46, - "character": 18 - } - ], - "getSignature": { - "id": 1242, - "name": "jwks_cached_at", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 45, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - "setSignature": { - "id": 1243, - "name": "jwks_cached_at", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 46, - "character": 18 - } - ], - "parameters": [ - { - "id": 1244, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 1410, - "name": "_refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 14 - } - ], - "signatures": [ - { - "id": 1411, - "name": "_refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 14 - } - ], - "parameters": [ - { - "id": 1412, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1414, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1911, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 47 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1399, - "name": "_setSession", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 14 - } - ], - "signatures": [ - { - "id": 1400, - "name": "_setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 14 - } - ], - "parameters": [ - { - "id": 1401, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1403, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1779, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1404, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1780, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1403, 1404] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 42 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1423, - "name": "_signOut", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 14 - } - ], - "signatures": [ - { - "id": 1424, - "name": "_signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 14 - } - ], - "parameters": [ - { - "id": 1425, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2121, - "name": "SignOut", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1426, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1427, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1974, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1427] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 53 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1387, - "name": "_updateUser", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 14 - } - ], - "signatures": [ - { - "id": 1388, - "name": "_updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 14 - } - ], - "parameters": [ - { - "id": 1389, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 1390, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1392, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1648, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1392] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 64 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1506, - "name": "dispose", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2320, - "character": 4 - } - ], - "signatures": [ - { - "id": 1507, - "name": "dispose", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tears down the client's background work: stops the auto-refresh interval,\nremoves the " - }, - { - "kind": "code", - "text": "`visibilitychange`" - }, - { - "kind": "text", - "text": " listener, closes the cross-tab\n" - }, - { - "kind": "code", - "text": "`BroadcastChannel`" - }, - { - "kind": "text", - "text": ", and clears registered " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " subscribers.\n\nCall this from cleanup hooks when the client is being replaced before\nits JS realm is destroyed. React Strict Mode and HMR are the common\ncases. Any in-flight " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " calls continue to completion and may still\nwrite to storage; dispose doesn't abort them or erase storage.\n\nLifecycle caveat: because in-flight refreshes are not aborted, a\ndisposed instance can still persist a rotated session to storage after\n" - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " returns. A subsequent " - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " against the same\n" - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " will pick up that session on its next read. If you need\nstrict isolation between client lifecycles, await any pending auth\noperation before calling " - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " (or change the " - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " for\nthe replacement client).\n\nSafe to call repeatedly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup on React unmount", - "content": [ - { - "kind": "code", - "text": "```ts\nuseEffect(() => {\n const client = createClient(...)\n return () => { client.auth.dispose() }\n}, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2320, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1318, - "name": "exchangeCodeForSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 797, - "character": 4 - } - ], - "signatures": [ - { - "id": 1319, - "name": "exchangeCodeForSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Used when " - }, - { - "kind": "code", - "text": "`flowType`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`pkce`" - }, - { - "kind": "text", - "text": " in client options." - } - ] - }, - { - "tag": "@example", - "name": "Exchange Auth Code", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Exchange Auth Code\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n session: {\n access_token: '',\n token_type: 'bearer',\n expires_in: 3600,\n expires_at: 1700000000,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com'\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n \"provider\": \"email\",\n \"providers\": [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n provider_token: '',\n provider_refresh_token: ''\n },\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n redirectType: null\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 797, - "character": 4 - } - ], - "parameters": [ - { - "id": 1320, - "name": "authCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1525, - "name": "getClaims", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 4 - } - ], - "signatures": [ - { - "id": 1526, - "name": "getClaims", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" - }, - { - "kind": "code", - "text": "`/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": ") to verify the JWT." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\n- A network request is sent to your project's JWT signing key discovery endpoint " - }, - { - "kind": "code", - "text": "`https://project-id.supabase.co/auth/v1/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": ", which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook)." - } - ] - }, - { - "tag": "@example", - "name": "Get JWT claims, header and signature", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getClaims()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get JWT claims, header and signature\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"claims\": {\n \"aal\": \"aal1\",\n \"amr\": [{\n \"method\": \"email\",\n \"timestamp\": 1715766000\n }],\n \"app_metadata\": {},\n \"aud\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"exp\": 1715769600,\n \"iat\": 1715766000,\n \"is_anonymous\": false,\n \"iss\": \"https://project-id.supabase.co/auth/v1\",\n \"phone\": \"+13334445555\",\n \"role\": \"authenticated\",\n \"session_id\": \"11111111-1111-1111-1111-111111111111\",\n \"sub\": \"11111111-1111-1111-1111-111111111111\",\n \"user_metadata\": {}\n },\n \"header\": {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"signature\": [/** Uint8Array */],\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 4 - } - ], - "parameters": [ - { - "id": 1527, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getSession" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1528, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Various additional options that allow you to customize the\n behavior of this method." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1529, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1531, - "name": "allowExpired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " the " - }, - { - "kind": "code", - "text": "`exp`" - }, - { - "kind": "text", - "text": " claim will not be validated against the current time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2468, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1532, - "name": "jwks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2470, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1533, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1534, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2471, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1534] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2470, - "character": 15 - } - ] - } - } - }, - { - "id": 1530, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Please use options.jwks instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2466, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1531, 1532, 1530] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 38 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1535, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1536, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2474, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1537, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1538, - "name": "claims", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2475, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 2146, - "name": "JwtPayload", - "package": "@supabase/auth-js" - } - }, - { - "id": 1539, - "name": "header", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2476, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 2130, - "name": "JwtHeader", - "package": "@supabase/auth-js" - } - }, - { - "id": 1540, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2477, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1538, 1539, 1540] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2474, - "character": 14 - } - ] - } - } - }, - { - "id": 1541, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2479, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1536, 1541] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2473, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1542, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1543, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2481, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1544, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2482, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1543, 1544] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2480, - "character": 8 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1545, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1546, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2484, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1547, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2485, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1546, 1547] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2483, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1357, - "name": "getSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 4 - } - ], - "signatures": [ - { - "id": 1358, - "name": "getSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser()" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " instead.\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\n- The session contains an access token (signed JWT), a refresh token and the user object.\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\n- When using in a browser, or you've called " - }, - { - "kind": "code", - "text": "`startAutoRefresh()`" - }, - { - "kind": "text", - "text": " in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or your own JWT verification library to securely establish the user's identity and access. You can also use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch the user object directly from the Auth server for this purpose.\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed." - } - ] - }, - { - "tag": "@example", - "name": "Get the session data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getSession()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the session data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1359, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1360, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1417, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1361, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1362, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1418, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1362] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1417, - "character": 14 - } - ] - } - } - }, - { - "id": 1363, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1420, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1360, 1363] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 26 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1364, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1365, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1422, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1367, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1423, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1367] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1422, - "character": 14 - } - ] - } - } - }, - { - "id": 1368, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1425, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1365, 1368] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1421, - "character": 8 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1369, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1370, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1427, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1371, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1372, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1428, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1372] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1427, - "character": 14 - } - ] - } - } - }, - { - "id": 1373, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1430, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1370, 1373] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1426, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1377, - "name": "getUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1528, - "character": 4 - } - ], - "signatures": [ - { - "id": 1378, - "name": "getUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method fetches the user object from the database instead of local session.\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\n- Should always be used when checking for user authorization on the server. On the client, you can instead use " - }, - { - "kind": "code", - "text": "`getSession().session.user`" - }, - { - "kind": "text", - "text": " for faster results. " - }, - { - "kind": "code", - "text": "`getSession`" - }, - { - "kind": "text", - "text": " is insecure on the server." - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with the current existing session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the logged in user with the current existing session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with a custom access token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1528, - "character": 4 - } - ], - "parameters": [ - { - "id": 1379, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1464, - "name": "getUserIdentities", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 4 - } - ], - "signatures": [ - { - "id": 1465, - "name": "getUserIdentities", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets all the identities linked to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`getUserIdentities()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Returns a list of identities linked to the user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getUserIdentities()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Returns a list of identities linked to the user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"2024-01-01T00:00:00Z\",\n \"user_id\": \"2024-01-01T00:00:00Z\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ]\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1466, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1467, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2126, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1469, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2127, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1469] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2126, - "character": 14 - } - ] - } - } - }, - { - "id": 1470, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2129, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1467, 1470] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 33 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1471, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1472, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2131, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1473, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2132, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1472, 1473] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2130, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1303, - "name": "initialize", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 154, - "character": 4 - } - ], - "signatures": [ - { - "id": 1304, - "name": "initialize", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 154, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2106, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1298, - "name": "isThrowOnErrorEnabled", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 138, - "character": 4 - } - ], - "signatures": [ - { - "id": 1299, - "name": "isThrowOnErrorEnabled", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns whether error throwing mode is enabled for this client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 138, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 1474, - "name": "linkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2138, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2142, - "character": 4 - } - ], - "signatures": [ - { - "id": 1475, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2138, - "character": 4 - } - ], - "parameters": [ - { - "id": 1476, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1812, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1685, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1477, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an OIDC identity to an existing user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2142, - "character": 4 - } - ], - "parameters": [ - { - "id": 1478, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1824, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1428, - "name": "onAuthStateChange", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 4 - } - ], - "signatures": [ - { - "id": 1429, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens.\nSafe to use without an async function as callback." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 4 - } - ], - "parameters": [ - { - "id": 1430, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1431, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 32 - } - ], - "signatures": [ - { - "id": 1432, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 32 - } - ], - "parameters": [ - { - "id": 1433, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1434, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1435, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1436, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1983, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1437, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1438, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1984, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1438] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1983, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1436] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 92 - } - ] - } - } - }, - { - "id": 1439, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens. Common reentry\npatterns (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", reading the session from inside a\nhandler) complete normally. One hazard remains: calling " - }, - { - "kind": "code", - "text": "`refreshSession`" - }, - { - "kind": "text", - "text": "\n(or anything that routes through " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": ") from inside a\n" - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " handler. " - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " resolves only after\n" - }, - { - "kind": "code", - "text": "`_notifyAllSubscribers`" - }, - { - "kind": "text", - "text": " returns, so the inner refresh dedupes onto the\nouter's unresolved promise and the two wait on each other." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Async callbacks can deadlock when they trigger a nested\nrefresh from a " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event. Prefer the sync overload, or move\nrefresh-triggering work outside the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 4 - } - ], - "parameters": [ - { - "id": 1440, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1441, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 32 - } - ], - "signatures": [ - { - "id": 1442, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 32 - } - ], - "parameters": [ - { - "id": 1443, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1444, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1446, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2003, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1448, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2004, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1448] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2003, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1446] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 101 - } - ] - } - } - } - ] - }, - { - "id": 1351, - "name": "reauthenticate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1269, - "character": 4 - } - ], - "signatures": [ - { - "id": 1352, - "name": "reauthenticate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used together with " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " when a user's password needs to be updated.\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\n- After receiving the OTP, include it as the " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " in your " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " call to finalize the password change." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Send reauthentication nonce\nSends a reauthentication nonce to the user's email or phone number." - } - ] - }, - { - "tag": "@example", - "name": "Send reauthentication nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.reauthenticate()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1269, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1405, - "name": "refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 4 - } - ], - "signatures": [ - { - "id": 1406, - "name": "refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method will refresh and return a new session whether the current one is expired or not." - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using the current session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession()\nconst { session, user } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Refresh session using the current session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using a refresh token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\nconst { session, user } = data\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 4 - } - ], - "parameters": [ - { - "id": 1407, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session. If passed in, it must contain a refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1408, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1409, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1908, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1409] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 36 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1551, - "name": "registerPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2508, - "character": 4 - } - ], - "signatures": [ - { - "id": 1552, - "name": "registerPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Register a passkey for the current authenticated user. Handles the full WebAuthn ceremony:\n1. Fetches registration challenge from server\n2. Prompts user via navigator.credentials.create()\n3. Verifies credential with server\n\nRequires an active session. Requires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2508, - "character": 4 - } - ], - "parameters": [ - { - "id": 1553, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2450, - "name": "RegisterPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1354, - "name": "resend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1330, - "character": 4 - } - ], - "signatures": [ - { - "id": 1355, - "name": "resend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Resends a signup confirmation, email change or phone change email to the user.\n- Passwordless sign-ins can be resent by calling the " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " method again.\n- Password recovery emails can be resent by calling the " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " method again.\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " again to resend the OTP).\n- You can specify a redirect url when you resend an email link using the " - }, - { - "kind": "code", - "text": "`emailRedirectTo`" - }, - { - "kind": "text", - "text": " option." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend an email signup confirmation\nResends the email signup confirmation to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend an email signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'signup',\n email: 'email@example.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend a phone signup confirmation\nResends the phone signup confirmation email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend a phone signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'sms',\n phone: '1234567890'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend email change email\nResends the email change email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend email change email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'email_change',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend phone change OTP\nResends the phone change OTP to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend phone change OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'phone_change',\n phone: '1234567890'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1330, - "character": 4 - } - ], - "parameters": [ - { - "id": 1356, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1910, - "name": "ResendParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1671, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1450, - "name": "resetPasswordForEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 4 - } - ], - "signatures": [ - { - "id": 1451, - "name": "resetPasswordForEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a password reset request to an email address. This method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\n- The " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " only sends a password reset link to the user's email.\nTo update the user's password, see [" - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-updateuser).\n- A " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": " event will be emitted when the password recovery link is clicked.\nYou can use [" - }, - { - "kind": "code", - "text": "`onAuthStateChange()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\n- When the user clicks the reset link in the email they are redirected back to your application.\nYou can configure the URL that the user is redirected to with the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter.\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- After the user has been redirected successfully, prompt them for a new password and call " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": ":\n" - }, - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: new_password\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\n redirectTo: 'https://example.com/update-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Reset password\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {}\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password (React)", - "content": [ - { - "kind": "code", - "text": "```js\n/**\n * Step 1: Send the user an email to get a password reset token.\n * This email contains a link which sends the user back to your application.\n */\nconst { data, error } = await supabase.auth\n .resetPasswordForEmail('user@email.com')\n\n/**\n * Step 2: Once the user is redirected back to your application,\n * ask the user to reset their password.\n */\n useEffect(() => {\n supabase.auth.onAuthStateChange(async (event, session) => {\n if (event == \"PASSWORD_RECOVERY\") {\n const newPassword = prompt(\"What would you like your new password to be?\");\n const { data, error } = await supabase.auth\n .updateUser({ password: newPassword })\n\n if (data) alert(\"Password updated successfully!\")\n if (error) alert(\"There was an error updating your password.\")\n }\n })\n }, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 4 - } - ], - "parameters": [ - { - "id": 1452, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1453, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1456, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2077, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1455, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to send the user to after they click the password reset link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2076, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1456, 1455] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 51 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1457, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1458, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2079, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1459, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 1460, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2080, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1458, 1460] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2078, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1461, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1462, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2082, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1463, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2083, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1462, 1463] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2081, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1393, - "name": "setSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 4 - } - ], - "signatures": [ - { - "id": 1394, - "name": "setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method sets the session using an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`refresh_token`" - }, - { - "kind": "text", - "text": ".\n- If successful, a " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event is emitted." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Set the session\nSets the session data from an access_token and refresh_token, then returns an auth response or error." - } - ] - }, - { - "tag": "@example", - "name": "Set the session", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.setSession({\n access_token,\n refresh_token\n })\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set the session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"11111111-1111-1111-1111-111111111111\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"2024-01-01T00:00:00Z\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"token_type\": \"bearer\",\n \"expires_in\": 3500,\n \"expires_at\": 1700000000\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 4 - } - ], - "parameters": [ - { - "id": 1395, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session that minimally contains an access token and refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1396, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1397, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1775, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1398, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1776, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1397, 1398] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 31 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1306, - "name": "signInAnonymously", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 235, - "character": 4 - } - ], - "signatures": [ - { - "id": 1307, - "name": "signInAnonymously", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new anonymous user." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A session where the is_anonymous claim in the access token JWT set to true" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Returns an anonymous user\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the " - }, - { - "kind": "code", - "text": "`options`" - }, - { - "kind": "text", - "text": " param." - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n captchaToken\n }\n});\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create an anonymous user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user with custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n data\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 235, - "character": 4 - } - ], - "parameters": [ - { - "id": 1308, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1774, - "name": "SignInAnonymouslyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1339, - "name": "signInWithIdToken", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 977, - "character": 4 - } - ], - "signatures": [ - { - "id": 1340, - "name": "signInWithIdToken", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use an ID token to sign in.\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API." - } - ] - }, - { - "tag": "@example", - "name": "Sign In using ID Token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithIdToken({\n provider: 'google',\n token: 'your-id-token'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign In using ID Token\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 977, - "character": 4 - } - ], - "parameters": [ - { - "id": 1341, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1824, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1315, - "name": "signInWithOAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 626, - "character": 4 - } - ], - "signatures": [ - { - "id": 1316, - "name": "signInWithOAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider with redirect\n- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter. This parameter defaults to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider with redirect", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n redirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with scopes and access provider tokens\nIf you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the " - }, - { - "kind": "code", - "text": "`scopes`" - }, - { - "kind": "text", - "text": " option takes in **a space-separated list** of scopes.\n\nBecause OAuth sign-in often includes redirects, you should register an " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback immediately after you create the Supabase client. This callback will listen for the presence of " - }, - { - "kind": "code", - "text": "`provider_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`provider_refresh_token`" - }, - { - "kind": "text", - "text": " properties on the " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with scopes and access provider tokens", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n\n// Call this on your Sign in with GitHub button to initiate OAuth\n// with GitHub with the requested elevated scopes.\nawait supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n scopes: 'repo gist notifications'\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 626, - "character": 4 - } - ], - "parameters": [ - { - "id": 1317, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1812, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1685, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1342, - "name": "signInWithOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1055, - "character": 4 - } - ], - "signatures": [ - { - "id": 1343, - "name": "signInWithOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " 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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email or phone number.\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\n- If the user doesn't exist, " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " will signup the user instead. To restrict this behavior, you can set " - }, - { - "kind": "code", - "text": "`shouldCreateUser`" - }, - { - "kind": "text", - "text": " in " - }, - { - "kind": "code", - "text": "`SignInWithPasswordlessCredentials.options`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ".\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\n- If you're using phone, you can configure whether you want the user to receive a OTP.\n- The magic link's destination URL is determined by the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": ".\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with email\nThe user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n email: 'example@email.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": null,\n \"session\": null\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with SMS OTP\nThe user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with SMS OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with WhatsApp OTP\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with WhatsApp OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n options: {\n channel:'whatsapp',\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1055, - "character": 4 - } - ], - "parameters": [ - { - "id": 1344, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1793, - "name": "SignInWithPasswordlessCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1671, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1548, - "name": "signInWithPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2497, - "character": 4 - } - ], - "signatures": [ - { - "id": 1549, - "name": "signInWithPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with a passkey. Handles the full WebAuthn ceremony:\n1. Fetches authentication challenge from server\n2. Prompts user via navigator.credentials.get()\n3. Verifies credential with server and creates session\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2497, - "character": 4 - } - ], - "parameters": [ - { - "id": 1550, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2444, - "name": "SignInWithPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1312, - "name": "signInWithPassword", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 546, - "character": 4 - } - ], - "signatures": [ - { - "id": 1313, - "name": "signInWithPassword", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user with an email and password or phone and password.\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\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email and password or a phone number and password." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email and password\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with phone and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n phone: '+13334445555',\n password: 'some-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nLog the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so fields like " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " aren't hidden. The " - }, - { - "kind": "code", - "text": "`error.code`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`'invalid_credentials'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'email_not_confirmed'`" - }, - { - "kind": "text", - "text": ") is often more useful for branching than " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": ", and the full object surfaces both." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\nif (error) {\n console.error(error)\n return\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 546, - "character": 4 - } - ], - "parameters": [ - { - "id": 1314, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1788, - "name": "SignInWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1680, - "name": "AuthTokenResponsePassword", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1348, - "name": "signInWithSSO", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1247, - "character": 4 - } - ], - "signatures": [ - { - "id": 1349, - "name": "signInWithSSO", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\n- If you've associated an email domain to the identity provider, you can use the " - }, - { - "kind": "code", - "text": "`domain`" - }, - { - "kind": "text", - "text": " property to start a sign-in flow.\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the " - }, - { - "kind": "code", - "text": "`providerId`" - }, - { - "kind": "text", - "text": " property. For example:\n - Mapping specific user email addresses with an identity provider.\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email domain", - "content": [ - { - "kind": "code", - "text": "```js\n // You can extract the user's email domain and use it to trigger the\n // authentication flow with the correct identity provider.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n domain: 'company.com'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with provider UUID", - "content": [ - { - "kind": "code", - "text": "```js\n // Useful when you need to map a user's sign in request according\n // to different rules that can't use email domains.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1247, - "character": 4 - } - ], - "parameters": [ - { - "id": 1350, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1924, - "name": "SignInWithSSO", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1698, - "name": "SSOResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1321, - "name": "signInWithWeb3", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 4 - } - ], - "signatures": [ - { - "id": 1322, - "name": "signInWithWeb3", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." - } - ], - "blockTags": [ - { - "tag": "@reference", - "content": [ - { - "kind": "text", - "text": "https://eips.ethereum.org/EIPS/eip-4361" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana or Ethereum (Window API)", - "content": [ - { - "kind": "code", - "text": "```js\n // uses window.ethereum for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n\n // uses window.solana for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Ethereum (Message and Signature)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n message: '',\n signature: '',\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Brave)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet: window.braveSolana\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Wallet Adapter)", - "content": [ - { - "kind": "code", - "text": "```jsx\n function SignInButton() {\n const wallet = useWallet()\n\n return (\n <>\n {wallet.connected ? (\n {\n supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet,\n })\n }}\n >\n Sign in with Solana\n \n ) : (\n \n )}\n \n )\n}\n\nfunction App() {\n const endpoint = clusterApiUrl('devnet')\n const wallets = useMemo(() => [], [])\n\n return (\n \n \n \n \n \n \n \n )\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 4 - } - ], - "parameters": [ - { - "id": 1323, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1885, - "name": "Web3Credentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1324, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1325, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 887, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1326, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1327, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 888, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1328, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 889, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1327, 1328] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 887, - "character": 14 - } - ] - } - } - }, - { - "id": 1329, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 891, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1325, 1329] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 58 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1330, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1331, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 893, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1332, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1333, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 894, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1334, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 895, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1333, 1334] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 893, - "character": 14 - } - ] - } - } - }, - { - "id": 1335, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 897, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1331, 1335] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 892, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1418, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 4 - } - ], - "signatures": [ - { - "id": 1419, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inside a browser context, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " - }, - { - "kind": "code", - "text": "`\"SIGNED_OUT\"`" - }, - { - "kind": "text", - "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " - }, - { - "kind": "code", - "text": "`auth.api.signOut(JWT: string)`" - }, - { - "kind": "text", - "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " - }, - { - "kind": "code", - "text": "`others`" - }, - { - "kind": "text", - "text": " scope, no " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event is fired!\n\n**Warning:** the default " - }, - { - "kind": "code", - "text": "`scope`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`'global'`" - }, - { - "kind": "text", - "text": ". This signs the user out of\n**every device they are currently signed in on**, not just the current\ntab/session. If you only want to sign the user out of the current session\n(the behavior most other auth libraries default to), pass\n" - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " explicitly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " uses the **global** scope, which signs out the user\n on every device they are signed in on (not just the current one). Pass\n " - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " to only sign out the current session. This is\n usually what apps want on a \"Sign out\" button, especially when users\n sign in from multiple devices and do not expect signing out of one to\n terminate the others.\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires." - } - ] - }, - { - "tag": "@example", - "name": "Sign out of every device (global – default)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out only the current session (recommended for most apps)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out of all other sessions, keep the current one", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 4 - } - ], - "parameters": [ - { - "id": 1420, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2121, - "name": "SignOut", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1421, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1422, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1971, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1422] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 40 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1309, - "name": "signUp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 413, - "character": 4 - } - ], - "signatures": [ - { - "id": 1310, - "name": "signUp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A logged-in session if the server has \"autoconfirm\" ON" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A user if the server has \"autoconfirm\" OFF" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\n- **Confirm email** determines if users need to confirm their email address after signing up.\n - If **Confirm email** is enabled, a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " is returned but " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " is null.\n - If **Confirm email** is disabled, both a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " and a " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " are returned.\n- When the user confirms their email address, they are redirected to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your " - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": " or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\n- If signUp() is called for an existing confirmed user:\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, " - }, - { - "kind": "code", - "text": "`User already registered`" - }, - { - "kind": "text", - "text": " is returned.\n- To fetch the currently logged-in user, refer to [" - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-getuser)." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with an email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign up with an email and password\n" - }, - { - "kind": "code", - "text": "```json\n// Some fields may be null if \"confirm email\" is enabled.\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (SMS)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'sms'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a phone number and password (whatsapp)\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (whatsapp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'whatsapp'\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with additional user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n data: {\n first_name: 'John',\n age: 27,\n }\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a redirect URL\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a redirect URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 413, - "character": 4 - } - ], - "parameters": [ - { - "id": 1311, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1780, - "name": "SignUpWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1502, - "name": "startAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2258, - "character": 4 - } - ], - "signatures": [ - { - "id": 1503, - "name": "startAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClientOptions#autoRefreshToken", - "target": 1615 - }, - { - "kind": "text", - "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "#stopAutoRefresh" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- To give this hint to the application, you should be calling this method when the app is in focus and calling " - }, - { - "kind": "code", - "text": "`supabase.auth.stopAutoRefresh()`" - }, - { - "kind": "text", - "text": " when it's out of focus." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2258, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1504, - "name": "stopAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2289, - "character": 4 - } - ], - "signatures": [ - { - "id": 1505, - "name": "stopAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#startAutoRefresh" - }, - { - "kind": "text", - "text": " for more details." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2289, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1481, - "name": "unlinkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 4 - } - ], - "signatures": [ - { - "id": 1482, - "name": "unlinkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`unlinkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- The user must have at least 2 identities in order to unlink an identity.\n- The identity to be unlinked must belong to the user." - } - ] - }, - { - "tag": "@example", - "name": "Unlink an identity", - "content": [ - { - "kind": "code", - "text": "```js\n// retrieve all identities linked to a user\nconst identities = await supabase.auth.getUserIdentities()\n\n// find the google identity\nconst googleIdentity = identities.find(\n identity => identity.provider === 'google'\n)\n\n// unlink the google identity\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 4 - } - ], - "parameters": [ - { - "id": 1483, - "name": "identity", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1484, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1485, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2171, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1486, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 1487, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2172, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1485, 1487] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 52 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1488, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1489, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2174, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1490, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2175, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1489, 1490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2173, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1381, - "name": "updateUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 4 - } - ], - "signatures": [ - { - "id": 1382, - "name": "updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates user data for a logged in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, email updates sends a confirmation link to both the user's current and new email.\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers)." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\nSends a \"Confirm Email Change\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email)." - } - ] - }, - { - "tag": "@example", - "name": "Update the email for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n email: 'new@email.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"new_email\": \"new@email.com\",\n \"email_change_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the phone number for an authenticated user\nSends a one-time password (OTP) to the new phone number." - } - ] - }, - { - "tag": "@example", - "name": "Update the phone number for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n phone: '123456789'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update the password for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's metadata\nUpdates the user's custom metadata.\n\n**Note**: The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column in your Supabase database. When calling " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": ", the data will be available as " - }, - { - "kind": "code", - "text": "`user.user_metadata`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n data: { hello: 'world' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's password with a nonce\nIf **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's password with a nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password',\n nonce: '123456'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 4 - } - ], - "parameters": [ - { - "id": 1383, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 1384, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1386, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1645, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1386] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 53 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1345, - "name": "verifyOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1193, - "character": 4 - } - ], - "signatures": [ - { - "id": 1346, - "name": "verifyOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " method takes in different verification types.\n- If a phone number is used, the type can either be:\n 1. " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new phone number during a phone number update process.\n- If an email address is used, the type can be one of the following (note: " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": " types are deprecated):\n 1. " - }, - { - "kind": "code", - "text": "`email`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent for account recovery, typically after a password reset request.\n 3. " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent as part of an invitation to join a project or organization.\n 4. " - }, - { - "kind": "code", - "text": "`email_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new email address during an email update process.\n- The verification type used should be determined based on the corresponding auth method called before " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " to sign up / sign-in a user.\n- The " - }, - { - "kind": "code", - "text": "`TokenHash`" - }, - { - "kind": "text", - "text": " is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details." - } - ] - }, - { - "tag": "@example", - "name": "Verify Signup One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify Signup One-Time Password (OTP)\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify SMS One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify Email Auth (Token Hash)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1193, - "character": 4 - } - ], - "parameters": [ - { - "id": 1347, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1886, - "name": "VerifyOtpParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1223] - }, - { - "title": "Properties", - "children": [ - 1260, 1227, 1254, 1255, 1245, 1291, 1262, 1290, 1277, 1232, 1275, 1271, 1261, 1285, - 1286, 1289, 1292, 1293, 1249, 1228, 1229, 1230, 1287, 1246, 1259, 1253, 1247, 1231, - 1276, 1288, 1270, 1248, 1256 - ] - }, - { - "title": "Accessors", - "children": [1233, 1241] - }, - { - "title": "Methods", - "children": [ - 1410, 1399, 1423, 1387, 1506, 1318, 1525, 1357, 1377, 1464, 1303, 1298, 1474, 1428, - 1351, 1405, 1551, 1354, 1450, 1393, 1306, 1339, 1315, 1342, 1548, 1312, 1348, 1321, - 1418, 1309, 1502, 1504, 1481, 1381, 1345 - ] - } - ], - "categories": [ - { - "title": "Auth", - "children": [ - 1506, 1318, 1525, 1357, 1377, 1464, 1303, 1351, 1405, 1551, 1354, 1450, 1393, 1306, - 1339, 1315, 1342, 1548, 1312, 1348, 1321, 1418, 1309, 1502, 1504, 1481, 1381, 1345 - ] - }, - { - "title": "Other", - "children": [ - 1223, 1260, 1227, 1254, 1255, 1245, 1291, 1262, 1290, 1277, 1232, 1275, 1271, 1261, - 1285, 1286, 1289, 1292, 1293, 1249, 1228, 1229, 1230, 1287, 1246, 1259, 1253, 1247, - 1231, 1276, 1288, 1270, 1248, 1256, 1233, 1241, 1410, 1399, 1423, 1387, 1298, 1474, - 1428 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 6, - "character": 21 - } - ] - }, - { - "id": 1571, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client doesn't call " - }, - { - "kind": "code", - "text": "`navigator.locks`" - }, - { - "kind": "text", - "text": ", so this error\nnever originates from " - }, - { - "kind": "code", - "text": "`supabase.auth.*`" - }, - { - "kind": "text", - "text": " calls. Direct callers of\n" - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " still receive it on acquire timeout." - } - ] - } - ] - }, - "children": [ - { - "id": 1572, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 29, - "character": 4 - } - ], - "signatures": [ - { - "id": 1573, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 29, - "character": 4 - } - ], - "parameters": [ - { - "id": 1574, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1571, - "name": "NavigatorLockAcquireTimeoutError", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - }, - { - "id": 1575, - "name": "isAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 28, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": true - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.isAcquireTimeout" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1572] - }, - { - "title": "Properties", - "children": [1575] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 36, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError" - }, - "name": "LockAcquireTimeoutError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 57, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 58, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 59, - "name": "PostgrestBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 60, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 61, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 62, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "parameters": [ - { - "id": 63, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 69, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 72, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 74, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 75, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 76, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 77, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 78, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 79, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 67, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 80, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 65, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 83, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 68, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 81, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 70, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 71, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 66, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 82, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [69, 72, 67, 80, 65, 83, 68, 81, 70, 71, 66, 82] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 88, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 91, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 92, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 93, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 94, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 95, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 96, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 97, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 98, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 86, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 99, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 84, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 102, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 87, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 100, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 89, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 90, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 85, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 101, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 130, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 131, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 132, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 133, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 135, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [135] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 137, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [137] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 111, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 112, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 113, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 127, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 824, - "character": 2 - } - ], - "signatures": [ - { - "id": 128, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 824, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 129, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 129, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 107, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 108, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 109, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 110, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 105, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 114, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 115, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 116, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 117, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 118, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 119, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 120, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 121, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 122, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 124, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 125, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - }, - { - "id": 103, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 104, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [58] - }, - { - "title": "Properties", - "children": [88, 91, 86, 99, 84, 102, 87, 100, 89, 90, 85, 101] - }, - { - "title": "Methods", - "children": [130, 111, 127, 107, 105, 114, 103] - } - ], - "categories": [ - { - "title": "Database", - "children": [58, 130, 127, 107, 105, 103] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [111] - }, - { - "title": "Other", - "children": [88, 91, 86, 99, 84, 102, 87, 100, 89, 90, 85, 101, 114] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 674, - "character": 23 - } - ], - "typeParameters": [ - { - "id": 138, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 139, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 140, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 559, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - }, - { - "id": 830, - "name": "PostgrestError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error format\n\nReturned by every PostgREST request that fails. When something fails, the\nsingle most useful field is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — Postgres often returns the\nactionable fix there, not in " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": ". Always log the full object (e.g.\n" - }, - { - "kind": "code", - "text": "`console.error(error)`" - }, - { - "kind": "text", - "text": "); logging only " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": " hides the hint.\n\nRead the fields in roughly this order of usefulness:\n\n- " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — actionable guidance from the database when available. For\n permission-denied errors (" - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "), this is the literal SQL to fix the\n problem, e.g.\n " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.users TO anon;\"`" - }, - { - "kind": "text", - "text": ".\n Missing column? " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " suggests the column you probably meant. Whenever\n Postgres knows the fix, it puts it in " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": " — stable error code from PostgREST (e.g. " - }, - { - "kind": "code", - "text": "`PGRST301`" - }, - { - "kind": "text", - "text": ") or Postgres\n (e.g. " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "). Branch on this rather than on " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " text.\n- " - }, - { - "kind": "code", - "text": "`details`" - }, - { - "kind": "text", - "text": " — extra context, often the offending value, key, or row.\n- " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " — human-readable summary. Useful in UI strings; less useful\n for debugging.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", - "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" - } - ] - }, - "children": [ - { - "id": 831, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 832, - "name": "PostgrestError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport PostgrestError from '@supabase/postgrest-js'\n\nthrow new PostgrestError({\n message: 'Row level security prevented the request',\n details: 'RLS denied the insert',\n hint: 'Check your policies',\n code: 'PGRST301',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 2 - } - ], - "parameters": [ - { - "id": 833, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 834, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 838, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 836, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 837, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 46, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 835, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [838, 836, 837, 835] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 830, - "name": "PostgrestError", - "package": "@supabase/postgrest-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 841, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 839, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 27, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 840, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 28, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 842, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 2 - } - ], - "signatures": [ - { - "id": 843, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 844, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 849, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 54, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 847, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 848, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 846, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 51, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 845, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 50, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [849, 847, 848, 846, 845] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 12 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [831] - }, - { - "title": "Properties", - "children": [841, 839, 840] - }, - { - "title": "Methods", - "children": [842] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 26, - "character": 14 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 141, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 142, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 143, - "name": "PostgrestFilterBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 144, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 145, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 146, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 147, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 148, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 149, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 150, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 151, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 157, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 160, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 162, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 163, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 164, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 165, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 166, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 167, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 155, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 168, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 153, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 171, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 156, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 169, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 158, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 159, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 154, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 170, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 157, 160, 155, 168, 153, 171, 156, 169, 158, 159, 154, 170 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 561, - "name": "PostgrestTransformBuilder.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 560, - "name": "PostgrestTransformBuilder.constructor" - } - }, - { - "id": 506, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 676, - "name": "PostgrestTransformBuilder.body" - } - }, - { - "id": 509, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 511, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 512, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 513, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 514, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 515, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 516, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 679, - "name": "PostgrestTransformBuilder.fetch" - } - }, - { - "id": 504, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 674, - "name": "PostgrestTransformBuilder.headers" - } - }, - { - "id": 517, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 687, - "name": "PostgrestTransformBuilder.isMaybeSingle" - } - }, - { - "id": 502, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 672, - "name": "PostgrestTransformBuilder.method" - } - }, - { - "id": 520, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 690, - "name": "PostgrestTransformBuilder.retryEnabled" - } - }, - { - "id": 505, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 675, - "name": "PostgrestTransformBuilder.schema" - } - }, - { - "id": 518, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 688, - "name": "PostgrestTransformBuilder.shouldStripNulls" - } - }, - { - "id": 507, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 677, - "name": "PostgrestTransformBuilder.shouldThrowOnError" - } - }, - { - "id": 508, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 678, - "name": "PostgrestTransformBuilder.signal" - } - }, - { - "id": 503, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 673, - "name": "PostgrestTransformBuilder.url" - } - }, - { - "id": 519, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 689, - "name": "PostgrestTransformBuilder.urlLengthLimit" - } - }, - { - "id": 471, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "signatures": [ - { - "id": 472, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "parameters": [ - { - "id": 473, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 642, - "name": "PostgrestTransformBuilder.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 641, - "name": "PostgrestTransformBuilder.abortSignal" - } - }, - { - "id": 310, - "name": "containedBy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1879, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1880, - "character": 2 - } - ], - "signatures": [ - { - "id": 311, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1879, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 312, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 313, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 312, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 314, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 312, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 315, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1880, - "character": 2 - } - ], - "parameters": [ - { - "id": 316, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 317, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 302, - "name": "contains", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1877, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1878, - "character": 2 - } - ], - "signatures": [ - { - "id": 303, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1877, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 304, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 305, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 304, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 306, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 304, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 307, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1878, - "character": 2 - } - ], - "parameters": [ - { - "id": 308, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 309, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 480, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "signatures": [ - { - "id": 481, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 651, - "name": "PostgrestTransformBuilder.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 650, - "name": "PostgrestTransformBuilder.csv" - } - }, - { - "id": 172, - "name": "eq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1731, - "character": 2 - } - ], - "signatures": [ - { - "id": 173, - "name": "eq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nTo check if the value of " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL, you should use " - }, - { - "kind": "code", - "text": "`.is()`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1731, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 174, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 175, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 174, - "typeArguments": [ - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 174, - "typeArguments": [ - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 176, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 484, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "signatures": [ - { - "id": 485, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "parameters": [ - { - "id": 486, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 487, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 488, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1608, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 491, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1611, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 493, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1613, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 490, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1610, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 489, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1609, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 492, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1612, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [488, 491, 493, 490, 489, 492] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1607, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 655, - "name": "PostgrestTransformBuilder.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 654, - "name": "PostgrestTransformBuilder.explain" - } - }, - { - "id": 410, - "name": "filter", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2064, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2065, - "character": 2 - } - ], - "signatures": [ - { - "id": 411, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2064, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 412, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 413, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 412, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 414, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - }, - { - "type": "literal", - "value": "not.match" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.isdistinct" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - }, - { - "type": "literal", - "value": "not.imatch" - } - ] - } - }, - { - "id": 415, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 416, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2065, - "character": 2 - } - ], - "parameters": [ - { - "id": 417, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 418, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 419, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 482, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "signatures": [ - { - "id": 483, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 653, - "name": "PostgrestTransformBuilder.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 652, - "name": "PostgrestTransformBuilder.geojson" - } - }, - { - "id": 183, - "name": "gt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1784, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1785, - "character": 2 - } - ], - "signatures": [ - { - "id": 184, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1784, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 185, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 186, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 185, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 187, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 185, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 188, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1785, - "character": 2 - } - ], - "parameters": [ - { - "id": 189, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 190, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 191, - "name": "gte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1786, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1787, - "character": 2 - } - ], - "signatures": [ - { - "id": 192, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1786, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 193, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 194, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 193, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 195, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 193, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 196, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1787, - "character": 2 - } - ], - "parameters": [ - { - "id": 197, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 198, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 239, - "name": "ilike", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1798, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1799, - "character": 2 - } - ], - "signatures": [ - { - "id": 240, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1798, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 241, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 242, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 241, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 243, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 244, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1799, - "character": 2 - } - ], - "parameters": [ - { - "id": 245, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 246, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 247, - "name": "ilikeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1800, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1801, - "character": 2 - } - ], - "signatures": [ - { - "id": 248, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1800, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 249, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 250, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 249, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 251, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 252, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1801, - "character": 2 - } - ], - "parameters": [ - { - "id": 253, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 254, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 255, - "name": "ilikeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1802, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1803, - "character": 2 - } - ], - "signatures": [ - { - "id": 256, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1802, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 257, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 258, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 257, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 259, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 260, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1803, - "character": 2 - } - ], - "parameters": [ - { - "id": 261, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 262, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 292, - "name": "in", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1869, - "character": 2 - } - ], - "signatures": [ - { - "id": 293, - "name": "in", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .in('name', ['Leia', 'Han'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1869, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 294, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 295, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 296, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 279, - "name": "is", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1808, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1809, - "character": 2 - } - ], - "signatures": [ - { - "id": 280, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1808, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 281, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 282, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 281, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 283, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 281, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 284, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1809, - "character": 2 - } - ], - "parameters": [ - { - "id": 285, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 286, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 287, - "name": "isDistinct", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1820, - "character": 2 - } - ], - "signatures": [ - { - "id": 288, - "name": "isDistinct", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS DISTINCT FROM " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nUnlike " - }, - { - "kind": "code", - "text": "`.neq()`" - }, - { - "kind": "text", - "text": ", this treats " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " as a comparable value. Two " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " values\nare considered equal (not distinct), and comparing " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " with any non-NULL\nvalue returns true (distinct)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1820, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 289, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 290, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 291, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 215, - "name": "like", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1792, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1793, - "character": 2 - } - ], - "signatures": [ - { - "id": 216, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1792, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 217, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 218, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 217, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 219, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 220, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1793, - "character": 2 - } - ], - "parameters": [ - { - "id": 221, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 222, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 223, - "name": "likeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1794, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1795, - "character": 2 - } - ], - "signatures": [ - { - "id": 224, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1794, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 225, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 226, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 227, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 228, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1795, - "character": 2 - } - ], - "parameters": [ - { - "id": 229, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 230, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 231, - "name": "likeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1796, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1797, - "character": 2 - } - ], - "signatures": [ - { - "id": 232, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1796, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 233, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 234, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 233, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 235, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 236, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1797, - "character": 2 - } - ], - "parameters": [ - { - "id": 237, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 238, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 456, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "signatures": [ - { - "id": 457, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "parameters": [ - { - "id": 458, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 459, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 461, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1243, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 462, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1244, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [461, 462] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1242, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 627, - "name": "PostgrestTransformBuilder.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 626, - "name": "PostgrestTransformBuilder.limit" - } - }, - { - "id": 199, - "name": "lt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1788, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1789, - "character": 2 - } - ], - "signatures": [ - { - "id": 200, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1788, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 201, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 202, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 201, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 203, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 201, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 204, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1789, - "character": 2 - } - ], - "parameters": [ - { - "id": 205, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 206, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 207, - "name": "lte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1790, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1791, - "character": 2 - } - ], - "signatures": [ - { - "id": 208, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1790, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 209, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 210, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 209, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 211, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 209, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 212, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1791, - "character": 2 - } - ], - "parameters": [ - { - "id": 213, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 382, - "name": "match", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1901, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1902, - "character": 2 - } - ], - "signatures": [ - { - "id": 383, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1901, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 384, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 385, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "reference", - "target": 384, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 384, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 386, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1902, - "character": 2 - } - ], - "parameters": [ - { - "id": 387, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 499, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "signatures": [ - { - "id": 500, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "parameters": [ - { - "id": 501, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 670, - "name": "PostgrestTransformBuilder.maxAffected" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 669, - "name": "PostgrestTransformBuilder.maxAffected" - } - }, - { - "id": 477, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "signatures": [ - { - "id": 478, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 479, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 479, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 648, - "name": "PostgrestTransformBuilder.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 647, - "name": "PostgrestTransformBuilder.maybeSingle" - } - }, - { - "id": 178, - "name": "neq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1783, - "character": 2 - } - ], - "signatures": [ - { - "id": 179, - "name": "neq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is not equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nThis filter does not include rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": ". To match null\nvalues, use " - }, - { - "kind": "code", - "text": "`.is(column, null)`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .neq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1783, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 180, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 181, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 180, - "typeArguments": [ - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 180, - "typeArguments": [ - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 182, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 388, - "name": "not", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1903, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1904, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1905, - "character": 2 - } - ], - "signatures": [ - { - "id": 389, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1903, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 390, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 391, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 392, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "is" - } - }, - { - "id": 393, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": null - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NonNullableColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullableColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NarrowResultColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NarrowResultColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 394, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1904, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 395, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 396, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 395, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 397, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 398, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 395, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 399, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1905, - "character": 2 - } - ], - "parameters": [ - { - "id": 400, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 401, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 402, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 297, - "name": "notIn", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1876, - "character": 2 - } - ], - "signatures": [ - { - "id": 298, - "name": "notIn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NOT included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1876, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 299, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 300, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 301, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 403, - "name": "or", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2057, - "character": 2 - } - ], - "signatures": [ - { - "id": 404, - "name": "or", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`filters`" - }, - { - "kind": "text", - "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " - }, - { - "kind": "code", - "text": "`.or()`" - }, - { - "kind": "text", - "text": " filter across multiple tables." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.or('id.in.(5,6,7), arraycol.cs.{\"a\",\"b\"}') // Use `()` for `in` filter, `{}` for array values and `cs` for `contains()`.\n.or('id.in.(5,6,7), arraycol.cd.{\"a\",\"b\"}') // Use `cd` for `containedBy()`\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.eq.2,name.eq.Han')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n },\n {\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` with `and`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` on referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2057, - "character": 2 - } - ], - "parameters": [ - { - "id": 405, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filters to use, following PostgREST syntax" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 406, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 407, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 408, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " instead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2061, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 409, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to filter on referenced tables\ninstead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2062, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [408, 409] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2060, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 425, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 427, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 428, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 427, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 429, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 430, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 431, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 432, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1115, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 433, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [431, 432, 433] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 596, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 434, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - } - ], - "parameters": [ - { - "id": 435, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 436, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 437, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 438, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1119, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 439, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 440, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1121, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [438, 439, 440] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 604, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 441, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 442, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 443, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 442, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 444, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 446, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 448, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1129, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 447, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1128, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [446, 448, 447] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 611, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 449, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "parameters": [ - { - "id": 450, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 455, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 454, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [453, 455, 454] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 619, - "name": "PostgrestTransformBuilder.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 595, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 358, - "name": "overlaps", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1891, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1892, - "character": 2 - } - ], - "signatures": [ - { - "id": 359, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1891, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 360, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 361, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 360, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 362, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 360, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 363, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1892, - "character": 2 - } - ], - "parameters": [ - { - "id": 364, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 365, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 544, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 545, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 546, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 547, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 548, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 549, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [549] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 550, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 551, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [551] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 715, - "name": "PostgrestTransformBuilder.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 714, - "name": "PostgrestTransformBuilder.overrideTypes" - } - }, - { - "id": 463, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "signatures": [ - { - "id": 464, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "parameters": [ - { - "id": 465, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 466, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 467, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 469, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 470, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [469, 470] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 634, - "name": "PostgrestTransformBuilder.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 633, - "name": "PostgrestTransformBuilder.range" - } - }, - { - "id": 350, - "name": "rangeAdjacent", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1889, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1890, - "character": 2 - } - ], - "signatures": [ - { - "id": 351, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1889, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 352, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 353, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 352, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 354, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 355, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1890, - "character": 2 - } - ], - "parameters": [ - { - "id": 356, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 357, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 318, - "name": "rangeGt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1881, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1882, - "character": 2 - } - ], - "signatures": [ - { - "id": 319, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1881, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 320, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 321, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 320, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 322, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 323, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1882, - "character": 2 - } - ], - "parameters": [ - { - "id": 324, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 325, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 326, - "name": "rangeGte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1883, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1884, - "character": 2 - } - ], - "signatures": [ - { - "id": 327, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1883, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 328, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 329, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 328, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 330, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 331, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1884, - "character": 2 - } - ], - "parameters": [ - { - "id": 332, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 333, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 334, - "name": "rangeLt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1885, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1886, - "character": 2 - } - ], - "signatures": [ - { - "id": 335, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1885, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 336, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 337, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 336, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 338, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 339, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1886, - "character": 2 - } - ], - "parameters": [ - { - "id": 340, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 341, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 342, - "name": "rangeLte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1887, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1888, - "character": 2 - } - ], - "signatures": [ - { - "id": 343, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1887, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 344, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 345, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 346, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 347, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1888, - "character": 2 - } - ], - "parameters": [ - { - "id": 348, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 349, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 271, - "name": "regexIMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1806, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1807, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1806, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 273, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 274, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 273, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 275, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 276, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1807, - "character": 2 - } - ], - "parameters": [ - { - "id": 277, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 278, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 263, - "name": "regexMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1804, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1805, - "character": 2 - } - ], - "signatures": [ - { - "id": 264, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1804, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 265, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 266, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 265, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 267, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 268, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1805, - "character": 2 - } - ], - "parameters": [ - { - "id": 269, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 270, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 529, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 530, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 531, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 700, - "name": "PostgrestTransformBuilder.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 699, - "name": "PostgrestTransformBuilder.retry" - } - }, - { - "id": 496, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "signatures": [ - { - "id": 497, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 498, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 498, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 667, - "name": "PostgrestTransformBuilder.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 666, - "name": "PostgrestTransformBuilder.returns" - } - }, - { - "id": 494, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "signatures": [ - { - "id": 495, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 665, - "name": "PostgrestTransformBuilder.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 664, - "name": "PostgrestTransformBuilder.rollback" - } - }, - { - "id": 420, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "signatures": [ - { - "id": 421, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 422, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 423, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 424, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 591, - "name": "PostgrestTransformBuilder.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 590, - "name": "PostgrestTransformBuilder.select" - } - }, - { - "id": 525, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 526, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 527, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 528, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 696, - "name": "PostgrestTransformBuilder.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 695, - "name": "PostgrestTransformBuilder.setHeader" - } - }, - { - "id": 474, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "signatures": [ - { - "id": 475, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 476, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 476, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 645, - "name": "PostgrestTransformBuilder.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 644, - "name": "PostgrestTransformBuilder.single" - } - }, - { - "id": 523, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 524, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 694, - "name": "PostgrestTransformBuilder.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 693, - "name": "PostgrestTransformBuilder.stripNulls" - } - }, - { - "id": 366, - "name": "textSearch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 2 - } - ], - "signatures": [ - { - "id": 367, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 368, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 369, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 368, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 370, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 371, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 372, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 373, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1894, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 374, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1895, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [373, 374] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 97 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 375, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 2 - } - ], - "parameters": [ - { - "id": 376, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 377, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 378, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 380, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1898, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 381, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1899, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [380, 381] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 54 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 532, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 533, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 534, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 535, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 536, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 538, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 539, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 540, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 541, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 542, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 543, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 703, - "name": "PostgrestTransformBuilder.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 702, - "name": "PostgrestTransformBuilder.then" - } - }, - { - "id": 521, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 522, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 692, - "name": "PostgrestTransformBuilder.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 691, - "name": "PostgrestTransformBuilder.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [142] - }, - { - "title": "Properties", - "children": [506, 509, 504, 517, 502, 520, 505, 518, 507, 508, 503, 519] - }, - { - "title": "Methods", - "children": [ - 471, 310, 302, 480, 172, 484, 410, 482, 183, 191, 239, 247, 255, 292, 279, 287, 215, - 223, 231, 456, 199, 207, 382, 499, 477, 178, 388, 297, 403, 425, 358, 544, 463, 350, - 318, 326, 334, 342, 271, 263, 529, 496, 494, 420, 525, 474, 523, 366, 532, 521 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 142, 471, 480, 172, 484, 482, 292, 456, 499, 477, 178, 403, 544, 463, 496, 494, 420, - 525, 474, 523, 521 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [529] - }, - { - "title": "Other", - "children": [ - 506, 509, 504, 517, 502, 520, 505, 518, 507, 508, 503, 519, 310, 302, 410, 183, 191, - 239, 247, 255, 279, 287, 215, 223, 231, 199, 207, 382, 388, 297, 425, 358, 350, 318, - 326, 334, 342, 271, 263, 366, 532 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1684, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 552, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 553, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 554, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 555, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 556, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 557, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 558, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 729, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 730, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2116, - "character": 2 - } - ], - "signatures": [ - { - "id": 731, - "name": "PostgrestQueryBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a query builder scoped to a Postgres table or view." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst query = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: { apikey: 'your-publishable-key' }, retry: true }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2116, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 732, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 733, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 734, - "name": "Relation$1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 735, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 736, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 737, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 738, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2070, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [738] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 216 - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "parameters": [ - { - "id": 739, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL for the query" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 740, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 741, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 744, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2125, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 747, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 748, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 749, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 750, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 751, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 742, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2123, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 753, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable automatic retries for transient errors (default: true)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 743, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to use" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2124, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 752, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length before warning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2126, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [744, 742, 753, 743, 752] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2122, - "character": 5 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 758, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2076, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 759, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 760, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 761, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 762, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 763, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 764, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 765, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 755, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2073, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 767, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\nWhen enabled, idempotent requests (GET/HEAD/OPTIONS) that fail with network\nerrors or HTTP 503/520 responses are automatically retried with exponential\nbackoff (1s, 2s, 4s, up to 3 attempts). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " when not specified." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2084, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 756, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2074, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 757, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2075, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 754, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2072, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 766, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2077, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 817, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3594, - "character": 2 - } - ], - "signatures": [ - { - "id": 818, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\n- If you use " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " with filters and you have\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\n rows visible through " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": " policies are deleted. Note that by default\n no rows are visible, so you need at least one " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": "/" - }, - { - "kind": "code", - "text": "`ALL`" - }, - { - "kind": "text", - "text": " policy that\n makes the rows visible.\n- When using " - }, - { - "kind": "code", - "text": "`delete().in()`" - }, - { - "kind": "text", - "text": ", specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal." - } - ] - }, - { - "tag": "@example", - "name": "Delete a single record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete multiple records", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .in('id', [1, 2, 3])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3594, - "character": 2 - } - ], - "parameters": [ - { - "id": 819, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 820, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 821, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count deleted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3597, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 822, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [821] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3596, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 779, - "name": "insert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3063, - "character": 2 - } - ], - "signatures": [ - { - "id": 780, - "name": "insert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Create a record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk create\nA bulk create operation is handled in a single transaction.\nIf any of the inserts fail, none of the rows are inserted." - } - ] - }, - { - "tag": "@example", - "name": "Bulk create", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert([\n { id: 1, name: 'Mordor' },\n { id: 1, name: 'The Shire' },\n ])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (id)=(1) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"countries_pkey\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3063, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 781, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 782, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 783, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 784, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3066, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [784] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3065, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 781, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 785, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 786, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3068, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [786] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3067, - "character": 85 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 781, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 787, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 788, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 789, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count inserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3073, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 791, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3074, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [789, 791] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3072, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 769, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 2 - } - ], - "signatures": [ - { - "id": 770, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT query on the table or view." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "When using " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`.range()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`.limit()`" - }, - { - "kind": "text", - "text": ", the returned " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " is the total number of rows\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\n\n- By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use " - }, - { - "kind": "code", - "text": "`range()`" - }, - { - "kind": "text", - "text": " queries to paginate through your data.\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Filters](/docs/reference/javascript/using-filters)\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\n- " - }, - { - "kind": "code", - "text": "`apikey`" - }, - { - "kind": "text", - "text": " is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Getting your data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Harry'),\n (2, 'Frodo'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Harry\"\n },\n {\n \"id\": 2,\n \"name\": \"Frodo\"\n },\n {\n \"id\": 3,\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nThe most useful field on a Postgres error is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (" - }, - { - "kind": "code", - "text": "`code: '42501'`" - }, - { - "kind": "text", - "text": ") arrives with a " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " like " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\"`" - }, - { - "kind": "text", - "text": ". Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so the hint isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('characters').select()\nif (error) {\n // Logs the full error: message, code, details, and hint.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"42501\",\n \"details\": null,\n \"hint\": \"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\",\n \"message\": \"permission denied for table characters\"\n },\n \"status\": 401,\n \"statusText\": \"Unauthorized\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Selecting specific columns", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Frodo'),\n (2, 'Harry'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Frodo\"\n },\n {\n \"name\": \"Harry\"\n },\n {\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\nIf your database has foreign key relationships, you can query related tables too." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\nIf your table name contains spaces, you must use double quotes in the " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " statement to reference the table." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables with spaces in their names", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral sections')\n .select(`\n name,\n \"musical instruments\" (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n \"orchestral sections\" (id int8 primary key, name text);\ncreate table\n \"musical instruments\" (\n id int8 primary key,\n section_id int8 not null references \"orchestral sections\",\n name text\n );\n\ninsert into\n \"orchestral sections\" (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n \"musical instruments\" (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"musical instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"musical instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\nIf you're in a situation where your tables are **NOT** directly\nrelated, but instead are joined by a _join table_, you can still use\nthe " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " method to query the related data. The join table needs\nto have the foreign keys as part of its composite primary key." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables through a join table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n name,\n teams (\n name\n )\n `)\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n -- both foreign keys must be part of a composite primary key\n primary key (user_id, team_id)\n );\n\ninsert into\n users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Kiran\",\n \"teams\": [\n {\n \"name\": \"Green\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Evan\",\n \"teams\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\nIf you need to query the same referenced table twice, use the name of the\njoined column to identify which join to use. You can also give each\ncolumn an alias." - } - ] - }, - { - "tag": "@example", - "name": "Query the same referenced table multiple times", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:sender_id(name),\n to:receiver_id(name)\n `)\n\n// To infer types, use the name of the table (in this case `users`) and\n// the name of the foreign key constraint.\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:users!messages_sender_id_fkey(name),\n to:users!messages_receiver_id_fkey(name)\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\n" - }, - { - "kind": "code", - "text": "```sql\n create table\n users (id int8 primary key, name text);\n\n create table\n messages (\n sender_id int8 not null references users,\n receiver_id int8 not null references users,\n content text\n );\n\n insert into\n users (id, name)\n values\n (1, 'Kiran'),\n (2, 'Evan');\n\n insert into\n messages (sender_id, receiver_id, content)\n values\n (1, 2, '👋');\n ```" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleResponse Query the same referenced table multiple times\n```" - }, - { - "kind": "text", - "text": "json\n{\n \"data\": [\n {\n \"content\": \"👋\",\n \"from\": {\n \"name\": \"Kiran\"\n },\n \"to\": {\n \"name\": \"Evan\"\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleDescription Query nested foreign tables through a join table\nYou can use the result of a joined table to gather data in\nanother foreign table. With multiple references to the same foreign\ntable you must specify the column on which to conduct the join.\n\n@example Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "ts\n const { data, error } = await supabase\n .from('games')\n .select(" - }, - { - "kind": "code", - "text": "`\n game_id:id,\n away_team:teams!games_away_team_fkey (\n users (\n id,\n name\n )\n )\n `" - }, - { - "kind": "text", - "text": ")\n\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleSql Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "sql\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n\n primary key (user_id, team_id)\n );\ncreate table\n games (\n id int8 primary key,\n home_team int8 not null references teams,\n away_team int8 not null references teams,\n name text\n );\n\ninsert into users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\ninsert into\n games (id, home_team, away_team, name)\nvalues\n (1, 1, 2, 'Green vs Blue'),\n (2, 2, 1, 'Blue vs Green');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query nested foreign tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"game_id\": 1,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n },\n {\n \"id\": 2,\n \"name\": \"Evan\"\n }\n ]\n }\n },\n {\n \"game_id\": 2,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n }\n ]\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\nIf the filter on a referenced table's column is not satisfied, the referenced\ntable returns " - }, - { - "kind": "code", - "text": "`[]`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " but the parent table is not filtered out.\nIf you want to filter out the parent table rows, use the " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " hint" - } - ] - }, - { - "tag": "@example", - "name": "Filtering through referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections(*)')\n .eq('orchestral_sections.name', 'percussion')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": null\n },\n {\n \"name\": \"violin\",\n \"orchestral_sections\": null\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\nYou can get the number of rows in a related table by using the\n**count** property." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with count", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`*, instruments(count)`)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table characters (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('strings') returning id\n)\ninsert into instruments (name, section_id) values\n('violin', (select id from section)),\n('viola', (select id from section)),\n('cello', (select id from section)),\n('double bass', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```json\n[\n {\n \"id\": \"693694e7-d993-4360-a6d7-6294e325d9b6\",\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"count\": 4\n }\n ]\n }\n]\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying with count option\nYou can get the number of rows by using the\n[count](/docs/reference/javascript/select#parameters) option." - } - ] - }, - { - "tag": "@example", - "name": "Querying with count option", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { count, error } = await supabase\n .from('characters')\n .select('*', { count: 'exact', head: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"count\": 3,\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\nYou can select and filter data inside of\n[JSON](/docs/guides/database/json) columns. Postgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nquerying JSON data." - } - ] - }, - { - "tag": "@example", - "name": "Querying JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n id, name,\n address->city\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Frodo', '{\"city\":\"Hobbiton\"}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Frodo\",\n \"city\": \"Hobbiton\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\nIf you don't want to return the referenced table contents, you can leave the parenthesis empty.\nLike " - }, - { - "kind": "code", - "text": "`.select('name, orchestral_sections!inner()')`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with inner join", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections!inner(name)')\n .eq('orchestral_sections.name', 'woodwinds')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table instruments (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('woodwinds') returning id\n)\ninsert into instruments (name, section_id) values\n('flute', (select id from section)),\n('clarinet', (select id from section)),\n('bassoon', (select id from section)),\n('piccolo', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\nIn addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas)." - } - ] - }, - { - "tag": "@example", - "name": "Switching schemas per query", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .schema('myschema')\n .from('mytable')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```sql\ncreate schema myschema;\n\ncreate table myschema.mytable (\n id uuid primary key default gen_random_uuid(),\n data text\n);\n\ninsert into myschema.mytable (data) values ('mydata');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": \"4162e008-27b0-4c0f-82dc-ccaeee9a624d\",\n \"data\": \"mydata\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 771, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 772, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 771, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 773, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " - }, - { - "kind": "code", - "text": "`customName:columnName`" - } - ] - }, - "type": { - "type": "reference", - "target": 771, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 774, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 777, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows in the table or view.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2941, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 778, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 776, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2940, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [777, 776] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 165 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 772, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "GET" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 807, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3458, - "character": 2 - } - ], - "signatures": [ - { - "id": 808, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update." - } - ] - }, - { - "tag": "@example", - "name": "Updating your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\nPostgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nworking with JSON data. Currently, it is only possible to update the entire JSON document." - } - ] - }, - { - "tag": "@example", - "name": "Updating JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .update({\n address: {\n street: 'Melrose Place',\n postcode: 90210\n }\n })\n .eq('address->postcode', 90210)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210 }');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Michael\",\n \"address\": {\n \"street\": \"Melrose Place\",\n \"postcode\": 90210\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3458, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 809, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 810, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to update with" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 811, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 812, - "name": "Update", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3461, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [812] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3460, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Update" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 809, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 813, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 814, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 815, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count updated rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3465, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [815] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3464, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "PATCH" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 792, - "name": "upsert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3293, - "character": 2 - } - ], - "signatures": [ - { - "id": 793, - "name": "upsert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": " allows you to perform the equivalent of\n" - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": " if a row with the corresponding " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates`" - }, - { - "kind": "text", - "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Upsert a single row using a unique key", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting a single row, overwriting based on the 'username' unique column\nconst { data, error } = await supabase\n .from('users')\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\n\n// Example response:\n// {\n// data: [\n// { id: 4, message: 'bar', username: 'supabot' }\n// ],\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upsert with conflict resolution and exact row counting", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting and returning exact count\nconst { data, error, count } = await supabase\n .from('users')\n .upsert(\n {\n id: 3,\n message: 'foo',\n username: 'supabot'\n },\n {\n onConflict: 'username',\n count: 'exact'\n }\n )\n\n// Example response:\n// {\n// data: [\n// {\n// id: 42,\n// handle: \"saoirse\",\n// display_name: \"Saoirse\"\n// }\n// ],\n// count: 1,\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Primary keys must be included in " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " to use upsert." - } - ] - }, - { - "tag": "@example", - "name": "Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert({ id: 1, name: 'piano' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Bulk Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert([\n { id: 1, name: 'piano' },\n { id: 2, name: 'harp' },\n ])\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n },\n {\n \"id\": 2,\n \"name\": \"harp\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\nIn the following query, " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " implicitly uses the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": "\n(primary key) column to determine conflicts. If there is no existing\nrow with the same " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " inserts a new row, which\nwill fail in this case as there is already a row with " - }, - { - "kind": "code", - "text": "`handle`" - }, - { - "kind": "text", - "text": " " - }, - { - "kind": "code", - "text": "`\"saoirse\"`" - }, - { - "kind": "text", - "text": ".\nUsing the " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " option, you can instruct " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " to use\nanother column with a unique constraint to determine conflicts." - } - ] - }, - { - "tag": "@example", - "name": "Upserting into tables with constraints", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 generated by default as identity primary key,\n handle text not null unique,\n display_name text\n );\n\ninsert into\n users (id, handle, display_name)\nvalues\n (1, 'saoirse', null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (handle)=(saoirse) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"users_handle_key\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3293, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 794, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 795, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 796, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 797, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3296, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [797] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3295, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 794, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 798, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 799, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3298, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [799] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3297, - "character": 85 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 794, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 800, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 801, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 804, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count upserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3307, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 805, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 806, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates: false`" - }, - { - "kind": "text", - "text": ". This also only applies when doing bulk upserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3308, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 803, - "name": "ignoreDuplicates", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", duplicate rows are ignored. If\n" - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", duplicate rows are merged with existing rows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 802, - "name": "onConflict", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns are equal." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [804, 806, 803, 802] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [730] - }, - { - "title": "Properties", - "children": [758, 755, 767, 756, 757, 754, 766] - }, - { - "title": "Methods", - "children": [817, 779, 769, 807, 792] - } - ], - "categories": [ - { - "title": "Database", - "children": [730, 817, 779, 769, 807, 792] - }, - { - "title": "Other", - "children": [758, 755, 767, 756, 757, 754, 766] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 823, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 824, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 825, - "name": "Relation$1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 826, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 827, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 828, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 829, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2070, - "character": 2 - } - ], - "type": { - "type": "inferred", - "name": "R" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [829] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 216 - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - }, - { - "id": 559, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 560, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 561, - "name": "PostgrestTransformBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 562, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 563, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 564, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 565, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 566, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 567, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 568, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 569, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 570, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 575, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 578, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 579, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 580, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 581, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 582, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 583, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 584, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 585, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 573, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 586, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 571, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 589, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 574, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 587, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 576, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 577, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 572, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 588, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 575, 578, 573, 586, 571, 589, 574, 587, 576, 577, 572, 588 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 59, - "name": "PostgrestBuilder.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 58, - "name": "PostgrestBuilder.constructor" - } - }, - { - "id": 676, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 88, - "name": "PostgrestBuilder.body" - } - }, - { - "id": 679, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 680, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 681, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 682, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 683, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 684, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 685, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 686, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 91, - "name": "PostgrestBuilder.fetch" - } - }, - { - "id": 674, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 86, - "name": "PostgrestBuilder.headers" - } - }, - { - "id": 687, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 99, - "name": "PostgrestBuilder.isMaybeSingle" - } - }, - { - "id": 672, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 84, - "name": "PostgrestBuilder.method" - } - }, - { - "id": 690, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 102, - "name": "PostgrestBuilder.retryEnabled" - } - }, - { - "id": 675, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 87, - "name": "PostgrestBuilder.schema" - } - }, - { - "id": 688, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 100, - "name": "PostgrestBuilder.shouldStripNulls" - } - }, - { - "id": 677, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 89, - "name": "PostgrestBuilder.shouldThrowOnError" - } - }, - { - "id": 678, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 90, - "name": "PostgrestBuilder.signal" - } - }, - { - "id": 673, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 85, - "name": "PostgrestBuilder.url" - } - }, - { - "id": 689, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 101, - "name": "PostgrestBuilder.urlLengthLimit" - } - }, - { - "id": 641, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "signatures": [ - { - "id": 642, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "parameters": [ - { - "id": 643, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 650, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "signatures": [ - { - "id": 651, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 654, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "signatures": [ - { - "id": 655, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "parameters": [ - { - "id": 656, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 657, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 658, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1608, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 661, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1611, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 663, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1613, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 660, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1610, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 659, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1609, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 662, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1612, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [658, 661, 663, 660, 659, 662] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1607, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - } - ] - }, - { - "id": 652, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "signatures": [ - { - "id": 653, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 626, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "signatures": [ - { - "id": 627, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "parameters": [ - { - "id": 628, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 629, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 631, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1243, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 632, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1244, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [631, 632] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1242, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 669, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "signatures": [ - { - "id": 670, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "parameters": [ - { - "id": 671, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - } - } - ] - }, - { - "id": 647, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "signatures": [ - { - "id": 648, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 649, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 479, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 595, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "signatures": [ - { - "id": 596, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 597, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 598, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 427, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 599, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 600, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 601, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 602, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1115, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 603, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [601, 602, 603] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 604, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - } - ], - "parameters": [ - { - "id": 605, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 606, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 607, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 608, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1119, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 609, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 610, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1121, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [608, 609, 610] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 611, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 612, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 613, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 442, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 614, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 616, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 618, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1129, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 617, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1128, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [616, 618, 617] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 619, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "parameters": [ - { - "id": 620, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 621, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 623, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 625, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 624, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [623, 625, 624] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 714, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 715, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 716, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 717, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 718, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 719, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [719] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 720, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 721, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [721] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 131, - "name": "PostgrestBuilder.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 130, - "name": "PostgrestBuilder.overrideTypes" - } - }, - { - "id": 633, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "signatures": [ - { - "id": 634, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "parameters": [ - { - "id": 635, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 636, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 637, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 638, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 639, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 640, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [639, 640] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 699, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 700, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 701, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 112, - "name": "PostgrestBuilder.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 111, - "name": "PostgrestBuilder.retry" - } - }, - { - "id": 666, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "signatures": [ - { - "id": 667, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 668, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 498, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "overwrites": { - "type": "reference", - "target": 128, - "name": "PostgrestBuilder.returns" - } - } - ], - "overwrites": { - "type": "reference", - "target": 127, - "name": "PostgrestBuilder.returns" - } - }, - { - "id": 664, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "signatures": [ - { - "id": 665, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 590, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "signatures": [ - { - "id": 591, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 592, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 593, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 594, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 695, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 696, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 697, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 698, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 108, - "name": "PostgrestBuilder.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 107, - "name": "PostgrestBuilder.setHeader" - } - }, - { - "id": 644, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "signatures": [ - { - "id": 645, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 646, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 476, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 693, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 694, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 106, - "name": "PostgrestBuilder.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 105, - "name": "PostgrestBuilder.stripNulls" - } - }, - { - "id": 702, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 703, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 704, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 705, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 706, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 707, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 708, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 709, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 710, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 711, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 712, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 713, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 115, - "name": "PostgrestBuilder.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 114, - "name": "PostgrestBuilder.then" - } - }, - { - "id": 691, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 692, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 104, - "name": "PostgrestBuilder.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 103, - "name": "PostgrestBuilder.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [560] - }, - { - "title": "Properties", - "children": [676, 679, 674, 687, 672, 690, 675, 688, 677, 678, 673, 689] - }, - { - "title": "Methods", - "children": [ - 641, 650, 654, 652, 626, 669, 647, 595, 714, 633, 699, 666, 664, 590, 695, 644, 693, - 702, 691 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 560, 641, 650, 654, 652, 626, 669, 647, 714, 633, 666, 664, 590, 695, 644, 693, 691 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [699] - }, - { - "title": "Other", - "children": [676, 679, 674, 687, 672, 690, 675, 688, 677, 678, 673, 689, 595, 702] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1066, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 722, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 723, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 724, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 725, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 726, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 727, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 728, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 141, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 2822, - "name": "RealtimeChannel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "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": 2823, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 200, - "character": 4 - } - ], - "signatures": [ - { - "id": 2824, - "name": "RealtimeChannel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\n\nThe topic determines which realtime stream you are subscribing to. Config options let you\nenable acknowledgement for broadcasts, presence tracking, or private channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 200, - "character": 4 - } - ], - "parameters": [ - { - "id": 2825, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2826, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 2827, - "name": "socket", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2831, - "name": "bindings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 160, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "Binding" - }, - "name": "Binding", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2833, - "name": "broadcastEndpointURL", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2829, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 158, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2835, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2813, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2834, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 163, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2830, - "name": "socket", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 159, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2832, - "name": "subTopic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2828, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 157, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2840, - "name": "joinedOnce", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 167, - "character": 8 - } - ], - "getSignature": { - "id": 2841, - "name": "joinedOnce", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 167, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - }, - { - "id": 2844, - "name": "joinPush", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 169, - "character": 8 - } - ], - "getSignature": { - "id": 2845, - "name": "joinPush", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 169, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/push.js", - "qualifiedName": "default" - }, - "name": "Push", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 2846, - "name": "rejoinTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 170, - "character": 8 - } - ], - "getSignature": { - "id": 2847, - "name": "rejoinTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 170, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 2836, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 165, - "character": 8 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 166, - "character": 8 - } - ], - "getSignature": { - "id": 2837, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 165, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - }, - "setSignature": { - "id": 2838, - "name": "state", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 166, - "character": 8 - } - ], - "parameters": [ - { - "id": 2839, - "name": "state", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 2842, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 168, - "character": 8 - } - ], - "getSignature": { - "id": 2843, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 168, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3133, - "name": "copyBindings", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 463, - "character": 4 - } - ], - "signatures": [ - { - "id": 3134, - "name": "copyBindings", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 463, - "character": 4 - } - ], - "parameters": [ - { - "id": 3135, - "name": "other", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3099, - "name": "httpSend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 4 - } - ], - "signatures": [ - { - "id": 3100, - "name": "httpSend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a broadcast message explicitly via REST API.\n\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\n\nPayloads that are " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`ArrayBufferView`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`Uint8Array`" - }, - { - "kind": "text", - "text": ") are sent as\n" - }, - { - "kind": "code", - "text": "`application/octet-stream`" - }, - { - "kind": "text", - "text": "; all other payloads are JSON-encoded." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise resolving to object with success status, and error details if failed" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 4 - } - ], - "parameters": [ - { - "id": 3101, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the broadcast event" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3102, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent (required)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3103, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options including timeout" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3105, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 374, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3105] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 49 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 3106, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3107, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 376, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3107] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 375, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 3108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3111, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 380, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3110, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 379, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3109, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 378, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3111, 3110, 3109] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 377, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2880, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 4 - } - ], - "signatures": [ - { - "id": 2881, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 4 - } - ], - "parameters": [ - { - "id": 2882, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2883, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2884, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2885, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 258, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2885] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 58 - } - ] - } - } - }, - { - "id": 2886, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2887, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 259, - "character": 17 - } - ], - "signatures": [ - { - "id": 2888, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 259, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2889, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2890, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2891, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2892, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 261, - "character": 8 - } - ], - "parameters": [ - { - "id": 2893, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2894, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2895, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2896, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2897, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 263, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2897] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 262, - "character": 58 - } - ] - } - } - }, - { - "id": 2898, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2899, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 264, - "character": 17 - } - ], - "signatures": [ - { - "id": 2900, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 264, - "character": 17 - } - ], - "parameters": [ - { - "id": 2901, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3362, - "typeArguments": [ - { - "type": "reference", - "target": 2890, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2902, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2903, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2904, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2905, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 266, - "character": 8 - } - ], - "parameters": [ - { - "id": 2906, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2907, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2908, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2910, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 268, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2910] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 267, - "character": 58 - } - ] - } - } - }, - { - "id": 2911, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2912, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 269, - "character": 17 - } - ], - "signatures": [ - { - "id": 2913, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 269, - "character": 17 - } - ], - "parameters": [ - { - "id": 2914, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3372, - "typeArguments": [ - { - "type": "reference", - "target": 2903, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2915, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2916, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2917, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2918, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 271, - "character": 8 - } - ], - "parameters": [ - { - "id": 2919, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2920, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2921, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2923, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 273, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "*" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2923] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 272, - "character": 58 - } - ] - } - } - }, - { - "id": 2924, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2925, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 274, - "character": 17 - } - ], - "signatures": [ - { - "id": 2926, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 274, - "character": 17 - } - ], - "parameters": [ - { - "id": 2927, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3362, - "typeArguments": [ - { - "type": "reference", - "target": 2916, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3372, - "typeArguments": [ - { - "type": "reference", - "target": 2916, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2928, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2929, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2930, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2931, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 276, - "character": 8 - } - ], - "parameters": [ - { - "id": 2932, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2933, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2934, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2935, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2936, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 277, - "character": 156 - } - ], - "signatures": [ - { - "id": 2937, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 277, - "character": 156 - } - ], - "parameters": [ - { - "id": 2938, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3328, - "typeArguments": [ - { - "type": "reference", - "target": 2929, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2939, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2940, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2941, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2942, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 279, - "character": 8 - } - ], - "parameters": [ - { - "id": 2943, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2944, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2945, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2946, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2947, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 280, - "character": 159 - } - ], - "signatures": [ - { - "id": 2948, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 280, - "character": 159 - } - ], - "parameters": [ - { - "id": 2949, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3333, - "typeArguments": [ - { - "type": "reference", - "target": 2940, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2950, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2951, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2952, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2953, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 282, - "character": 8 - } - ], - "parameters": [ - { - "id": 2954, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2955, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2956, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2957, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2958, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 283, - "character": 159 - } - ], - "signatures": [ - { - "id": 2959, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 283, - "character": 159 - } - ], - "parameters": [ - { - "id": 2960, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3343, - "typeArguments": [ - { - "type": "reference", - "target": 2951, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2961, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2962, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2963, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2964, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 285, - "character": 8 - } - ], - "parameters": [ - { - "id": 2965, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2966, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2967, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2968, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2969, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 286, - "character": 159 - } - ], - "signatures": [ - { - "id": 2970, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 286, - "character": 159 - } - ], - "parameters": [ - { - "id": 2971, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3352, - "typeArguments": [ - { - "type": "reference", - "target": 2962, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2972, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2973, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2975, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 288, - "character": 8 - } - ], - "parameters": [ - { - "id": 2976, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2977, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2978, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "*" - }, - { - "type": "literal", - "value": "INSERT" - }, - { - "type": "literal", - "value": "UPDATE" - } - ] - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2979, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2980, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 289, - "character": 152 - } - ], - "signatures": [ - { - "id": 2981, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 289, - "character": 152 - } - ], - "parameters": [ - { - "id": 2982, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3328, - "typeArguments": [ - { - "type": "reference", - "target": 2973, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2983, - "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": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 4 - } - ], - "parameters": [ - { - "id": 2984, - "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": 2985, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2986, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2987, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 297, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2987] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 59 - } - ] - } - } - }, - { - "id": 2988, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function to be invoked when event handler is triggered." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2989, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 17 - } - ], - "signatures": [ - { - "id": 2990, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 17 - } - ], - "parameters": [ - { - "id": 2991, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2992, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2994, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 300, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2995, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 301, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2996, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2998, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 303, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2997, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 302, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2998, 2997] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 301, - "character": 15 - } - ] - } - } - }, - { - "id": 2993, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 299, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2994, 2995, 2993] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 27 - } - ], - "indexSignatures": [ - { - "id": 2999, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 305, - "character": 8 - } - ], - "parameters": [ - { - "id": 3000, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3001, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3002, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3003, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3004, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 308, - "character": 8 - } - ], - "parameters": [ - { - "id": 3005, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3006, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3007, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3008, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3009, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 310, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3009] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 309, - "character": 59 - } - ] - } - } - }, - { - "id": 3010, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3011, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 17 - } - ], - "signatures": [ - { - "id": 3012, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 17 - } - ], - "parameters": [ - { - "id": 3013, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3014, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3016, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 313, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3017, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 314, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3018, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3020, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 316, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3019, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 315, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3020, 3019] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 314, - "character": 15 - } - ] - } - } - }, - { - "id": 3021, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 318, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3002, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3015, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 312, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3016, 3017, 3021, 3015] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3022, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3023, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 3024, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3025, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3026, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3027, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 321, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3399, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3027] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 94 - } - ] - } - } - }, - { - "id": 3028, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 17 - } - ], - "signatures": [ - { - "id": 3030, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 17 - } - ], - "parameters": [ - { - "id": 3031, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3032, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3034, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 324, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3399, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - }, - { - "id": 3035, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 325, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3023, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3033, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 323, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3034, 3035, 3033] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3036, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3037, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3039, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 328, - "character": 8 - } - ], - "parameters": [ - { - "id": 3040, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3041, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3042, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3043, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3044, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 330, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3400, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3044] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 329, - "character": 59 - } - ] - } - } - }, - { - "id": 3045, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3046, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 17 - } - ], - "signatures": [ - { - "id": 3047, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 17 - } - ], - "parameters": [ - { - "id": 3048, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3051, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 333, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3400, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - }, - { - "id": 3052, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 334, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastInsertPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3037, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastInsertPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3050, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 332, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3051, 3052, 3050] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3053, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3054, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3055, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3056, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 337, - "character": 8 - } - ], - "parameters": [ - { - "id": 3057, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3058, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3059, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3060, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3061, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 339, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3401, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3061] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 338, - "character": 59 - } - ] - } - } - }, - { - "id": 3062, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3063, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 17 - } - ], - "signatures": [ - { - "id": 3064, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 17 - } - ], - "parameters": [ - { - "id": 3065, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3068, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 342, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3401, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - }, - { - "id": 3069, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastUpdatePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3054, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastUpdatePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3067, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 341, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3068, 3069, 3067] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3070, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3071, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3072, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3073, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 346, - "character": 8 - } - ], - "parameters": [ - { - "id": 3074, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3075, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3076, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3077, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3078, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 348, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3402, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3078] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 347, - "character": 59 - } - ] - } - } - }, - { - "id": 3079, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3080, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 17 - } - ], - "signatures": [ - { - "id": 3081, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 17 - } - ], - "parameters": [ - { - "id": 3082, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3083, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3085, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 351, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3402, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - }, - { - "id": 3086, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 352, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastDeletePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3071, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastDeletePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3084, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3085, 3086, 3084] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3087, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3088, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3089, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3090, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 355, - "character": 8 - } - ], - "parameters": [ - { - "id": 3091, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3092, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 3093, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 3095, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3096, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 356, - "character": 70 - } - ], - "signatures": [ - { - "id": 3097, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 356, - "character": 70 - } - ], - "parameters": [ - { - "id": 3098, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2857, - "name": "presenceState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 4 - } - ], - "signatures": [ - { - "id": 2858, - "name": "presenceState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current presence state for this channel.\n\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\ntracked metadata for that user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2859, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 28 - } - ], - "indexSignatures": [ - { - "id": 2861, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 233, - "character": 8 - } - ], - "parameters": [ - { - "id": 2862, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 2863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "target": 3382, - "typeArguments": [ - { - "type": "reference", - "target": 2859, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 3112, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 4 - } - ], - "signatures": [ - { - "id": 3113, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a message into the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- When using REST you don't need to subscribe to the channel\n- REST calls are only available from 2.37.0 onwards\n- If you create a channel only to send a REST broadcast, remove it from\n the client when the send completes" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via websocket", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\nchannel.subscribe((status) => {\n if (status === 'SUBSCRIBED') {\n channel.send({\n type: 'broadcast',\n event: 'cursor-pos',\n payload: { x: Math.random(), y: Math.random() },\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Send a message via websocket\n" - }, - { - "kind": "code", - "text": "```js\nok | timed out | error\n```" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via REST", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\ntry {\n await channel.httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\n} finally {\n await supabase.removeChannel(channel)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 4 - } - ], - "parameters": [ - { - "id": 3114, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arguments to send to channel" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3117, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event being sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 432, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3118, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 433, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3116, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of event to send" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 431, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3117, 3118, 3116] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 15 - } - ], - "indexSignatures": [ - { - "id": 3119, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 434, - "character": 8 - } - ], - "parameters": [ - { - "id": 3120, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 3121, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options to be used during the send process" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3122, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 435, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3123, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 436, - "character": 8 - } - ], - "parameters": [ - { - "id": 3124, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2848, - "name": "subscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 4 - } - ], - "signatures": [ - { - "id": 2849, - "name": "subscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Subscribe registers your client with the server.\n\nThe optional " - }, - { - "kind": "code", - "text": "`callback`" - }, - { - "kind": "text", - "text": " receives a " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and, on failure, an " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " argument.\nLog the full " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " so its " - }, - { - "kind": "code", - "text": "`cause`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", and any structured fields aren't hidden\nbehind " - }, - { - "kind": "code", - "text": "`err.message`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.channel('room1').subscribe((status, err) => {\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\n // Log the full error: its `cause` often holds the underlying reason.\n console.error(status, err)\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 4 - } - ], - "parameters": [ - { - "id": 2850, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 25 - } - ], - "signatures": [ - { - "id": 2852, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 25 - } - ], - "parameters": [ - { - "id": 2853, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3407, - "name": "REALTIME_SUBSCRIBE_STATES", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2854, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 2855, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3131, - "name": "teardown", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 462, - "character": 4 - } - ], - "signatures": [ - { - "id": 3132, - "name": "teardown", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Destroys and stops related timers." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 462, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 2864, - "name": "track", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 4 - } - ], - "signatures": [ - { - "id": 2865, - "name": "track", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends the supplied payload to the presence tracker so other subscribers can see that this\nclient is online. Use " - }, - { - "kind": "code", - "text": "`untrack`" - }, - { - "kind": "text", - "text": " to stop broadcasting presence for the same key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 4 - } - ], - "parameters": [ - { - "id": 2866, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2867, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 19 - } - ], - "indexSignatures": [ - { - "id": 2868, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 242, - "character": 8 - } - ], - "parameters": [ - { - "id": 2869, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 2870, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 243, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 2872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 244, - "character": 8 - } - ], - "parameters": [ - { - "id": 2873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3128, - "name": "unsubscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 456, - "character": 4 - } - ], - "signatures": [ - { - "id": 3129, - "name": "unsubscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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!\") )" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 456, - "character": 4 - } - ], - "parameters": [ - { - "id": 3130, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2874, - "name": "untrack", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 4 - } - ], - "signatures": [ - { - "id": 2875, - "name": "untrack", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes the current presence state for this client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 4 - } - ], - "parameters": [ - { - "id": 2876, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2877, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 19 - } - ], - "indexSignatures": [ - { - "id": 2878, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 252, - "character": 8 - } - ], - "parameters": [ - { - "id": 2879, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3125, - "name": "updateJoinPayload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 444, - "character": 4 - } - ], - "signatures": [ - { - "id": 3126, - "name": "updateJoinPayload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the payload that will be sent the next time the channel joins (reconnects).\nUseful for rotating access tokens or updating config without re-creating the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 444, - "character": 4 - } - ], - "parameters": [ - { - "id": 3127, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2823] - }, - { - "title": "Properties", - "children": [2831, 2833, 2829, 2835, 2834, 2830, 2832, 2828] - }, - { - "title": "Accessors", - "children": [2840, 2844, 2846, 2836, 2842] - }, - { - "title": "Methods", - "children": [3133, 3099, 2880, 2857, 3112, 2848, 3131, 2864, 3128, 2874, 3125] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 2831, 2833, 2829, 2835, 2834, 2830, 2832, 2828, 2840, 2844, 2846, 2836, 2842, 3133, - 2880 - ] - }, - { - "title": "Realtime", - "children": [2823, 3099, 2857, 3112, 2848, 3131, 2864, 3128, 2874, 3125] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 155, - "character": 21 - } - ] - }, - { - "id": 3152, - "name": "RealtimeClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 3153, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 145, - "character": 4 - } - ], - "signatures": [ - { - "id": 3154, - "name": "RealtimeClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the Socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nclient.connect()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 145, - "character": 4 - } - ], - "parameters": [ - { - "id": 3155, - "name": "endPoint", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3156, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3273, - "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": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future." - } - ], - "heartbeatIntervalMs": [ - { - "kind": "text", - "text": "The millisec interval to send a heartbeat message." - } - ], - "heartbeatCallback": [ - { - "kind": "text", - "text": "The optional function to handle heartbeat status and latency." - } - ], - "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." - } - ], - "vsn": [ - { - "kind": "text", - "text": "The protocol version to use when connecting. Supported versions are \"1.0.0\" and \"2.0.0\". Defaults to \"2.0.0\"." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3159, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3160, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 18 - } - ], - "signatures": [ - { - "id": 3161, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 18 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3158, - "name": "accessTokenValue", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 59, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 3162, - "name": "apiKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 61, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 3157, - "name": "channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 58, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - }, - { - "id": 3174, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 72, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 3176, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 3177, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3178, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 3179, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 3180, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3181, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3164, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "headers cannot be set on websocket connections" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 64, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 64, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3166, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 65, - "character": 8 - } - ], - "parameters": [ - { - "id": 3167, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3163, - "name": "httpEndpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3173, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 71, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3168, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 67, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3169, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 67, - "character": 13 - } - ], - "indexSignatures": [ - { - "id": 3170, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 68, - "character": 8 - } - ], - "parameters": [ - { - "id": 3171, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3172, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 70, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3185, - "name": "serializer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 76, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/lib/serializer.ts", - "qualifiedName": "default" - }, - "name": "Serializer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3182, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 73, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3184, - "name": "workerRef", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 75, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Worker" - }, - "name": "Worker", - "package": "typescript" - } - }, - { - "id": 3183, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 74, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3206, - "name": "decode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 87, - "character": 8 - } - ], - "getSignature": { - "id": 3207, - "name": "decode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 87, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3204, - "name": "encode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 86, - "character": 8 - } - ], - "getSignature": { - "id": 3205, - "name": "encode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 86, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3186, - "name": "endPoint", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 77, - "character": 8 - } - ], - "getSignature": { - "id": 3187, - "name": "endPoint", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 77, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 3192, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 80, - "character": 8 - } - ], - "getSignature": { - "id": 3193, - "name": "heartbeatCallback", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 80, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3194, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 81, - "character": 8 - } - ], - "getSignature": { - "id": 3195, - "name": "heartbeatIntervalMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 81, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3196, - "name": "heartbeatTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 82, - "character": 8 - } - ], - "getSignature": { - "id": 3197, - "name": "heartbeatTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 82, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "HeartbeatTimer" - }, - "name": "HeartbeatTimer", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3198, - "name": "pendingHeartbeatRef", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 83, - "character": 8 - } - ], - "getSignature": { - "id": 3199, - "name": "pendingHeartbeatRef", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 83, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 3208, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 8 - } - ], - "getSignature": { - "id": 3209, - "name": "reconnectAfterMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3210, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 28 - } - ], - "signatures": [ - { - "id": 3211, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 28 - } - ], - "parameters": [ - { - "id": 3212, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - } - }, - { - "id": 3200, - "name": "reconnectTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 84, - "character": 8 - } - ], - "getSignature": { - "id": 3201, - "name": "reconnectTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 84, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 3213, - "name": "sendBuffer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 8 - } - ], - "getSignature": { - "id": 3214, - "name": "sendBuffer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 3215, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 23 - } - ], - "signatures": [ - { - "id": 3216, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 23 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - } - }, - { - "id": 3217, - "name": "stateChangeCallbacks", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 8 - } - ], - "getSignature": { - "id": 3218, - "name": "stateChangeCallbacks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3219, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3221, - "name": "close", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 92, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3222, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 93, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3223, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 94, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3220, - "name": "open", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 91, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3221, 3222, 3223, 3220] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 32 - } - ] - } - } - } - }, - { - "id": 3188, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 78, - "character": 8 - } - ], - "getSignature": { - "id": 3189, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 78, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3190, - "name": "transport", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 79, - "character": 8 - } - ], - "getSignature": { - "id": 3191, - "name": "transport", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 79, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3481, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3202, - "name": "vsn", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 85, - "character": 8 - } - ], - "getSignature": { - "id": 3203, - "name": "vsn", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 85, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Vsn" - }, - "name": "Vsn", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3258, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 228, - "character": 4 - } - ], - "signatures": [ - { - "id": 3259, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates (or reuses) a " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RealtimeChannel", - "target": 2822 - }, - { - "kind": "text", - "text": " for the provided topic.\n\nTopics are automatically prefixed with " - }, - { - "kind": "code", - "text": "`realtime:`" - }, - { - "kind": "text", - "text": " to match the Realtime service.\nIf a channel with the same topic already exists it will be returned instead of creating\na duplicate connection." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 228, - "character": 4 - } - ], - "parameters": [ - { - "id": 3260, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3261, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3230, - "name": "connect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 151, - "character": 4 - } - ], - "signatures": [ - { - "id": 3231, - "name": "connect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Connects the socket, unless already connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 151, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3250, - "name": "connectionState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 200, - "character": 4 - } - ], - "signatures": [ - { - "id": 3251, - "name": "connectionState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current state of the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 200, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/lib/constants.ts", - "qualifiedName": "ConnectionState" - }, - "name": "ConnectionState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 3234, - "name": "disconnect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 167, - "character": 4 - } - ], - "signatures": [ - { - "id": 3235, - "name": "disconnect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Disconnects the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 167, - "character": 4 - } - ], - "parameters": [ - { - "id": 3236, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A numeric status code to send on disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3237, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom reason for the disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "timeout" - }, - { - "type": "literal", - "value": "ok" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3232, - "name": "endpointURL", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 158, - "character": 4 - } - ], - "signatures": [ - { - "id": 3233, - "name": "endpointURL", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the URL of the websocket." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "string The URL of the websocket." - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 158, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 3238, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 173, - "character": 4 - } - ], - "signatures": [ - { - "id": 3239, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all created channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 173, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 3252, - "name": "isConnected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 206, - "character": 4 - } - ], - "signatures": [ - { - "id": 3253, - "name": "isConnected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " is the connection is open." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3254, - "name": "isConnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 212, - "character": 4 - } - ], - "signatures": [ - { - "id": 3255, - "name": "isConnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently connecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 212, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3256, - "name": "isDisconnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 218, - "character": 4 - } - ], - "signatures": [ - { - "id": 3257, - "name": "isDisconnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently disconnecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 218, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3245, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 194, - "character": 4 - } - ], - "signatures": [ - { - "id": 3246, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " - }, - { - "kind": "code", - "text": "`this.logger`" - }, - { - "kind": "text", - "text": " can be overridden in Client constructor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 194, - "character": 4 - } - ], - "parameters": [ - { - "id": 3247, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3248, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3249, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3270, - "name": "onHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 272, - "character": 4 - } - ], - "signatures": [ - { - "id": 3271, - "name": "onHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets a callback that receives lifecycle events for internal heartbeat messages.\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 272, - "character": 4 - } - ], - "parameters": [ - { - "id": 3272, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3262, - "name": "push", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 236, - "character": 4 - } - ], - "signatures": [ - { - "id": 3263, - "name": "push", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 236, - "character": 4 - } - ], - "parameters": [ - { - "id": 3264, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3314, - "name": "RealtimeMessage", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3243, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 186, - "character": 4 - } - ], - "signatures": [ - { - "id": 3244, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down all channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 186, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3240, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 180, - "character": 4 - } - ], - "signatures": [ - { - "id": 3241, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down a single channel" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 180, - "character": 4 - } - ], - "parameters": [ - { - "id": 3242, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A RealtimeChannel instance" - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3268, - "name": "sendHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 265, - "character": 4 - } - ], - "signatures": [ - { - "id": 3269, - "name": "sendHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a heartbeat message if the socket is connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 265, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3265, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 259, - "character": 4 - } - ], - "signatures": [ - { - "id": 3266, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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.\n\nWhen a token is explicitly provided, it will be preserved across channel operations\n(including removeChannel and resubscribe). The " - }, - { - "kind": "code", - "text": "`accessToken`" - }, - { - "kind": "text", - "text": " callback will not be\ninvoked until " - }, - { - "kind": "code", - "text": "`setAuth()`" - }, - { - "kind": "text", - "text": " is called without arguments." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nSetting the authorization header\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\nclient.realtime.setAuth('my-custom-jwt')\n\n// Switch back to using the accessToken callback\nclient.realtime.setAuth()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 259, - "character": 4 - } - ], - "parameters": [ - { - "id": 3267, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A JWT string to override the token set on the client." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [3153] - }, - { - "title": "Properties", - "children": [ - 3159, 3158, 3162, 3157, 3174, 3164, 3163, 3173, 3168, 3172, 3185, 3182, 3184, 3183 - ] - }, - { - "title": "Accessors", - "children": [ - 3206, 3204, 3186, 3192, 3194, 3196, 3198, 3208, 3200, 3213, 3217, 3188, 3190, 3202 - ] - }, - { - "title": "Methods", - "children": [ - 3258, 3230, 3250, 3234, 3232, 3238, 3252, 3254, 3256, 3245, 3270, 3262, 3243, 3240, - 3268, 3265 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 3159, 3158, 3162, 3157, 3174, 3164, 3163, 3173, 3168, 3172, 3185, 3182, 3184, 3183, - 3206, 3204, 3186, 3192, 3194, 3196, 3198, 3208, 3200, 3213, 3217, 3188, 3190, 3202 - ] - }, - { - "title": "Realtime", - "children": [ - 3153, 3258, 3230, 3250, 3234, 3232, 3238, 3252, 3254, 3256, 3245, 3270, 3262, 3243, - 3240, 3268, 3265 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 57, - "character": 21 - } - ] - }, - { - "id": 2813, - "name": "RealtimePresence", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2814, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 60, - "character": 4 - } - ], - "signatures": [ - { - "id": 2815, - "name": "RealtimePresence", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Presence helper that keeps the local presence state in sync with the server." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example for a presence channel", - "content": [ - { - "kind": "code", - "text": "```ts\nconst presence = new RealtimePresence(channel)\n\nchannel.on('presence', ({ event, key }) => {\n console.log(`Presence ${event} on ${key}`)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 60, - "character": 4 - } - ], - "parameters": [ - { - "id": 2816, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2817, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom event names, e.g. " - }, - { - "kind": "code", - "text": "`{ events: { state: 'state', diff: 'diff' } }`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceOptions" - }, - "name": "RealtimePresenceOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 2813, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2818, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2819, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 41, - "character": 8 - } - ], - "getSignature": { - "id": 2820, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 41, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3382, - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2814] - }, - { - "title": "Properties", - "children": [2818] - }, - { - "title": "Accessors", - "children": [2819] - } - ], - "categories": [ - { - "title": "Other", - "children": [2818, 2819] - }, - { - "title": "Realtime", - "children": [2814] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 39, - "character": 21 - } - ] - }, - { - "id": 850, - "name": "StorageApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "API error returned from Storage service\nIncludes HTTP status code and service-specific error code" - } - ] - }, - "children": [ - { - "id": 851, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 40, - "character": 2 - } - ], - "signatures": [ - { - "id": 852, - "name": "StorageApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 40, - "character": 2 - } - ], - "parameters": [ - { - "id": 853, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 854, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 855, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 856, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 850, - "name": "StorageApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.constructor" - } - }, - { - "id": 866, - "name": "__isStorageError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "StorageError.__isStorageError" - } - }, - { - "id": 867, - "name": "namespace", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "StorageError.namespace" - } - }, - { - "id": 857, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.status" - } - }, - { - "id": 858, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.statusCode" - } - }, - { - "id": 859, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 2 - } - ], - "signatures": [ - { - "id": 860, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 861, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 863, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 862, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 42, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 864, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 865, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [863, 862, 864, 865] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 12 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [851] - }, - { - "title": "Properties", - "children": [866, 867, 857, 858] - }, - { - "title": "Methods", - "children": [859] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 37, - "character": 14 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 941, - "name": "SupabaseClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Client.\n\nAn isomorphic Javascript client for interacting with Postgres." - } - ] - }, - "children": [ - { - "id": 942, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 309, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L309" - } - ], - "signatures": [ - { - "id": 943, - "name": "SupabaseClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Initializing" - } - ] - }, - { - "tag": "@example", - "name": "Creating a client", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Create a single supabase client for interacting with your database\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n```" - } - ] - }, - { - "tag": "@example", - "name": "With a custom domain", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Use a custom domain as the supabase URL\nconst supabase = createClient('https://my-custom-domain.com', 'your-publishable-key')\n```" - } - ] - }, - { - "tag": "@example", - "name": "With additional parameters", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst options = {\n db: {\n schema: 'public',\n },\n auth: {\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: true\n },\n global: {\n headers: { 'x-my-custom-header': 'my-app-name' },\n },\n}\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", options)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With custom schemas\nBy default the API server points to the " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": " schema. You can enable other database schemas within the Dashboard.\nGo to [Settings > API > Exposed schemas](/dashboard/project/_/settings/api) and add the schema which you want to expose to the API.\n\nNote: each client connection can only access a single schema, so the code above can access the " - }, - { - "kind": "code", - "text": "`other_schema`" - }, - { - "kind": "text", - "text": " schema but cannot access the " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": " schema." - } - ] - }, - { - "tag": "@example", - "name": "With custom schemas", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n // Provide a custom schema. Defaults to \"public\".\n db: { schema: 'other_schema' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Custom fetch implementation\n" - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests,\nbut an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option.\nThis is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible (for instance Cloudflare Workers)." - } - ] - }, - { - "tag": "@example", - "name": "Custom fetch implementation", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n global: { fetch: fetch.bind(globalThis) }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "React Native options with AsyncStorage\nFor React Native we recommend using " - }, - { - "kind": "code", - "text": "`AsyncStorage`" - }, - { - "kind": "text", - "text": " as the storage implementation for Supabase Auth." - } - ] - }, - { - "tag": "@example", - "name": "React Native options with AsyncStorage", - "content": [ - { - "kind": "code", - "text": "```js\nimport 'react-native-url-polyfill/auto'\nimport { createClient } from '@supabase/supabase-js'\nimport AsyncStorage from \"@react-native-async-storage/async-storage\";\n\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", {\n auth: {\n storage: AsyncStorage,\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: false,\n },\n});\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "React Native options with Expo SecureStore\nIf you wish to encrypt the user's session information, you can use " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " and store the encryption key in Expo SecureStore.\nThe " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " library, a reputable JavaScript-only implementation of the AES encryption algorithm in CTR mode.\nA new 256-bit encryption key is generated using the " - }, - { - "kind": "code", - "text": "`react-native-get-random-values`" - }, - { - "kind": "text", - "text": " library.\nThis key is stored inside Expo's SecureStore, while the value is encrypted and placed inside AsyncStorage.\n\nPlease make sure that:\n- You keep the " - }, - { - "kind": "code", - "text": "`expo-secure-store`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`react-native-get-random-values`" - }, - { - "kind": "text", - "text": " libraries up-to-date.\n- Choose the correct [" - }, - { - "kind": "code", - "text": "`SecureStoreOptions`" - }, - { - "kind": "text", - "text": "](https://docs.expo.dev/versions/latest/sdk/securestore/#securestoreoptions) for your app's needs.\n E.g. [" - }, - { - "kind": "code", - "text": "`SecureStore.WHEN_UNLOCKED`" - }, - { - "kind": "text", - "text": "](https://docs.expo.dev/versions/latest/sdk/securestore/#securestorewhen_unlocked) regulates when the data can be accessed.\n- Carefully consider optimizations or other modifications to the above example, as those can lead to introducing subtle security vulnerabilities." - } - ] - }, - { - "tag": "@example", - "name": "React Native options with Expo SecureStore", - "content": [ - { - "kind": "code", - "text": "```ts\nimport 'react-native-url-polyfill/auto'\nimport { createClient } from '@supabase/supabase-js'\nimport AsyncStorage from '@react-native-async-storage/async-storage';\nimport * as SecureStore from 'expo-secure-store';\nimport * as aesjs from 'aes-js';\nimport 'react-native-get-random-values';\n\n// As Expo's SecureStore does not support values larger than 2048\n// bytes, an AES-256 key is generated and stored in SecureStore, while\n// it is used to encrypt/decrypt values stored in AsyncStorage.\nclass LargeSecureStore {\n private async _encrypt(key: string, value: string) {\n const encryptionKey = crypto.getRandomValues(new Uint8Array(256 / 8));\n\n const cipher = new aesjs.ModeOfOperation.ctr(encryptionKey, new aesjs.Counter(1));\n const encryptedBytes = cipher.encrypt(aesjs.utils.utf8.toBytes(value));\n\n await SecureStore.setItemAsync(key, aesjs.utils.hex.fromBytes(encryptionKey));\n\n return aesjs.utils.hex.fromBytes(encryptedBytes);\n }\n\n private async _decrypt(key: string, value: string) {\n const encryptionKeyHex = await SecureStore.getItemAsync(key);\n if (!encryptionKeyHex) {\n return encryptionKeyHex;\n }\n\n const cipher = new aesjs.ModeOfOperation.ctr(aesjs.utils.hex.toBytes(encryptionKeyHex), new aesjs.Counter(1));\n const decryptedBytes = cipher.decrypt(aesjs.utils.hex.toBytes(value));\n\n return aesjs.utils.utf8.fromBytes(decryptedBytes);\n }\n\n async getItem(key: string) {\n const encrypted = await AsyncStorage.getItem(key);\n if (!encrypted) { return encrypted; }\n\n return await this._decrypt(key, encrypted);\n }\n\n async removeItem(key: string) {\n await AsyncStorage.removeItem(key);\n await SecureStore.deleteItemAsync(key);\n }\n\n async setItem(key: string, value: string) {\n const encrypted = await this._encrypt(key, value);\n\n await AsyncStorage.setItem(key, encrypted);\n }\n}\n\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", {\n auth: {\n storage: new LargeSecureStore(),\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: false,\n },\n});\n```" - } - ] - }, - { - "tag": "@example", - "name": "With a database query", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n\nconst { data } = await supabase.from('profiles').select('*')\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With OpenTelemetry tracing\nOpt in to W3C trace context propagation so the " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " from your\nclient-side spans is attached to Supabase requests and appears in API\nGateway and Edge Function logs. Requires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be\ninstalled in your application. See [Tracing with the JS SDK](https://supabase.com/docs/guides/telemetry/client-side-tracing)." - } - ] - }, - { - "tag": "@example", - "name": "With OpenTelemetry tracing", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n tracePropagation: true,\n})\n\nconst tracer = trace.getTracer('my-app')\n\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // Outgoing request carries the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 309, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L309" - } - ], - "typeParameters": [ - { - "id": 944, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 945, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 946, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 947, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [947] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 948, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "reference", - "target": 945, - "typeArguments": [ - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - } - }, - { - "id": 949, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 950, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 951, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 952, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [952] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ] - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 953, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 954, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 955, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 956, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [956] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [954] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "__InternalSupabase" - }, - "objectType": { - "type": "reference", - "target": 944, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - ], - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 957, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 958, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [958] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ] - } - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 959, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 960, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [960] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 945, - "typeArguments": [ - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "parameters": [ - { - "id": 961, - "name": "supabaseUrl", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 962, - "name": "supabaseKey", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 963, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1072, - "typeArguments": [ - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClientOptions", - "package": "@supabase/supabase-js", - "highlightedProperties": { - "realtime": [ - { - "kind": "text", - "text": "Options passed along to realtime-js constructor." - } - ], - "storage": [ - { - "kind": "text", - "text": "Options passed along to the storage-js constructor." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 941, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClient", - "package": "@supabase/supabase-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 982, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 983, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "signatures": [ - { - "id": 984, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 964, - "name": "auth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 78, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L78" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/SupabaseAuthClient.ts", - "qualifiedName": "SupabaseAuthClient" - }, - "name": "SupabaseAuthClient", - "package": "@supabase/supabase-js" - } - }, - { - "id": 968, - "name": "authUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 86, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L86" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 981, - "name": "changedAccessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 92, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L92" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 973, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 91, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L91" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 975, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 976, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 977, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 978, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 979, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 980, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 970, - "name": "functionsUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L88" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 985, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 95, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L95" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 965, - "name": "realtime", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L79" - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 967, - "name": "realtimeUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L85" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 971, - "name": "rest", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 89, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L89" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestClient" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 986, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 96, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L96" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/helpers.ts", - "qualifiedName": "ResolvedSupabaseClientOptions" - }, - "typeArguments": [ - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "ResolvedSupabaseClientOptions", - "package": "@supabase/supabase-js" - } - }, - { - "id": 966, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L83" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageClient" - }, - "name": "StorageClient", - "package": "@supabase/storage-js" - } - }, - { - "id": 972, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 90, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L90" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 969, - "name": "storageUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 87, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L87" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 988, - "name": "supabaseKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 311, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L311" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 987, - "name": "supabaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 310, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L310" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 989, - "name": "functions", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 403, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L403" - } - ], - "getSignature": { - "id": 990, - "name": "functions", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Functions allows you to deploy and invoke edge functions." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 403, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L403" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../functions-js/src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "name": "FunctionsClient", - "package": "@supabase/functions-js" - } - } - }, - { - "id": 1016, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L515" - } - ], - "signatures": [ - { - "id": 1017, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L515" - } - ], - "parameters": [ - { - "id": 1018, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Realtime channel." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1019, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The options to pass to the Realtime channel." - } - ] - }, - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 991, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a query on a table or a view." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "relation", - "content": [ - { - "kind": "text", - "text": "The table or view name to query" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L411" - }, - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L415" - }, - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L423" - } - ], - "signatures": [ - { - "id": 992, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L411" - } - ], - "typeParameters": [ - { - "id": 993, - "name": "TableName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 994, - "name": "Table", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 995, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 993, - "name": "TableName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 994, - "name": "Table", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 993, - "name": "TableName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 996, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L415" - } - ], - "typeParameters": [ - { - "id": 997, - "name": "ViewName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 998, - "name": "View", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 999, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 997, - "name": "ViewName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 998, - "name": "View", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 997, - "name": "ViewName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 1020, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 529, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L529" - } - ], - "signatures": [ - { - "id": 1021, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all Realtime channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Get all channels", - "content": [ - { - "kind": "code", - "text": "```js\nconst channels = supabase.getChannels()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 529, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L529" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 1025, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L566" - } - ], - "signatures": [ - { - "id": 1026, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes and removes all Realtime channels from Realtime client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Removing channels is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed." - } - ] - }, - { - "tag": "@example", - "name": "Remove all channels", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.removeAllChannels()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L566" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1022, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L549" - } - ], - "signatures": [ - { - "id": 1023, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes and removes Realtime channel from Realtime client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Removing a channel is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed." - } - ] - }, - { - "tag": "@example", - "name": "Removes a channel", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.removeChannel(myChannel)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L549" - } - ], - "parameters": [ - { - "id": 1024, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Realtime channel." - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1004, - "name": "rpc", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L470" - } - ], - "signatures": [ - { - "id": 1005, - "name": "rpc", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a function call." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L470" - } - ], - "typeParameters": [ - { - "id": 1006, - "name": "FnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1007, - "name": "Args", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "default": { - "type": "intrinsic", - "name": "never" - } - }, - { - "id": 1008, - "name": "FilterBuilder", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/rpc.ts", - "qualifiedName": "RpcFunctionNotFound" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "RpcFunctionNotFound", - "package": "@supabase/supabase-js" - }, - "default": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/rpc.ts", - "qualifiedName": "GetRpcFunctionFilterBuilderByArgs" - }, - "typeArguments": [ - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1007, - "name": "Args", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "GetRpcFunctionFilterBuilderByArgs", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 1009, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function name to call" - } - ] - }, - "type": { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "id": 1010, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The arguments to pass to the function call" - } - ] - }, - "type": { - "type": "reference", - "target": 1007, - "name": "Args", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "defaultValue": "..." - }, - { - "id": 1011, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1012, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1015, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 481, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L481" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 1014, - "name": "get", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the function will be called with\nread-only access mode." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 480, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L480" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1013, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 479, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L479" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1015, 1014, 1013] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 478, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L478" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Result" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "RelationName" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Relationships" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "RPC" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 1000, - "name": "schema", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L435" - } - ], - "signatures": [ - { - "id": 1001, - "name": "schema", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L435" - } - ], - "typeParameters": [ - { - "id": 1002, - "name": "DynamicSchema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 1003, - "name": "schema", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema to query" - } - ] - }, - "type": { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestClient" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [942] - }, - { - "title": "Properties", - "children": [ - 982, 964, 968, 981, 973, 970, 985, 965, 967, 971, 986, 966, 972, 969, 988, 987 - ] - }, - { - "title": "Accessors", - "children": [989] - }, - { - "title": "Methods", - "children": [1016, 991, 1020, 1025, 1022, 1004, 1000] - } - ], - "categories": [ - { - "title": "Initializing", - "children": [942] - }, - { - "title": "Other", - "children": [ - 982, 964, 968, 981, 973, 970, 985, 965, 967, 971, 986, 966, 972, 969, 988, 987, 989, - 991, 1004, 1000 - ] - }, - { - "title": "Realtime", - "children": [1016, 1020, 1025, 1022] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 43, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L43" - } - ], - "typeParameters": [ - { - "id": 1055, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 1056, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - { - "type": "reflection", - "declaration": { - "id": 1057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1058, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1058] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1059, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "trueType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - } - }, - { - "id": 1060, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 1061, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1062, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1063, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1063] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ] - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1064, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1065, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1067, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1067] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1065] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "__InternalSupabase" - }, - "objectType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 1068, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1069, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1069] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ] - } - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1070, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1071, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1071] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ] - }, - { - "id": 3419, - "name": "WebSocketFactory", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Utilities for creating WebSocket instances across runtimes." - } - ] - }, - "children": [ - { - "id": 3421, - "name": "getWebSocketConstructor", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 65, - "character": 11 - } - ], - "signatures": [ - { - "id": 3422, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the best available WebSocket constructor for the current runtime." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example with error handling", - "content": [ - { - "kind": "code", - "text": "```ts\ntry {\n const WS = WebSocketFactory.getWebSocketConstructor()\n const socket = new WS('wss://example.com/socket')\n} catch (error) {\n console.error('WebSocket not available in this environment.', error)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 65, - "character": 11 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3423, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26772, - "character": 23 - } - ], - "signatures": [ - { - "id": 3424, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26774, - "character": 4 - } - ], - "parameters": [ - { - "id": 3425, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3426, - "name": "protocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" - }, - "name": "WebSocket", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 3427, - "name": "isWebSocketSupported", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 79, - "character": 11 - } - ], - "signatures": [ - { - "id": 3428, - "name": "isWebSocketSupported", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detects whether the runtime can establish WebSocket connections." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example in a Node.js script", - "content": [ - { - "kind": "code", - "text": "```ts\nif (!WebSocketFactory.isWebSocketSupported()) {\n console.error('WebSockets are required for this script.')\n process.exitCode = 1\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 79, - "character": 11 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [3421, 3427] - } - ], - "categories": [ - { - "title": "Realtime", - "children": [3421, 3427] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 44, - "character": 21 - } - ] - }, - { - "id": 1750, - "name": "AdminUserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1752, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's application specific metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.app_metadata`" - }, - { - "kind": "text", - "text": " column.\n\nOnly a service role can modify.\n\nThe " - }, - { - "kind": "code", - "text": "`app_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 432, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1755, - "name": "ban_duration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 455, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1763, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 385, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.current_password" - } - }, - { - "id": 1760, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 389, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.email" - } - }, - { - "id": 1753, - "name": "email_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's email as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 438, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1758, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " for the user.\n\nAllows you to overwrite the default " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " set for the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 477, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1759, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 403, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.nonce" - } - }, - { - "id": 1761, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.password" - } - }, - { - "id": 1757, - "name": "password_hash", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`password_hash`" - }, - { - "kind": "text", - "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 471, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1762, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 393, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.phone" - } - }, - { - "id": 1754, - "name": "phone_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's phone as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 444, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1756, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " - }, - { - "kind": "code", - "text": "`authenticated`" - }, - { - "kind": "text", - "text": " by default. You should only modify the " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " is not recommended as it grants the user admin privileges." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 463, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1751, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\n\nThe " - }, - { - "kind": "code", - "text": "`user_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 423, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1752, 1755, 1763, 1760, 1753, 1758, 1759, 1761, 1757, 1762, 1754, 1756, 1751 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 412, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "data" - } - ], - "name": "Omit", - "package": "typescript" - } - ] - }, - { - "id": 1707, - "name": "AMREntry", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An authentication method reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time.\n\nNote: Custom access token hooks can return AMR claims as either:\n- An array of AMREntry objects (detailed format with timestamps)\n- An array of strings (RFC-8176 compliant format)" - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 2079 - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "children": [ - { - "id": 1708, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication method name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 282, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1705, - "name": "AMRMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 1709, - "name": "timestamp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 287, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1708, 1709] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 280, - "character": 17 - } - ] - }, - { - "id": 2392, - "name": "AuthOAuthServerApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth 2.1 authorization server user-facing methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThese methods are used to implement the consent page." - } - ] - }, - "children": [ - { - "id": 2396, - "name": "approveAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 4 - } - ], - "signatures": [ - { - "id": 2397, - "name": "approveAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Approves an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter approval, the user's consent is stored and an authorization code is generated.\nThe response contains a complete redirect URL with the authorization code and state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with authorization code" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 4 - } - ], - "parameters": [ - { - "id": 2398, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to approve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2399, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2400, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2401, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2265, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2401] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 60 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2383, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2402, - "name": "denyAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 4 - } - ], - "signatures": [ - { - "id": 2403, - "name": "denyAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Denies an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter denial, the response contains a redirect URL with an OAuth error\n(access_denied) to inform the OAuth client that the user rejected the request." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with error information" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 4 - } - ], - "parameters": [ - { - "id": 2404, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to deny" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2405, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2406, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2407, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2283, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2407] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 57 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2383, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2393, - "name": "getAuthorizationDetails", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2248, - "character": 4 - } - ], - "signatures": [ - { - "id": 2394, - "name": "getAuthorizationDetails", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves details about an OAuth authorization request.\nUsed to display consent information to the user.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis method returns one of two response types:\n- " - }, - { - "kind": "code", - "text": "`OAuthAuthorizationDetails`" - }, - { - "kind": "text", - "text": ": User needs to consent - show consent page with client info\n- " - }, - { - "kind": "code", - "text": "`OAuthRedirect`" - }, - { - "kind": "text", - "text": ": User already consented - redirect immediately to the OAuth client\n\nUse type narrowing to distinguish between the responses:\n" - }, - { - "kind": "code", - "text": "```typescript\nif ('authorization_id' in data) {\n // Show consent page\n} else {\n // Redirect to data.redirect_url\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Authorization details or redirect URL depending on consent status" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2248, - "character": 4 - } - ], - "parameters": [ - { - "id": 2395, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID from the authorization request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2382, - "name": "AuthOAuthAuthorizationDetailsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2408, - "name": "listGrants", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2294, - "character": 4 - } - ], - "signatures": [ - { - "id": 2409, - "name": "listGrants", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth grants that the authenticated user has authorized.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Response with array of OAuth grants with client information and granted scopes" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2294, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2389, - "name": "AuthOAuthGrantsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2410, - "name": "revokeGrant", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 4 - } - ], - "signatures": [ - { - "id": 2411, - "name": "revokeGrant", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revokes a user's OAuth grant for a specific client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\nand invalidates associated refresh tokens." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Empty response on successful revocation" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 4 - } - ], - "parameters": [ - { - "id": 2412, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revocation options" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2414, - "name": "clientId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client identifier (UUID) to revoke access for" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2310, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 25 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2390, - "name": "AuthOAuthRevokeGrantResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2396, 2402, 2393, 2408, 2410] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2396, 2402, 2393, 2408, 2410] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2223, - "character": 17 - } - ] - }, - { - "id": 2492, - "name": "AuthPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lower-level two-step API and management methods for passkeys.\nAccess via " - }, - { - "kind": "code", - "text": "`supabase.auth.passkey`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "children": [ - { - "id": 2509, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2464, - "character": 4 - } - ], - "signatures": [ - { - "id": 2510, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a passkey for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2464, - "character": 4 - } - ], - "parameters": [ - { - "id": 2511, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2472, - "name": "PasskeyDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2484, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2504, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2450, - "character": 4 - } - ], - "signatures": [ - { - "id": 2505, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2450, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2482, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2498, - "name": "startAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2435, - "character": 4 - } - ], - "signatures": [ - { - "id": 2499, - "name": "startAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey authentication ceremony. Fetches an authentication\nchallenge and credential request options from the server. Used as the\nfirst step of a two-step sign-in flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.get()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2435, - "character": 4 - } - ], - "parameters": [ - { - "id": 2500, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2459, - "name": "StartPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2477, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2493, - "name": "startRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2417, - "character": 4 - } - ], - "signatures": [ - { - "id": 2494, - "name": "startRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey registration ceremony. Fetches a registration challenge\nand credential creation options from the server. Used as the first step of\na two-step registration flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.create()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2417, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2475, - "name": "AuthPasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2506, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2457, - "character": 4 - } - ], - "signatures": [ - { - "id": 2507, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a passkey's friendly name." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2457, - "character": 4 - } - ], - "parameters": [ - { - "id": 2508, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2468, - "name": "PasskeyUpdateParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2483, - "name": "AuthPasskeyUpdateResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2501, - "name": "verifyAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2443, - "character": 4 - } - ], - "signatures": [ - { - "id": 2502, - "name": "verifyAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey authentication credential against a previously issued\nchallenge. Used as the second step of a two-step sign-in flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2443, - "character": 4 - } - ], - "parameters": [ - { - "id": 2503, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2464, - "name": "VerifyPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2495, - "name": "verifyRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2425, - "character": 4 - } - ], - "signatures": [ - { - "id": 2496, - "name": "verifyRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey registration credential against a previously issued\nchallenge. Used as the second step of a two-step registration flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2425, - "character": 4 - } - ], - "parameters": [ - { - "id": 2497, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2455, - "name": "VerifyPasskeyRegistrationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2509, 2504, 2498, 2493, 2506, 2501, 2495] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2509, 2504, 2498, 2493, 2506, 2501, 2495] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2407, - "character": 17 - } - ] - }, - { - "id": 42, - "name": "AuthSession", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 45, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 247, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 259, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 47, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 255, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 44, - "name": "provider_refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 243, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 43, - "name": "provider_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 238, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 46, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A one-time used refresh token that never expires." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 251, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 49, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 260, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 50, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When using a separate user storage, accessing properties of this object will throw an error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 264, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [45, 48, 47, 44, 43, 46, 49, 50] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 234, - "character": 17 - } - ] - }, - { - "id": 15, - "name": "AuthUser", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 26, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 360, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 17, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 351, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1734, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 19, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 353, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 41, - "name": "banned_until", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 375, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 20, - "name": "confirmation_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 354, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 30, - "name": "confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 364, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 29, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 363, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 40, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 374, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 27, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 361, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 22, - "name": "email_change_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 356, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 31, - "name": "email_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 365, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 373, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - { - "type": "literal", - "value": "unverified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - ] - } - } - }, - { - "id": 16, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 350, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 370, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 25, - "name": "invited_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 359, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 37, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 371, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 38, - "name": "is_sso_user", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 372, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 33, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 367, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 23, - "name": "new_email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 357, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 24, - "name": "new_phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 358, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 28, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 362, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "phone_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 366, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 21, - "name": "recovery_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 355, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 34, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 368, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 35, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 369, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 18, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 352, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1739, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 26, 17, 19, 41, 20, 30, 29, 40, 27, 22, 31, 39, 16, 36, 25, 37, 38, 33, 23, 24, 28, - 32, 21, 34, 35, 18 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 349, - "character": 17 - } - ] - }, - { - "id": 1961, - "name": "GenerateLinkOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1962, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 776, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1963, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 778, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1962, 1963] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 770, - "character": 17 - } - ] - }, - { - "id": 2343, - "name": "GoTrueAdminCustomProvidersApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "children": [ - { - "id": 2347, - "name": "createProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2071, - "character": 4 - } - ], - "signatures": [ - { - "id": 2348, - "name": "createProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new custom OIDC/OAuth provider.\n\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\nfrom the issuer's well-known endpoint (or the provided " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": ") at creation time.\nThis may return a validation error (" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\nin the document does not match the expected issuer.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2071, - "character": 4 - } - ], - "parameters": [ - { - "id": 2349, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2288, - "name": "CreateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2357, - "name": "deleteProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 4 - } - ], - "signatures": [ - { - "id": 2358, - "name": "deleteProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a custom provider.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 4 - } - ], - "parameters": [ - { - "id": 2359, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2360, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2361, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2104, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2362, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2105, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2361, 2362] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 48 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2350, - "name": "getProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2080, - "character": 4 - } - ], - "signatures": [ - { - "id": 2351, - "name": "getProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific custom provider by identifier.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2080, - "character": 4 - } - ], - "parameters": [ - { - "id": 2352, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2344, - "name": "listProviders", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2056, - "character": 4 - } - ], - "signatures": [ - { - "id": 2345, - "name": "listProviders", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all custom providers with optional type filter.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2056, - "character": 4 - } - ], - "parameters": [ - { - "id": 2346, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2328, - "name": "ListCustomProvidersParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2332, - "name": "CustomProviderListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2353, - "name": "updateProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2094, - "character": 4 - } - ], - "signatures": [ - { - "id": 2354, - "name": "updateProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing custom provider.\n\nWhen " - }, - { - "kind": "code", - "text": "`issuer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": " is changed on an OIDC provider, the server re-fetches and\nvalidates the discovery document before persisting. This may return a validation error\n(" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery document is unreachable, invalid, or\nthe issuer does not match.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2094, - "character": 4 - } - ], - "parameters": [ - { - "id": 2355, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2356, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2309, - "name": "UpdateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2347, 2357, 2350, 2344, 2353] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2347, 2357, 2350, 2344, 2353] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2047, - "character": 17 - } - ] - }, - { - "id": 2096, - "name": "GoTrueAdminMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication administration API." - } - ], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "children": [ - { - "id": 2100, - "name": "deleteFactor", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1511, - "character": 4 - } - ], - "signatures": [ - { - "id": 2101, - "name": "deleteFactor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#unenroll", - "target": 2071 - } - ] - }, - { - "tag": "@expermental", - "content": [] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Delete a factor for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a factor for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1511, - "character": 4 - } - ], - "parameters": [ - { - "id": 2102, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2086, - "name": "AuthMFAAdminDeleteFactorParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2083, - "name": "AuthMFAAdminDeleteFactorResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2097, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1481, - "character": 4 - } - ], - "signatures": [ - { - "id": 2098, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all factors associated to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "List all factors for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "List all factors for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n factors: Factor[\n {\n id: '',\n friendly_name: 'Auth App Factor',\n factor_type: 'totp',\n status: 'verified',\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z'\n }\n ]\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1481, - "character": 4 - } - ], - "parameters": [ - { - "id": 2099, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2093, - "name": "AuthMFAAdminListFactorsParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2090, - "name": "AuthMFAAdminListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2100, 2097] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2100, 2097] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1449, - "character": 17 - } - ] - }, - { - "id": 2228, - "name": "GoTrueAdminOAuthApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "children": [ - { - "id": 2232, - "name": "createClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1810, - "character": 4 - } - ], - "signatures": [ - { - "id": 2233, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1810, - "character": 4 - } - ], - "parameters": [ - { - "id": 2234, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2198, - "name": "CreateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2242, - "name": "deleteClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 4 - } - ], - "signatures": [ - { - "id": 2243, - "name": "deleteClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 4 - } - ], - "parameters": [ - { - "id": 2244, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2245, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2246, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1841, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2247, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1842, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2246, 2247] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 44 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2235, - "name": "getClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1820, - "character": 4 - } - ], - "signatures": [ - { - "id": 2236, - "name": "getClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1820, - "character": 4 - } - ], - "parameters": [ - { - "id": 2237, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2229, - "name": "listClients", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1800, - "character": 4 - } - ], - "signatures": [ - { - "id": 2230, - "name": "listClients", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth clients with optional pagination.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1800, - "character": 4 - } - ], - "parameters": [ - { - "id": 2231, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2117, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2216, - "name": "OAuthClientListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2248, - "name": "regenerateClientSecret", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1853, - "character": 4 - } - ], - "signatures": [ - { - "id": 2249, - "name": "regenerateClientSecret", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Regenerates the secret for an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1853, - "character": 4 - } - ], - "parameters": [ - { - "id": 2250, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2238, - "name": "updateClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1830, - "character": 4 - } - ], - "signatures": [ - { - "id": 2239, - "name": "updateClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1830, - "character": 4 - } - ], - "parameters": [ - { - "id": 2240, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2241, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2207, - "name": "UpdateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2232, 2242, 2235, 2229, 2248, 2238] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2232, 2242, 2235, 2229, 2248, 2238] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1790, - "character": 17 - } - ] - }, - { - "id": 2512, - "name": "GoTrueAdminPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2516, - "name": "deletePasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2484, - "character": 4 - } - ], - "signatures": [ - { - "id": 2517, - "name": "deletePasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a specific passkey for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2484, - "character": 4 - } - ], - "parameters": [ - { - "id": 2518, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2488, - "name": "AuthPasskeyAdminDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2484, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2513, - "name": "listPasskeys", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2475, - "character": 4 - } - ], - "signatures": [ - { - "id": 2514, - "name": "listPasskeys", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2475, - "character": 4 - } - ], - "parameters": [ - { - "id": 2515, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2485, - "name": "AuthPasskeyAdminListParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2482, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2516, 2513] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2516, 2513] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2466, - "character": 17 - } - ] - }, - { - "id": 2025, - "name": "GoTrueMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication API." - } - ] - }, - "children": [ - { - "id": 2082, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1412, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "WebAuthnApi" - }, - "name": "WebAuthnApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 2035, - "name": "challenge", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1154, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1155, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1156, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1157, - "character": 4 - } - ], - "signatures": [ - { - "id": 2036, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- A phone factor sends a code to the user upon challenge. The channel defaults to " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " unless otherwise specified." - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor (WhatsApp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n channel: 'whatsapp',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor (WhatsApp)\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1154, - "character": 4 - } - ], - "parameters": [ - { - "id": 2037, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2039, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2040, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2039, 2040] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2041, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2042, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 2043, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2042, 2043] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2044, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1155, - "character": 4 - } - ], - "parameters": [ - { - "id": 2045, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1992, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2046, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2047, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2048, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2047, 2048] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2050, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 2051, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2050, 2051] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2052, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1156, - "character": 4 - } - ], - "parameters": [ - { - "id": 2053, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1993, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2054, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2055, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2056, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2055, 2056] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2058, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2059, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2058, 2059] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2060, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1157, - "character": 4 - } - ], - "parameters": [ - { - "id": 2061, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1994, - "name": "MFAChallengeParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2013, - "name": "AuthMFAChallengeResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2074, - "name": "challengeAndVerify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1346, - "character": 4 - } - ], - "signatures": [ - { - "id": 2075, - "name": "challengeAndVerify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Intended for use with only TOTP factors.\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking " - }, - { - "kind": "code", - "text": "`challengeAndVerify()`" - }, - { - "kind": "text", - "text": ".\n- Executes [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge) and [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify) in a single step." - } - ] - }, - { - "tag": "@example", - "name": "Create and verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create and verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1346, - "character": 4 - } - ], - "parameters": [ - { - "id": 2076, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2026, - "name": "enroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1081, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1082, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1083, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1084, - "character": 4 - } - ], - "signatures": [ - { - "id": 2027, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " as the " - }, - { - "kind": "code", - "text": "`factorType`" - }, - { - "kind": "text", - "text": " and use the returned " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " to create a challenge.\n- To create a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge).\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- To create and verify a TOTP challenge in a single step, see [" - }, - { - "kind": "code", - "text": "`mfa.challengeAndVerify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challengeandverify).\n- To generate a QR code for the " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " secret in Next.js, you can do the following:\n" - }, - { - "kind": "code", - "text": "```html\n{data.totp.uri}\n```" - }, - { - "kind": "text", - "text": "\n- The " - }, - { - "kind": "code", - "text": "`challenge`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`verify`" - }, - { - "kind": "text", - "text": " steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge." - } - ] - }, - { - "tag": "@example", - "name": "Enroll a time-based, one-time password (TOTP) factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'totp',\n friendlyName: 'your_friendly_name'\n})\n\n// Use the id to create a challenge.\n// The challenge can be verified by entering the code generated from the authenticator app.\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a time-based, one-time password (TOTP) factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp'\n totp: {\n qr_code: '',\n secret: '',\n uri: '',\n }\n friendly_name?: 'Important app'\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Enroll a Phone Factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'phone',\n friendlyName: 'your_friendly_name',\n phone: '+12345678',\n})\n\n// Use the id to create a challenge and send an SMS with a code to the user.\nconst { id, type, friendly_name, phone } = data\n\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a Phone Factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n friendly_name?: 'Important app',\n phone: '+5787123456'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1081, - "character": 4 - } - ], - "parameters": [ - { - "id": 2028, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2124, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2029, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1082, - "character": 4 - } - ], - "parameters": [ - { - "id": 2030, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2125, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2031, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1083, - "character": 4 - } - ], - "parameters": [ - { - "id": 2032, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2033, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1084, - "character": 4 - } - ], - "parameters": [ - { - "id": 2034, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1977, - "name": "MFAEnrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2004, - "name": "AuthMFAEnrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2079, - "name": "getAuthenticatorAssuranceLevel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1411, - "character": 4 - } - ], - "signatures": [ - { - "id": 2080, - "name": "getAuthenticatorAssuranceLevel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " (or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\nand rarely uses the network. When a JWT is provided (useful in server-side\nenvironments like Edge Functions where no session is stored), this method\nwill make a network request to validate the user and fetch their MFA factors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\n- In Supabase, having an AAL of " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\n- If the user has a verified factor, the " - }, - { - "kind": "code", - "text": "`nextLevel`" - }, - { - "kind": "text", - "text": " field will return " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": ", else, it will return " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": ".\n- An optional " - }, - { - "kind": "code", - "text": "`jwt`" - }, - { - "kind": "text", - "text": " parameter can be passed to check the AAL level of a specific JWT instead of the current session." - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details of a session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the AAL details of a session\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n currentLevel: 'aal1',\n nextLevel: 'aal2',\n currentAuthenticationMethods: [\n {\n method: 'password',\n timestamp: 1700000000\n }\n ]\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details for a specific JWT", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1411, - "character": 4 - } - ], - "parameters": [ - { - "id": 2081, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2020, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2077, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1358, - "character": 4 - } - ], - "signatures": [ - { - "id": 2078, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the list of MFA factors enabled for this user." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 2026 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 2079 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient#getUser", - "target": 1377 - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1358, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2014, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - } - } - ], - "name": "AuthMFAListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2071, - "name": "unenroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1265, - "character": 4 - } - ], - "signatures": [ - { - "id": 2072, - "name": "unenroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unenroll removes a MFA factor.\nA user has to have an " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " authenticator level in order to unenroll a " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " factor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@example", - "name": "Unenroll a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.unenroll({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Unenroll a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: ''\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1265, - "character": 4 - } - ], - "parameters": [ - { - "id": 2073, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1978, - "name": "MFAUnenrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2005, - "name": "AuthMFAUnenrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2062, - "name": "verify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1237, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1238, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1239, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1240, - "character": 4 - } - ], - "signatures": [ - { - "id": 2063, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first." - } - ] - }, - { - "tag": "@example", - "name": "Verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.verify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1237, - "character": 4 - } - ], - "parameters": [ - { - "id": 2064, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1981, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2065, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1238, - "character": 4 - } - ], - "parameters": [ - { - "id": 2066, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1982, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2067, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1239, - "character": 4 - } - ], - "parameters": [ - { - "id": 2068, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1987, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2069, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1240, - "character": 4 - } - ], - "parameters": [ - { - "id": 2070, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1989, - "name": "MFAVerifyParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [2082] - }, - { - "title": "Methods", - "children": [2035, 2074, 2026, 2079, 2077, 2071, 2062] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2035, 2074, 2026, 2079, 2077, 2071, 2062] - }, - { - "title": "Other", - "children": [2082] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 999, - "character": 17 - } - ] - }, - { - "id": 2166, - "name": "JWK", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2170, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1661, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2169, - "name": "key_ops", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1660, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2171, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1662, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2167, - "name": "kty", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1659, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2168, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2170, 2169, 2171, 2167] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1658, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2172, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1663, - "character": 4 - } - ], - "parameters": [ - { - "id": 2173, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 2146, - "name": "JwtPayload", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWT Payload containing claims for Supabase authentication tokens.\n\nRequired claims (iss, aud, exp, iat, sub, role, aal, session_id) are inherited from RequiredClaims.\nAll other claims are optional as they can be customized via Custom Access Token Hooks." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://supabase.com/docs/guides/auth/jwt-fields" - } - ] - } - ] - }, - "children": [ - { - "id": 2162, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1629, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aal" - } - }, - { - "id": 2154, - "name": "amr", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication Method References.\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1654, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1707, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - } - ] - } - }, - { - "id": 2152, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1646, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1734, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 2158, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1625, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aud" - } - }, - { - "id": 2147, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1641, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2159, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1626, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.exp" - } - }, - { - "id": 2160, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1627, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iat" - } - }, - { - "id": 2149, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1643, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2156, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1623, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iss" - } - }, - { - "id": 2150, - "name": "jti", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1644, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2151, - "name": "nbf", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1645, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2148, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1642, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2155, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1655, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2161, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1628, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.role" - } - }, - { - "id": 2163, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.session_id" - } - }, - { - "id": 2157, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1624, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.sub" - } - }, - { - "id": 2153, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1647, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1739, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2162, 2154, 2152, 2158, 2147, 2159, 2160, 2149, 2156, 2150, 2151, 2148, 2155, 2161, - 2163, 2157, 2153 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1640, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2164, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1656, - "character": 4 - } - ], - "parameters": [ - { - "id": 2165, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2136, - "name": "RequiredClaims", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1764, - "name": "Subscription", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1766, - "name": "callback", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to call every time there is an event. eg: (eventName) => {}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1767, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 14 - } - ], - "signatures": [ - { - "id": 1768, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 14 - } - ], - "parameters": [ - { - "id": 1769, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1770, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 1765, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for this subscription, set by the client.\nThis is an internal identifier used for managing callbacks and should not be\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 485, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1771, - "name": "unsubscribe", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Call this to remove the listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1772, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 17 - } - ], - "signatures": [ - { - "id": 1773, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1766, 1765, 1771] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 479, - "character": 17 - } - ] - }, - { - "id": 1112, - "name": "TracePropagationOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for trace context propagation.\n\nEnables distributed tracing across Supabase services using W3C Trace Context\nand OpenTelemetry standards. When enabled, the SDK automatically attaches\ntrace context headers (" - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": ") to outgoing\nrequests to Supabase domains. The resulting " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " appears in API\nGateway and Edge Function logs, so logs forwarded through Log Drains can\nbe correlated back to the originating client-side span.\n\nRequires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be installed in the consuming application.\nIf it is not installed, or there is no active context at request time,\npropagation silently no-ops." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Enable with defaults", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true },\n})\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://www.w3.org/TR/trace-context/" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://opentelemetry.io/docs/concepts/context-propagation/" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://supabase.com/docs/guides/telemetry/client-side-tracing" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "children": [ - { - "id": 1113, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable trace propagation. Disabled by default.\n\nWhen enabled, automatically detects and propagates active trace context\nfrom the OpenTelemetry API to outgoing Supabase requests. Trace context\nis only propagated to Supabase domains (" - }, - { - "kind": "code", - "text": "`*.supabase.co`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`*.supabase.in`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`localhost`" - }, - { - "kind": "text", - "text": ") for security — third-party hosts never receive trace headers." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 71, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1114, - "name": "respectSamplingDecision", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Respect upstream sampling decisions.\n\nWhen true (the default), trace context is not propagated if the upstream\ntrace indicates non-sampling (sampled flag = " - }, - { - "kind": "code", - "text": "`0`" - }, - { - "kind": "text", - "text": " in the " - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": "\nheader). This avoids overhead when traces are being recorded but dropped.\n\nSet to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " to always propagate, regardless of the sampling decision\n— useful when you want every Supabase request tagged with a " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": "\nfor log correlation, even if the trace itself will not be exported." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\ntrue\n```" - } - ] - }, - { - "tag": "@example", - "name": "Always propagate, ignore sampling", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L93" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113, 1114] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 53, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L53" - } - ] - }, - { - "id": 1734, - "name": "UserAppMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1735, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The first provider that the user used to sign up with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 339, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1736, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all providers that the user has linked to their account." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 343, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1735, 1736] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 335, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 1737, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 344, - "character": 4 - } - ], - "parameters": [ - { - "id": 1738, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1743, - "name": "UserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1744, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 385, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1749, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 410, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1745, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 389, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1748, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 403, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1747, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1746, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 393, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1744, 1749, 1745, 1748, 1747, 1746] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 377, - "character": 17 - } - ] - }, - { - "id": 1710, - "name": "UserIdentity", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1719, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 297, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1711, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 290, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1713, - "name": "identity_data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 292, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1714, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 292, - "character": 20 - } - ], - "indexSignatures": [ - { - "id": 1715, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 293, - "character": 8 - } - ], - "parameters": [ - { - "id": 1716, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 1717, - "name": "identity_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 295, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1720, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 298, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1718, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 296, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1721, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 299, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1712, - "name": "user_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 291, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1719, 1711, 1713, 1717, 1720, 1718, 1721, 1712] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 289, - "character": 17 - } - ] - }, - { - "id": 1739, - "name": "UserMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 346, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 1740, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 347, - "character": 4 - } - ], - "parameters": [ - { - "id": 1741, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1895, - "name": "VerifyEmailOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1896, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 671, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1899, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 676, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1900, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1902, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 683, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1901, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 678, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1902, 1901] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 676, - "character": 14 - } - ] - } - } - }, - { - "id": 1897, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 673, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1898, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 675, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1896, 1899, 1897, 1898] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 669, - "character": 17 - } - ] - }, - { - "id": 1887, - "name": "VerifyMobileOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1891, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 658, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1892, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1894, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 666, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1893, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 660, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1894, 1893] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 658, - "character": 14 - } - ] - } - } - }, - { - "id": 1888, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 653, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1889, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 655, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1890, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 657, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1906, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1891, 1888, 1889, 1890] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 651, - "character": 17 - } - ] - }, - { - "id": 1903, - "name": "VerifyTokenHashParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1904, - "name": "token_hash", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token hash used in an email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 688, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1905, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 690, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1904, 1905] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 686, - "character": 17 - } - ] - }, - { - "id": 3431, - "name": "WebSocketLike", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3474, - "name": "binaryType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3475, - "name": "bufferedAmount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3435, - "name": "CLOSED", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 5, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3434, - "name": "CLOSING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 4, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3432, - "name": "CONNECTING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 2, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3477, - "name": "dispatchEvent", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3478, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 20 - } - ], - "signatures": [ - { - "id": 3479, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 20 - } - ], - "parameters": [ - { - "id": 3480, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - }, - { - "id": 3476, - "name": "extensions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3456, - "name": "onclose", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3457, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 14 - } - ], - "signatures": [ - { - "id": 3458, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 14 - } - ], - "parameters": [ - { - "id": 3459, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3460, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "CloseEvent" - }, - "name": "CloseEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3461, - "name": "onerror", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 14 - } - ], - "signatures": [ - { - "id": 3463, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 14 - } - ], - "parameters": [ - { - "id": 3464, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3465, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3451, - "name": "onmessage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 16 - } - ], - "signatures": [ - { - "id": 3453, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 16 - } - ], - "parameters": [ - { - "id": 3454, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3455, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "MessageEvent" - }, - "name": "MessageEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3446, - "name": "onopen", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 13 - } - ], - "signatures": [ - { - "id": 3448, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 13 - } - ], - "parameters": [ - { - "id": 3449, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3450, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3433, - "name": "OPEN", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 3, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3438, - "name": "protocol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 8, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3436, - "name": "readyState", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 6, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3437, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 7, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3466, - "name": "addEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 24, - "character": 4 - } - ], - "signatures": [ - { - "id": 3467, - "name": "addEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registers an event listener on the socket (compatible with browser WebSocket API)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 3468, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3469, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3439, - "name": "close", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 12, - "character": 4 - } - ], - "signatures": [ - { - "id": 3440, - "name": "close", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Closes the socket, optionally providing a close code and reason." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 12, - "character": 4 - } - ], - "parameters": [ - { - "id": 3441, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3442, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3470, - "name": "removeEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 28, - "character": 4 - } - ], - "signatures": [ - { - "id": 3471, - "name": "removeEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a previously registered event listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 28, - "character": 4 - } - ], - "parameters": [ - { - "id": 3472, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3473, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3443, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 16, - "character": 4 - } - ], - "signatures": [ - { - "id": 3444, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends data through the socket using the underlying implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 16, - "character": 4 - } - ], - "parameters": [ - { - "id": 3445, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3474, 3475, 3435, 3434, 3432, 3477, 3476, 3456, 3461, 3451, 3446, 3433, 3438, 3436, - 3437 - ] - }, - { - "title": "Methods", - "children": [3466, 3439, 3470, 3443] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 1, - "character": 17 - } - ] - }, - { - "id": 3481, - "name": "WebSocketLikeConstructor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal WebSocket constructor interface that RealtimeClient can work with.\nSupply a compatible implementation (native WebSocket, " - }, - { - "kind": "code", - "text": "`ws`" - }, - { - "kind": "text", - "text": ", etc) when running outside the browser." - } - ] - }, - "children": [ - { - "id": 3482, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 22, - "character": 17 - } - ], - "signatures": [ - { - "id": 3483, - "name": "WebSocketLikeConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 23, - "character": 4 - } - ], - "parameters": [ - { - "id": 3484, - "name": "address", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3485, - "name": "subprotocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 3431, - "name": "WebSocketLike", - "package": "@supabase/realtime-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [3482] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 22, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3486, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 3487, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1705, - "name": "AMRMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 267, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMRMethods" - }, - "name": "AMRMethods", - "package": "@supabase/auth-js", - "preferValues": true - } - } - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1706, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 267, - "character": 64 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1589, - "name": "AuthChangeEvent", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "reference", - "target": 1588, - "name": "AuthChangeEventMFA", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1588, - "name": "AuthChangeEventMFA", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 2018, - "name": "AuthenticatorAssuranceLevels", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 973, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2019, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 973, - "character": 71 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1810, - "name": "AuthFlowType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 562, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1811, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 562, - "character": 59 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2086, - "name": "AuthMFAAdminDeleteFactorParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1424, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2087, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2088, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the MFA factor to delete." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1426, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2089, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user whose factor is being deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1428, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2088, 2089] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1424, - "character": 45 - } - ] - } - } - }, - { - "id": 2083, - "name": "AuthMFAAdminDeleteFactorResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1417, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2084, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2085, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1419, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2085] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1417, - "character": 61 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2093, - "name": "AuthMFAAdminListFactorsParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1440, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2095, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1442, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2095] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1440, - "character": 44 - } - ] - } - } - }, - { - "id": 2090, - "name": "AuthMFAAdminListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1433, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2091, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2092, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All factors attached to the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1435, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2092] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1433, - "character": 60 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2009, - "name": "AuthMFAChallengePhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 922, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponseFields" - }, - "name": "AuthMFAChallengePhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2013, - "name": "AuthMFAChallengeResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 965, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2008, - "name": "AuthMFAChallengeTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2009, - "name": "AuthMFAChallengePhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2010, - "name": "AuthMFAChallengeWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2008, - "name": "AuthMFAChallengeTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 920, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponseFields" - }, - "name": "AuthMFAChallengeTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2010, - "name": "AuthMFAChallengeWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn MFA challenge.\nContains credential creation or request options from the server." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Credential Creation", - "target": "https://w3c.github.io/webauthn/#sctn-credential-creation" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 941, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2011, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable version of WebAuthn challenge response.\nUsed for server communication with base64url-encoded binary fields." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 959, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFieldsJSON" - }, - "name": "AuthMFAChallengeWebauthnResponseFieldsJSON", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2012, - "name": "AuthMFAChallengeWebauthnServerResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server response type for WebAuthn MFA challenge.\nContains JSON-formatted WebAuthn options ready for browser API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 964, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2011, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1609, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponseFields" - }, - "name": "AuthMFAEnrollPhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2004, - "name": "AuthMFAEnrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 906, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1604, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponseFields" - }, - "name": "AuthMFAEnrollTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn factor enrollment.\nReturns the enrolled factor ID and metadata." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1616, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnFields" - }, - "name": "AuthMFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2020, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 974, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2021, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2024, - "name": "currentAuthenticationMethods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario.\n\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 993, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1707, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2022, - "name": "currentLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Current AAL level of the session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 976, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2023, - "name": "nextLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#challenge", - "target": 2035 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 983, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2024, 2022, 2023] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 974, - "character": 74 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2014, - "name": "AuthMFAListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "response of ListFactors, which should contain all the types of factors that are available, this ensures we always include all" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 967, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 2017, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - }, - "default": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2015, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2016, - "name": "all", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All available factors (verified and unverified)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 969, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2016] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 967, - "character": 106 - } - ] - } - }, - { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "reference", - "target": 2017, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2005, - "name": "AuthMFAUnenrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 907, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2006, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2007, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 909, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2007] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 907, - "character": 52 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2003, - "name": "AuthMFAVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for MFA verification operations.\nReturns session tokens on successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 905, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 1996, - "name": "AuthMFAVerifyResponseData", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1996, - "name": "AuthMFAVerifyResponseData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data returned after successful MFA verification.\nContains new session tokens and updated user information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 889, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1997, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1998, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New access token (JWT) after successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 891, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2000, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of seconds in which the access token will expire." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 895, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2001, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Refresh token you can use to obtain new access tokens when expired." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 897, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1999, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of token, always " - }, - { - "kind": "code", - "text": "`bearer`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 893, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 2002, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updated user profile." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 899, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1998, 2000, 2001, 1999, 2002] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 889, - "character": 40 - } - ] - } - } - }, - { - "id": 2382, - "name": "AuthOAuthAuthorizationDetailsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for getting OAuth authorization details.\nReturns either full authorization details (if consent needed) or redirect URL (if already consented).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase.auth.oauth.getAuthorizationDetails(authorizationId)\n\nif (error) {\n console.error('Error:', error)\n} else if ('authorization_id' in data) {\n // User needs to provide consent - show consent page\n console.log('Client:', data.client.name)\n console.log('Scopes:', data.scope)\n console.log('Redirect URI:', data.redirect_uri)\n} else {\n // User already consented - redirect immediately\n window.location.href = data.redirect_url\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2189, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2369, - "name": "OAuthAuthorizationDetails", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2379, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2383, - "name": "AuthOAuthConsentResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth consent decision (approve/deny).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2194, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2379, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2389, - "name": "AuthOAuthGrantsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing user's OAuth grants.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2211, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 2384, - "name": "OAuthGrant", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2390, - "name": "AuthOAuthRevokeGrantResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for revoking an OAuth grant.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2216, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2216, - "character": 57 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1671, - "name": "AuthOtpResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AuthOtpResponse is returned when OTP is used.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "AuthResponse" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 194, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1675, - "name": "messageId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 197, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1674, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 196, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1673, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 195, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1675, 1674, 1673] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 194, - "character": 59 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 2488, - "name": "AuthPasskeyAdminDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2399, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2489, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2491, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2401, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2490, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2400, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2491, 2490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2399, - "character": 43 - } - ] - } - } - }, - { - "id": 2485, - "name": "AuthPasskeyAdminListParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2396, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2486, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2487, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2487] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2396, - "character": 41 - } - ] - } - } - }, - { - "id": 2477, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2388, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2429, - "name": "PasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2389, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2479, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2480, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2390, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2481, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2391, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2480, 2481] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2389, - "character": 68 - } - ] - } - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2484, - "name": "AuthPasskeyDeleteResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2395, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "literal", - "value": null - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2482, - "name": "AuthPasskeyListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2393, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 2438, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2475, - "name": "AuthPasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2386, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2415, - "name": "PasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2387, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2424, - "name": "PasskeyMetadata", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2483, - "name": "AuthPasskeyUpdateResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2394, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2438, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1662, - "name": "AuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 180, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1663, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1665, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 182, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1664, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 181, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1665, 1664] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 180, - "character": 56 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1666, - "name": "AuthResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 184, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1667, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1669, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 186, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1668, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 185, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1670, - "name": "weak_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 187, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1636, - "name": "WeakPassword", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1669, 1668, 1670] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 184, - "character": 64 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1676, - "name": "AuthTokenResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 199, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1677, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1679, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 201, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1678, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 200, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1679, 1678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 199, - "character": 61 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1680, - "name": "AuthTokenResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 203, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1681, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1683, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 205, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1682, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 204, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - }, - { - "id": 1684, - "name": "weakPassword", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1636, - "name": "WeakPassword", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1683, 1682, 1684] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 203, - "character": 69 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 2109, - "name": "CallRefreshTokenResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1531, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2288, - "name": "CreateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new custom provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1938, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2289, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2295, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1950, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2298, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1956, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2299, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1958, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2305, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1970, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2293, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1946, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2294, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1948, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2303, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1966, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2301, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1962, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2300, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1960, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2291, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1942, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2302, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1964, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2308, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1976, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2292, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1944, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2297, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1954, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2290, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1940, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2296, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1952, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2304, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1968, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2306, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1972, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2307, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1974, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2295, 2298, 2299, 2305, 2293, 2294, 2303, 2301, 2300, 2291, 2302, 2308, 2292, - 2297, 2290, 2296, 2304, 2306, 2307 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1938, - "character": 41 - } - ] - } - } - }, - { - "id": 2198, - "name": "CreateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1730, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2199, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2200, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1732, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2201, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1734, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2203, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1738, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2202, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1736, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2204, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types (optional, defaults to code)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1740, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2178, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2205, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1742, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2206, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method (defaults to server default if not specified)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1744, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2200, 2201, 2203, 2202, 2204, 2205, 2206] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1730, - "character": 38 - } - ] - } - } - }, - { - "id": 2264, - "name": "CustomOAuthProvider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom OAuth/OIDC provider object returned from the admin API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1889, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2265, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2271, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1901, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2274, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1907, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2275, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1909, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2281, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1921, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2270, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1899, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2286, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1931, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2285, - "name": "discovery_document", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document (OIDC providers only)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1929, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2252, - "name": "OIDCDiscoveryDocument", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2279, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1917, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2277, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1913, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2276, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1911, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2266, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1891, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2268, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1895, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2278, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1915, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2284, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1927, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2269, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1897, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2273, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1905, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2267, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1893, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2272, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1903, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2280, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1919, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2282, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1923, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2287, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1933, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2283, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1925, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2271, 2274, 2275, 2281, 2270, 2286, 2285, 2279, 2277, 2276, 2266, 2268, 2278, - 2284, 2269, 2273, 2267, 2272, 2280, 2282, 2287, 2283 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1889, - "character": 34 - } - ] - } - } - }, - { - "id": 2332, - "name": "CustomProviderListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2033, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2333, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2334, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2034, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2335, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2336, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2035, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2264, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2336] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2034, - "character": 10 - } - ] - } - } - }, - { - "id": 2337, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2037, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2334, 2337] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2033, - "character": 41 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2339, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2039, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2340, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2341, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2040, - "character": 8 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2341] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2039, - "character": 10 - } - ] - } - } - }, - { - "id": 2342, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2042, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2339, 2342] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2038, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2331, - "name": "CustomProviderResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for custom provider operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2029, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2264, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2251, - "name": "CustomProviderType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of custom identity provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1858, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - } - }, - { - "id": 1122, - "name": "DatabaseWithoutInternals", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strips internal Supabase metadata from Database types.\nUseful for libraries defining generic constraints on Database types." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Stripping internal Supabase metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\ntype CleanDB = DatabaseWithoutInternals\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 320, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L320" - } - ], - "typeParameters": [ - { - "id": 1123, - "name": "DB", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1123, - "name": "DB", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1908, - "name": "EmailOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 693, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 693, - "character": 113 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1867, - "name": "EthereumWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 624, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "EIP1193Provider" - }, - "name": "EIP1193Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1868, - "name": "EthereumWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 625, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1869, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1870, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 626, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1873, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 631, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1874, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1876, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 635, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1877, - "name": "signInWithEthereum", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 636, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "EthereumSignInInput" - }, - "name": "EthereumSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1875, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 633, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1876, 1877, 1875] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 631, - "character": 14 - } - ] - } - } - }, - { - "id": 1872, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1871, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.ethereum`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 628, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1867, - "name": "EthereumWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1870, 1873, 1872, 1871] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 625, - "character": 38 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1878, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1879, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 639, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1880, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Ethereum compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 641, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1882, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 644, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1883, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1884, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 646, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1884] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 644, - "character": 14 - } - ] - } - } - }, - { - "id": 1881, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ethereum curve (secp256k1) signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 643, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "Hex" - }, - "name": "Hex", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1879, 1880, 1882, 1881] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 638, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1632, - "name": "ExperimentalFeatureFlags", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 126, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1633, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1634, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enables passkey support:\n - " - }, - { - "kind": "code", - "text": "`auth.signInWithPasskey()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`auth.registerPasskey()`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.passkey.*`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.admin.passkey.*`" - }, - { - "kind": "text", - "text": "\n\nDefaults to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ". Calling any passkey method while this flag is\ndisabled throws a descriptive error at call time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1634] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 126, - "character": 39 - } - ] - } - } - }, - { - "id": 1723, - "name": "Factor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A MFA factor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 2026 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#listFactors", - "target": 2077 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAAdminApi#listFactors" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 318, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1732, - "name": "Type", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 1722, - "name": "FactorType", - "package": "@supabase/auth-js" - }, - "default": { - "type": "reference", - "target": 1722, - "name": "FactorType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1733, - "name": "Status", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorVerificationStatus" - }, - "name": "FactorVerificationStatus", - "package": "@supabase/auth-js" - }, - "default": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorVerificationStatuses" - }, - "name": "FactorVerificationStatuses", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1724, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1729, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 331, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1727, - "name": "factor_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 326, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1732, - "name": "Type", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1726, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 322, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1725, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 320, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1731, - "name": "last_challenged_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 333, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1728, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification status of the factor, default is " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " after " - }, - { - "kind": "code", - "text": "`.enroll()`" - }, - { - "kind": "text", - "text": ", then " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " after the user verifies it with " - }, - { - "kind": "code", - "text": "`.verify()`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 330, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1733, - "name": "Status", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1730, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 332, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1729, 1727, 1726, 1725, 1731, 1728, 1730] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 318, - "character": 146 - } - ] - } - } - }, - { - "id": 1722, - "name": "FactorType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 305, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 868, - "name": "FunctionInvokeOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 93, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 869, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 876, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 111, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 870, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Object representing the headers to send with the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 97, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 97, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 98, - "character": 8 - } - ], - "parameters": [ - { - "id": 873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 874, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP verb of the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 103, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 875, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Region to invoke the function in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 925, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 877, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 115, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 878, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timeout for the request in milliseconds.\nIf the function takes longer than this, the request will be aborted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [876, 870, 874, 875, 877, 878] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 93, - "character": 36 - } - ] - } - } - }, - { - "id": 1955, - "name": "GenerateEmailChangeLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 760, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1956, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1958, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 763, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1959, - "name": "newEmail", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 767, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1960, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 768, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1957, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 761, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1958, 1959, 1960, 1957] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 760, - "character": 44 - } - ] - } - } - }, - { - "id": 1945, - "name": "GenerateInviteOrMagiclinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 748, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1946, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1948, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 751, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1949, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 752, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1947, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 749, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1948, 1949, 1947] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 748, - "character": 46 - } - ] - } - } - }, - { - "id": 1964, - "name": "GenerateLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 780, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1939, - "name": "GenerateSignupLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1945, - "name": "GenerateInviteOrMagiclinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1950, - "name": "GenerateRecoveryLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1955, - "name": "GenerateEmailChangeLinkParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1969, - "name": "GenerateLinkProperties", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The properties related to the email link generated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 786, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1970, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1971, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 791, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1972, - "name": "email_otp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 796, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1973, - "name": "hashed_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The hashed token appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 800, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1974, - "name": "redirect_to", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 802, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1975, - "name": "verification_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification type that the email link is associated to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 804, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1976, - "name": "GenerateLinkType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1971, 1972, 1973, 1974, 1975] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 786, - "character": 37 - } - ] - } - } - }, - { - "id": 1965, - "name": "GenerateLinkResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 781, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1966, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1967, - "name": "properties", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 782, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1969, - "name": "GenerateLinkProperties", - "package": "@supabase/auth-js" - } - }, - { - "id": 1968, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 783, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1967, 1968] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 781, - "character": 64 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1976, - "name": "GenerateLinkType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 806, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - }, - { - "id": 1950, - "name": "GenerateRecoveryLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 754, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1951, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1953, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 757, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1954, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 758, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1952, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 755, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1953, 1954, 1952] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 754, - "character": 41 - } - ] - } - } - }, - { - "id": 1939, - "name": "GenerateSignupLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 742, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1940, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1942, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 744, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1944, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 746, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1943, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 745, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1941, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 743, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1942, 1944, 1943, 1941] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 742, - "character": 39 - } - ] - } - } - }, - { - "id": 1599, - "name": "GoTrueClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 32, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1600, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1615, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 61, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1621, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 74, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 74, - "character": 23 - } - ], - "signatures": [ - { - "id": 1623, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1624, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1625, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - }, - { - "id": 1607, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if you want to automatically detect OAuth grants in the URL and sign in the user.\nSet to \"false\" to disable automatic detection.\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\nThe function receives the current URL and parsed parameters, and should return true if the URL\nshould be processed as a Supabase auth callback, or false to ignore it.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1608, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 36 - } - ], - "signatures": [ - { - "id": 1609, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1610, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1611, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1612, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 55 - } - ], - "indexSignatures": [ - { - "id": 1613, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 59, - "character": 8 - } - ], - "parameters": [ - { - "id": 1614, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1631, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 124, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1619, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 72, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/fetch.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/auth-js" - } - }, - { - "id": 1620, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 73, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1810, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1627, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if there is a custom authorization header set globally." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 93, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1602, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1603, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 34, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 1604, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 35, - "character": 8 - } - ], - "parameters": [ - { - "id": 1605, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1626, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe client coordinates refreshes itself (single-flight via\n" - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " + commit guard) and relies on the GoTrue server to\nresolve cross-tab refresh races. Passing a custom lock opts into a\nlegacy path that wraps every auth operation in your supplied lock — this\npath is preserved for backwards compatibility (typically React Native\n" - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": " or Node multi-process setups)." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\nconstructor options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 88, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1590, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - }, - { - "id": 1629, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option. Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is\npassed — the default lockless path doesn't use this timeout." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1616, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1630, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in constructor. Useful for SSR\ncontexts where initialization timing must be controlled to prevent race\nconditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 117, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1617, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 1606, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 37, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1628, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 98, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1601, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 33, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1618, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " - }, - { - "kind": "code", - "text": "`storage`" - }, - { - "kind": "text", - "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " - }, - { - "kind": "code", - "text": "`userStorage`" - }, - { - "kind": "text", - "text": " will only contain the user object under the key " - }, - { - "kind": "code", - "text": "`storageKey + '-user'`" - }, - { - "kind": "text", - "text": ".\n\nWhen this option is set and cookie storage is used, " - }, - { - "kind": "code", - "text": "`getSession()`" - }, - { - "kind": "text", - "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch a user object in those scenarios." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 71, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1615, 1621, 1607, 1631, 1619, 1620, 1627, 1602, 1626, 1629, 1616, 1630, 1617, - 1606, 1628, 1601, 1618 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 32, - "character": 34 - } - ] - } - } - }, - { - "id": 2106, - "name": "InitializeResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1528, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2107, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2108, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1529, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2108] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1528, - "character": 31 - } - ] - } - } - }, - { - "id": 2130, - "name": "JwtHeader", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1617, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2132, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1618, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "RS256" - }, - { - "type": "literal", - "value": "ES256" - }, - { - "type": "literal", - "value": "HS256" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2133, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1618, - "character": 49 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2134, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1619, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2135, - "name": "typ", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1620, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2132, 2134, 2135] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1617, - "character": 24 - } - ] - } - } - }, - { - "id": 2328, - "name": "ListCustomProvidersParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2022, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2330, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2024, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2330] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2022, - "character": 40 - } - ] - } - } - }, - { - "id": 1590, - "name": "LockFunc", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": " async function, such that no other client instances will be able to\nhold it at the same time." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1591, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 23 - } - ], - "signatures": [ - { - "id": 1592, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameters": [ - { - "id": 1598, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1593, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1594, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1595, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to execute when the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 69 - } - ], - "signatures": [ - { - "id": 1597, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1995, - "name": "MFAChallengeAndVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 884, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - }, - { - "id": 1994, - "name": "MFAChallengeParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 880, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1991, - "name": "MFAChallengeTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1992, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1993, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1992, - "name": "MFAChallengePhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 864, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParamFields" - }, - "name": "MFAChallengePhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1991, - "name": "MFAChallengeTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 859, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1993, - "name": "MFAChallengeWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for initiating a WebAuthn MFA challenge.\nIncludes Relying Party information needed for WebAuthn ceremonies." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Relying Party Operations", - "target": "https://w3c.github.io/webauthn/#sctn-rp-operations" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 879, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParamFields" - }, - "name": "MFAChallengeWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1977, - "name": "MFAEnrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 807, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2124, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2125, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2126, - "name": "MFAEnrollWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2125, - "name": "MFAEnrollPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1572, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParamFields" - }, - "name": "MFAEnrollPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2124, - "name": "MFAEnrollTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1567, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParamFields" - }, - "name": "MFAEnrollTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2126, - "name": "MFAEnrollWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for enrolling a WebAuthn factor.\nCreates an unverified WebAuthn factor that must be verified with a credential." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1579, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnFields" - }, - "name": "MFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1990, - "name": "MFATOTPChannel", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 858, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFATOTPChannels" - }, - "name": "MFATOTPChannels", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1978, - "name": "MFAUnenrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 808, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1979, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1980, - "name": "factorId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor being unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 810, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1980] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 808, - "character": 32 - } - ] - } - } - }, - { - "id": 1989, - "name": "MFAVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 852, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1981, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1982, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1987, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1982, - "name": "MFAVerifyPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 824, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParamFields" - }, - "name": "MFAVerifyPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1981, - "name": "MFAVerifyTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 822, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParamFields" - }, - "name": "MFAVerifyTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1983, - "name": "MFAVerifyWebauthnParamFields", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "WebAuthn-specific fields for MFA verification.\nSupports both credential creation (registration) and request (authentication) flows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 842, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1986, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1984, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1985, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 843, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFieldsBase" - }, - "name": "MFAVerifyWebauthnParamFieldsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnCredentialParamFields" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1986, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnCredentialParamFields", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1985] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 842, - "character": 98 - } - ] - } - } - }, - { - "id": 1987, - "name": "MFAVerifyWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for WebAuthn MFA verification.\nUsed to verify WebAuthn credentials after challenge." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Verifying an Authentication Assertion", - "target": "https://w3c.github.io/webauthn/#sctn-verifying-assertion" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 851, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1988, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1983, - "typeArguments": [ - { - "type": "reference", - "target": 1988, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1906, - "name": "MobileOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 692, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1907, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 692, - "character": 63 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2363, - "name": "OAuthAuthorizationClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client details in an authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2112, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2364, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2365, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2368, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2366, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2367, - "name": "uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's website" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2118, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2365, 2368, 2366, 2367] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2112, - "character": 39 - } - ] - } - } - }, - { - "id": 2369, - "name": "OAuthAuthorizationDetails", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth authorization details when user needs to provide consent.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response includes all information needed to display a consent page:\nclient details, user info, requested scopes, and where the user will be redirected.\n\nNote: " - }, - { - "kind": "code", - "text": "`redirect_uri`" - }, - { - "kind": "text", - "text": " is the base URI (e.g., \"https://app.com/callback\") without\nquery parameters. After consent, you'll receive a complete " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " with\nthe authorization code and state parameters appended." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2133, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2370, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2371, - "name": "authorization_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID used to approve or deny the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2373, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client requesting authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2139, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2363, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 2372, - "name": "redirect_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client's registered redirect URI (base URI without query parameters)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2378, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Space-separated list of requested scopes (e.g., \"openid profile email\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2148, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2374, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User object associated with the authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2141, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2375, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2377, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2145, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2376, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User ID (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2143, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2377, 2376] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2141, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2371, 2373, 2372, 2378, 2374] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2133, - "character": 40 - } - ] - } - } - }, - { - "id": 2182, - "name": "OAuthClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client object returned from the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1696, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2183, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2184, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1698, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2185, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1700, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2186, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client secret (only returned on registration and regeneration)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1702, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2187, - "name": "client_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1704, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2179, - "name": "OAuthClientType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2190, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1710, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2196, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2193, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1716, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2191, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1712, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2192, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1714, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2189, - "name": "registration_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registration type of the client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1708, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2180, - "name": "OAuthClientRegistrationType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2194, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1718, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2178, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2195, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2188, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1706, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 2197, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1724, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2184, 2185, 2186, 2187, 2190, 2196, 2193, 2191, 2192, 2189, 2194, 2195, 2188, - 2197 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1696, - "character": 26 - } - ] - } - } - }, - { - "id": 2176, - "name": "OAuthClientGrantType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client grant types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1671, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2177, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1671, - "character": 86 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2216, - "name": "OAuthClientListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing OAuth clients.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1774, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2217, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2218, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1775, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2219, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2221, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1777, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2220, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1776, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2182, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2221, 2220] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1775, - "character": 10 - } - ] - } - }, - { - "type": "reference", - "target": 2110, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2222, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1779, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2218, 2222] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1774, - "character": 38 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2223, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2224, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1781, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2225, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2226, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1782, - "character": 8 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2226] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1781, - "character": 10 - } - ] - } - } - }, - { - "id": 2227, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1784, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2224, 2227] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1780, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2180, - "name": "OAuthClientRegistrationType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client registration type.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1686, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - } - }, - { - "id": 2215, - "name": "OAuthClientResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth client operations.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1769, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2182, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2178, - "name": "OAuthClientResponseType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client response types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1676, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "code" - } - }, - { - "id": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client token endpoint authentication method.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1691, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - } - }, - { - "id": 2179, - "name": "OAuthClientType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client type indicating whether the client can keep credentials confidential.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1681, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - } - }, - { - "id": 2384, - "name": "OAuthGrant", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An OAuth grant representing a user's authorization of an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2199, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2386, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client information" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2201, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2363, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 2388, - "name": "granted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the grant was created (ISO 8601 date-time)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2205, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2387, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of scopes granted to this client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2203, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2386, 2388, 2387] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2199, - "character": 25 - } - ] - } - } - }, - { - "id": 2379, - "name": "OAuthRedirect", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth redirect response when user has already consented or after consent decision.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response is returned in three scenarios:\n1. User already consented to these scopes (auto-approved)\n2. User just approved the authorization request\n3. User just denied the authorization request\n\nThe " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " is a complete URL ready for redirecting the user back to the\nOAuth client, including authorization code (on success) or error (on denial) in\nquery parameters, along with the state parameter if one was provided." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2163, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2380, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2381, - "name": "redirect_url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Complete redirect URL with authorization code and state parameters (e.g., \"https://app.com/callback?code=xxx&state=yyy\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2165, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2381] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2163, - "character": 28 - } - ] - } - } - }, - { - "id": 1685, - "name": "OAuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 208, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1686, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1687, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 209, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1688, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1689, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 210, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1690, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 211, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1689, 1690] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 209, - "character": 10 - } - ] - } - } - }, - { - "id": 1691, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 213, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1687, 1691] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 208, - "character": 28 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1692, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1693, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 215, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1694, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1695, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 216, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1696, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 217, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1695, 1696] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 215, - "character": 10 - } - ] - } - } - }, - { - "id": 1697, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 219, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1693, 1697] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 214, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2252, - "name": "OIDCDiscoveryDocument", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document fields.\nPopulated when the server successfully fetches and validates the\nprovider's OpenID Connect discovery document." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1864, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2253, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2255, - "name": "authorization_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the authorization endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1868, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2254, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The issuer identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1866, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2257, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the JSON Web Key Set" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1872, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2259, - "name": "revocation_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the revocation endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1876, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2263, - "name": "supported_id_token_signing_algs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported ID token signing algorithms" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1884, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2261, - "name": "supported_response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1880, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2260, - "name": "supported_scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported scopes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1878, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2262, - "name": "supported_subject_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported subject types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1882, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2256, - "name": "token_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the token endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1870, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2258, - "name": "userinfo_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the userinfo endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1874, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2255, 2254, 2257, 2259, 2263, 2261, 2260, 2262, 2256, 2258] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1864, - "character": 36 - } - ] - } - } - }, - { - "id": 2117, - "name": "PageParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1538, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2119, - "name": "page", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The page number" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1540, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2120, - "name": "perPage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items returned per page" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1542, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2119, 2120] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1538, - "character": 25 - } - ] - } - } - }, - { - "id": 2110, - "name": "Pagination", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1532, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2113, - "name": "lastPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1535, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2112, - "name": "nextPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1534, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2114, - "name": "total", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1536, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2113, 2112, 2114] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1532, - "character": 25 - } - ], - "indexSignatures": [ - { - "id": 2115, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1533, - "character": 4 - } - ], - "parameters": [ - { - "id": 2116, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 2429, - "name": "PasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/authentication/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2331, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2430, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2431, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2332, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2433, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2334, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2432, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2333, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialRequestOptions" - }, - "name": "ServerCredentialRequestOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2431, 2433, 2432] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2331, - "character": 51 - } - ] - } - } - }, - { - "id": 2434, - "name": "PasskeyAuthenticationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/authentication/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2337, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2435, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2436, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2338, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2437, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2339, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.dom.ts", - "qualifiedName": "AuthenticationResponseJSON" - }, - "name": "AuthenticationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2436, 2437] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2337, - "character": 48 - } - ] - } - } - }, - { - "id": 2472, - "name": "PasskeyDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2382, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2473, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2474, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to delete" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2384, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2474] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2382, - "character": 34 - } - ] - } - } - }, - { - "id": 2438, - "name": "PasskeyListItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Item in the passkeys list (GET /passkeys/ and admin list)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2342, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2439, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2442, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2345, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2441, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2344, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2440, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2343, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2443, - "name": "last_used_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2346, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2442, 2441, 2440, 2443] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2342, - "character": 30 - } - ] - } - } - }, - { - "id": 2424, - "name": "PasskeyMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2325, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2425, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2428, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2328, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2427, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2327, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2426, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2326, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2428, 2427, 2426] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2325, - "character": 30 - } - ] - } - } - }, - { - "id": 2415, - "name": "PasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2314, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2416, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2417, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2315, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2419, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2317, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2418, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2316, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialCreationOptions" - }, - "name": "ServerCredentialCreationOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2417, 2419, 2418] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2314, - "character": 49 - } - ] - } - } - }, - { - "id": 2420, - "name": "PasskeyRegistrationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2320, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2421, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2422, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2321, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2423, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2322, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.dom.ts", - "qualifiedName": "RegistrationResponseJSON" - }, - "name": "RegistrationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2422, 2423] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2320, - "character": 46 - } - ] - } - } - }, - { - "id": 2468, - "name": "PasskeyUpdateParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2376, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2469, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2471, - "name": "friendlyName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New friendly name (max 120 chars)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2380, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2470, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2378, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2471, 2470] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2376, - "character": 34 - } - ] - } - } - }, - { - "id": 55, - "name": "PostgrestMaybeSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 641, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 56, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 56, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 51, - "name": "PostgrestResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 642, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 52, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 52, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 53, - "name": "PostgrestSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 640, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 54, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 54, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseFailure" - }, - "name": "PostgrestResponseFailure", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 1640, - "name": "Prettify", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resolve mapped types and show the derived keys and their types when hovering in\nVS Code, instead of just showing the names those mapped types are defined with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1641, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - } - }, - { - "id": 1587, - "name": "Provider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue. Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ], - "elementSummaries": [ - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [ - { - "kind": "text", - "text": "Uses OAuth 1.0a" - } - ], - [ - { - "kind": "text", - "text": "Uses OAuth 2.0" - } - ], - [], - [], - [], - [] - ] - } - }, - { - "id": 1117, - "name": "QueryData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ], - "typeParameters": [ - { - "id": 1120, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1120, - "name": "T", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1119, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "inferred", - "name": "U" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1119] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ] - } - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "U" - }, - "name": "U", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ], - "name": "Exclude", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 1121, - "name": "QueryError", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 309, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L309" - } - ], - "type": { - "type": "reference", - "target": 830, - "name": "PostgrestError", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 1115, - "name": "QueryResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper types for query results." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 307, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L307" - } - ], - "typeParameters": [ - { - "id": 1116, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1116, - "name": "T", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "inferred", - "name": "U" - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "U" - }, - "name": "U", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 3136, - "name": "RealtimeChannelOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3137, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3138, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 12, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3140, - "name": "broadcast", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received\nreplay option instructs server to replay broadcast messages" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 18, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3143, - "name": "ack", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 20, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3144, - "name": "replay", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 21, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "ReplayOption" - }, - "name": "ReplayOption", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3142, - "name": "self", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 19, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3143, 3144, 3142] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 18, - "character": 20 - } - ] - } - } - }, - { - "id": 3145, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "key option is used to track presence payload across clients" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3146, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3148, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 28, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3147, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 27, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3148, 3147] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 26, - "character": 19 - } - ] - } - } - }, - { - "id": 3149, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "defines if the channel is private or not and if RLS policies will be used to check data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3140, 3145, 3149] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 12, - "character": 12 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3138] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 11, - "character": 37 - } - ] - } - } - }, - { - "id": 3150, - "name": "RealtimeChannelSendResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 115, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 3151, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 115, - "character": 83 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 3273, - "name": "RealtimeClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 26, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3274, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3309, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 47, - "character": 18 - } - ], - "signatures": [ - { - "id": 3311, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 3291, - "name": "decode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - }, - { - "id": 3312, - "name": "disconnectOnEmptyChannelsAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 48, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3290, - "name": "encode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 33, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - }, - { - "id": 3306, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3296, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 36, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3297, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 36, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3298, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 37, - "character": 8 - } - ], - "parameters": [ - { - "id": 3299, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3278, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3279, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 30, - "character": 24 - } - ], - "signatures": [ - { - "id": 3280, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3281, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "HeartbeatStatus" - }, - "name": "HeartbeatStatus", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3282, - "name": "latency", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3277, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3304, - "name": "log_level", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 42, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3284, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 32, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3285, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 32, - "character": 13 - } - ], - "signatures": [ - { - "id": 3286, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3287, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3288, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3289, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3305, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3300, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 39, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3301, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 39, - "character": 13 - } - ], - "indexSignatures": [ - { - "id": 3302, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 40, - "character": 8 - } - ], - "parameters": [ - { - "id": 3303, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 3292, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 35, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3293, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 35, - "character": 23 - } - ], - "signatures": [ - { - "id": 3294, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3295, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - }, - { - "id": 3313, - "name": "sessionStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage compatible object used by the underlying socket for longpoll fallback history.\nProvide a custom implementation in environments where reading " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": "\nthrows (sandboxed iframes, in-app webviews, \"block third-party storage\" privacy modes).\nDefaults to " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": " when accessible, otherwise an in-memory store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 55, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - } - }, - { - "id": 3276, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 28, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3275, - "name": "transport", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 27, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3481, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3283, - "name": "vsn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3307, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3308, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 46, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3309, 3291, 3312, 3290, 3306, 3296, 3278, 3277, 3304, 3284, 3305, 3300, 3292, - 3313, 3276, 3275, 3283, 3307, 3308 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 26, - "character": 36 - } - ] - } - } - }, - { - "id": 3314, - "name": "RealtimeMessage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3315, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3317, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 10, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3320, - "name": "join_ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3318, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 11, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3319, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 12, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3316, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 9, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3317, 3320, 3318, 3319, 3316] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 8, - "character": 30 - } - ] - } - } - }, - { - "id": 3321, - "name": "RealtimePostgresChangesFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 97, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3327, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3398, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3322, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3323, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of database change to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 101, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3327, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3326, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive database changes when filter is matched." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 113, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3324, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database schema to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3325, - "name": "table", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database table to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3323, 3326, 3324, 3325] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 97, - "character": 99 - } - ] - } - } - }, - { - "id": 3328, - "name": "RealtimePostgresChangesPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 94, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3329, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3330, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 94, - "character": 53 - } - ], - "indexSignatures": [ - { - "id": 3331, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 95, - "character": 4 - } - ], - "parameters": [ - { - "id": 3332, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3333, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3343, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3352, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 3352, - "name": "RealtimePostgresDeletePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 87, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3358, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3359, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 87, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3360, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 88, - "character": 4 - } - ], - "parameters": [ - { - "id": 3361, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3353, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3354, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 90, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3402, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3355, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 91, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3356, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 91, - "character": 9 - } - ] - } - } - }, - { - "id": 3357, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 92, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3358, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3354, 3355, 3357] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 89, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3333, - "name": "RealtimePostgresInsertPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 73, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3339, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3340, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 73, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3341, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 74, - "character": 4 - } - ], - "parameters": [ - { - "id": 3342, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3334, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3335, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 76, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3400, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3336, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3339, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3337, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 78, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3335, 3336, 3337] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 75, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3343, - "name": "RealtimePostgresUpdatePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 80, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3348, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3349, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 80, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3350, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 81, - "character": 4 - } - ], - "parameters": [ - { - "id": 3351, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3344, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3345, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 83, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3401, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3346, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 84, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3348, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3347, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 85, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3348, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3345, 3346, 3347] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 82, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3362, - "name": "RealtimePresenceJoinPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 12, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3368, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3369, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 12, - "character": 50 - } - ], - "indexSignatures": [ - { - "id": 3370, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 13, - "character": 4 - } - ], - "parameters": [ - { - "id": 3371, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3363, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3366, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3368, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3364, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 15, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3405, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3365, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 16, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3367, - "name": "newPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3368, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3366, 3364, 3365, 3367] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 14, - "character": 5 - } - ] - } - } - }, - { - "id": 3372, - "name": "RealtimePresenceLeavePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 20, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3378, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 20, - "character": 51 - } - ], - "indexSignatures": [ - { - "id": 3380, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 21, - "character": 4 - } - ], - "parameters": [ - { - "id": 3381, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3373, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3376, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3378, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3374, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3406, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3375, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 24, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3377, - "name": "leftPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3378, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3376, 3374, 3375, 3377] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 22, - "character": 5 - } - ] - } - } - }, - { - "id": 3382, - "name": "RealtimePresenceState", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 7, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3386, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3387, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 7, - "character": 44 - } - ], - "indexSignatures": [ - { - "id": 3388, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 8, - "character": 4 - } - ], - "parameters": [ - { - "id": 3389, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 3390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 9, - "character": 4 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3383, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 9, - "character": 10 - } - ], - "indexSignatures": [ - { - "id": 3384, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 10, - "character": 4 - } - ], - "parameters": [ - { - "id": 3385, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3386, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ] - } - } - }, - { - "id": 3391, - "name": "RealtimeRemoveChannelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 3392, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 15, - "character": 85 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2450, - "name": "RegisterPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2354, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2451, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2452, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2355, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2453, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2454, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2356, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2454] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2355, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2452] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2354, - "character": 41 - } - ] - } - } - }, - { - "id": 1645, - "name": "RequestResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "a shared result type that encapsulates errors instead of throwing them, allows you to optionally specify the ErrorType" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 160, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1652, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 1653, - "name": "ErrorType", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "default": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1646, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1647, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1652, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1648, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1647, 1648] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 160, - "character": 68 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1649, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1650, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1651, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "extendsType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "trueType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "falseType": { - "type": "reference", - "target": 1653, - "name": "ErrorType", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1650, 1651] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 163, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1654, - "name": "RequestResultSafeDestructure", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "similar to RequestResult except it allows you to destructure the possible shape of the success response\n " - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "RequestResult" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 171, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1661, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1655, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1656, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 172, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1657, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 173, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1656, 1657] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 171, - "character": 46 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1658, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1659, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 175, - "character": 4 - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "object" - }, - "trueType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "literal", - "value": null - } - }, - "falseType": { - "type": "literal", - "value": null - } - } - }, - { - "id": 1660, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 178, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1659, 1660] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 174, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2136, - "name": "RequiredClaims", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1622, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2137, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2144, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1629, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - } - }, - { - "id": 2140, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1625, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2141, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1626, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2142, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1627, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2138, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1623, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2143, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1628, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2145, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2139, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1624, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2144, 2140, 2141, 2142, 2138, 2143, 2145, 2139] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1622, - "character": 29 - } - ] - } - }, - "extendedBy": [ - { - "type": "reference", - "target": 2146, - "name": "JwtPayload" - } - ] - }, - { - "id": 1910, - "name": "ResendParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 694, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1911, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1913, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 696, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1914, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 697, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1915, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1917, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 701, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1916, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 699, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1917, 1916] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 697, - "character": 14 - } - ] - } - } - }, - { - "id": 1912, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 695, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1913, 1914, 1912] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 694, - "character": 27 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1918, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1921, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 706, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1923, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 708, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1923] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 706, - "character": 14 - } - ] - } - } - }, - { - "id": 1920, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 705, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1919, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 704, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1906, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1921, 1920, 1919] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 703, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1774, - "name": "SignInAnonymouslyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 495, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1776, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 496, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1777, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1779, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 504, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1778, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 502, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1779, 1778] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 496, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1776] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 495, - "character": 43 - } - ] - } - } - }, - { - "id": 1824, - "name": "SignInWithIdTokenCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 579, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1825, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1829, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 585, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1830, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 587, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1831, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 588, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1832, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1833, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 590, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1833] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 588, - "character": 14 - } - ] - } - } - }, - { - "id": 1826, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider name or OIDC " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " value identifying which provider should be used to verify the provided token. Supported names: " - }, - { - "kind": "code", - "text": "`google`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`apple`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`azure`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`facebook`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`kakao`" - }, - { - "kind": "text", - "text": ". Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 581, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1827, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 581, - "character": 99 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1828, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC ID token issued by the specified provider. The " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " which require that you provide an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " value to be accepted properly. If the token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim you must supply the nonce used to obtain the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 583, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1829, 1830, 1831, 1826, 1828] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 579, - "character": 43 - } - ] - } - } - }, - { - "id": 1812, - "name": "SignInWithOAuthCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 563, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1813, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1815, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 566, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1819, - "name": "queryParams", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object of query params" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 572, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1820, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 572, - "character": 22 - } - ], - "indexSignatures": [ - { - "id": 1821, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 573, - "character": 12 - } - ], - "parameters": [ - { - "id": 1822, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1817, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 568, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1818, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A space-separated list of scopes granted to the OAuth application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 570, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1823, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 576, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1819, 1817, 1818, 1823] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 566, - "character": 14 - } - ] - } - } - }, - { - "id": 1814, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 565, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1815, 1814] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 563, - "character": 41 - } - ] - } - } - }, - { - "id": 2444, - "name": "SignInWithPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2348, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2446, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2349, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2448, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2449, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2351, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2448, 2449] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2349, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2446] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2348, - "character": 43 - } - ] - } - } - }, - { - "id": 1788, - "name": "SignInWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 522, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1789, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1790, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 523, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1791, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1792, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 524, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1792] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 523, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1790] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 522, - "character": 70 - } - ] - } - } - ] - } - }, - { - "id": 1793, - "name": "SignInWithPasswordlessCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 527, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1795, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 529, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1796, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 530, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1797, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1801, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 542, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1800, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 540, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1798, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The redirect url embedded in the email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 532, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1799, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 534, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1801, 1800, 1798, 1799] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 530, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1795, 1796] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 527, - "character": 48 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1802, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1804, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 547, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1805, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1808, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 557, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1809, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Messaging channel to use (e.g. whatsapp or sms)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 559, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 1807, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 555, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1806, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 549, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1808, 1809, 1807, 1806] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 547, - "character": 14 - } - ] - } - } - }, - { - "id": 1803, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 546, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1804, 1803] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 544, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1924, - "name": "SignInWithSSO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 711, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1925, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1927, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1928, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1930, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 718, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1929, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 716, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1931, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 724, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1930, 1929, 1931] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 714, - "character": 14 - } - ] - } - } - }, - { - "id": 1926, - "name": "providerId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the SSO provider to invoke single-sign on to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1927, 1926] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 711, - "character": 28 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1932, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1933, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Domain name of the organization for which to invoke single-sign on." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 728, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1934, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 729, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1935, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1937, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 733, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1936, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 731, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1938, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 739, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1937, 1936, 1938] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 729, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1933, 1934] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 726, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2121, - "name": "SignOut", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1544, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2122, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2123, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1555, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2123] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1544, - "character": 22 - } - ] - } - } - }, - { - "id": 2175, - "name": "SignOutScope", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1666, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": 2174, - "name": "SIGN_OUT_SCOPES", - "package": "@supabase/auth-js" - } - } - } - }, - { - "id": 1780, - "name": "SignUpWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 507, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1781, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1782, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 508, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1783, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1786, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 511, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1787, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 512, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 1785, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 510, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1784, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 509, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1786, 1787, 1785, 1784] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 508, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1782] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 507, - "character": 70 - } - ] - } - } - ] - } - }, - { - "id": 1834, - "name": "SolanaWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 593, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1835, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1840, - "name": "publicKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 595, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1841, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1842, - "name": "toBase58", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 596, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 596, - "character": 18 - } - ], - "signatures": [ - { - "id": 1844, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1842] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 595, - "character": 16 - } - ] - } - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1836, - "name": "signIn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 594, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1837, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 594, - "character": 13 - } - ], - "signatures": [ - { - "id": 1838, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1839, - "name": "inputs", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1845, - "name": "signMessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 598, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1846, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 598, - "character": 18 - } - ], - "signatures": [ - { - "id": 1847, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1848, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - }, - { - "id": 1849, - "name": "encoding", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "utf8" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1840, 1836, 1845] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 593, - "character": 27 - } - ] - } - } - }, - { - "id": 1850, - "name": "SolanaWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 600, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1852, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 601, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1855, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 606, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1856, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1858, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 610, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1859, - "name": "signInWithSolana", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 611, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "chain" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1857, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 608, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1858, 1859, 1857] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 606, - "character": 14 - } - ] - } - } - }, - { - "id": 1854, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 605, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1853, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.solana`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 603, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1834, - "name": "SolanaWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1852, 1855, 1854, 1853] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 600, - "character": 36 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1861, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 614, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1862, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Solana compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 616, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1864, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 619, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1865, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1866, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 621, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 619, - "character": 14 - } - ] - } - } - }, - { - "id": 1863, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ed25519 signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 618, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1861, 1862, 1864, 1863] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 613, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1698, - "name": "SSOResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 221, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1699, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1700, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " - }, - { - "kind": "code", - "text": "`window.location.href`" - }, - { - "kind": "text", - "text": " to take\nthe user to the authentication flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 229, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1700] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 221, - "character": 40 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2459, - "name": "StartPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2365, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2461, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2366, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2463, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2367, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2463] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2366, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2461] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2365, - "character": 47 - } - ] - } - } - }, - { - "id": 1642, - "name": "StrictOmit", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A stricter version of TypeScript's Omit that only allows omitting keys that actually exist.\nThis prevents typos and ensures type safety at compile time.\nUnlike regular Omit, this will error if you try to omit a non-existent key." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 156, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1643, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 1644, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1643, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1643, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1644, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1072, - "name": "SupabaseClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 96, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L96" - } - ], - "typeParameters": [ - { - "id": 1111, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1107, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth SDK. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the SDKs.\n\nWhen set, the " - }, - { - "kind": "code", - "text": "`auth`" - }, - { - "kind": "text", - "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 252, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L252" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 252, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L252" - } - ], - "signatures": [ - { - "id": 1109, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 1079, - "name": "auth", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L129" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1080, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1081, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Automatically refreshes the token for logged-in users. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 133, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L133" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1095, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 183, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L183" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "debug" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1084, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true.\n\nCan be set to a function to provide custom logic for determining if a URL contains\na Supabase auth callback. The function receives the current URL and parsed parameters,\nand should return true if the URL should be processed as a Supabase auth callback.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that\nalso return access_token in the URL fragment, which would otherwise be incorrectly\nintercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With custom detection logic", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1085, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "signatures": [ - { - "id": 1086, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1087, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1088, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1089, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "indexSignatures": [ - { - "id": 1090, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "parameters": [ - { - "id": 1091, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1098, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 206, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L206" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "experimental" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1094, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 179, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L179" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "flowType" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1096, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe auth client coordinates refreshes itself and the server resolves\ncross-tab races. Passing a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " opts into a legacy path that\nwraps every auth operation in your supplied lock." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\n" - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 194, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L194" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lock" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1099, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": ". Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is passed." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 216, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L216" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lockAcquireTimeout" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1083, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to persist a logged-in session to storage. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 141, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L141" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1100, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in the auth client constructor.\nUseful for SSR contexts where initialization timing must be controlled to\nprevent race conditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 224, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L224" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "skipAutoInitialize" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1092, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A storage provider. Used to store the logged-in session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 167, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L167" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1082, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional key name used for storing tokens in local storage." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 137, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L137" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1097, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 199, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "throwOnError" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1093, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 175, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L175" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "userStorage" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1081, 1095, 1084, 1098, 1094, 1096, 1099, 1083, 1100, 1092, 1082, 1097, - 1093 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 129, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L129" - } - ] - } - } - }, - { - "id": 1074, - "name": "db", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 100, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L100" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1075, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1076, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 101, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L101" - } - ], - "type": { - "type": "reference", - "target": 1111, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "id": 1077, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout in milliseconds for PostgREST requests.\nWhen set, requests will automatically abort after this duration to prevent indefinite hangs." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n db: { timeout: 30000 } // 30 second timeout\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 113, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1078, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length in characters before warnings/errors are triggered.\nDefaults to 8000 characters. Used to provide helpful hints when URLs\nexceed server limits." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With custom URL length limit", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n db: { urlLengthLimit: 10000 } // Custom limit\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1076, 1077, 1078] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 100, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L100" - } - ] - } - } - }, - { - "id": 1103, - "name": "global", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 231, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L231" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1105, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L235" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/supabase-js" - } - }, - { - "id": 1106, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional headers for initializing the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 239, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L239" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1105, 1106] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 231, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L231" - } - ] - } - } - }, - { - "id": 1101, - "name": "realtime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options passed to the realtime-js instance" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L229" - } - ], - "type": { - "type": "reference", - "target": 3273, - "name": "RealtimeClientOptions", - "package": "@supabase/realtime-js" - } - }, - { - "id": 1102, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 230, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L230" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageClientOptions" - }, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - }, - { - "id": 1110, - "name": "tracePropagation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable OpenTelemetry / W3C trace context propagation to Supabase services.\n\nDisabled by default. Pass " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " for the common case (auto-detect an\nactive OpenTelemetry context and inject " - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": " /\n" - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": " headers) or an object for fine-grained control.\n\nRequires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be installed in your application; if\nnot present, the SDK silently no-ops. Trace headers are only attached\nto requests targeting Supabase domains, so third-party hosts called\nthrough a custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " are never tagged.\n\nThe resulting " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " appears in Supabase logs (API Gateway, Edge\nFunctions), letting you correlate client-side spans with server-side\nlog entries — including logs forwarded via Log Drains." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Shorthand — opt in with defaults", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient(url, key, { tracePropagation: true })\n```" - } - ] - }, - { - "tag": "@example", - "name": "With an active OpenTelemetry span", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient(url, key, { tracePropagation: true })\nconst tracer = trace.getTracer('my-app')\n\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // Request carries the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Advanced — always propagate, even for non-sampled traces", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://supabase.com/docs/guides/telemetry/client-side-tracing" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://www.w3.org/TR/trace-context/" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1112, - "name": "TracePropagationOptions", - "package": "@supabase/supabase-js" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1107, 1079, 1074, 1103, 1101, 1102, 1110] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 96, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L96" - } - ] - } - } - }, - { - "id": 2103, - "name": "SupportedStorage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1518, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PromisifyMethods" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "PromisifyMethods", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 2104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2105, - "name": "isServer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1526, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2105] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1518, - "character": 103 - } - ] - } - } - ] - } - }, - { - "id": 2309, - "name": "UpdateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing custom provider.\nAll fields are optional. Only provided fields will be updated.\n" - }, - { - "kind": "code", - "text": "`provider_type`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " are immutable and cannot be changed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1983, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2314, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1991, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2317, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1997, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2318, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1999, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2324, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2011, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2312, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1987, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2313, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1989, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2322, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2007, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2320, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2003, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2319, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2001, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2321, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2005, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2327, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2017, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2311, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1985, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2316, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1995, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2315, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1993, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2323, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2009, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2325, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2013, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2326, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2015, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2314, 2317, 2318, 2324, 2312, 2313, 2322, 2320, 2319, 2321, 2327, 2311, 2316, - 2315, 2323, 2325, 2326 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1983, - "character": 41 - } - ] - } - } - }, - { - "id": 2207, - "name": "UpdateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing OAuth client.\nAll fields are optional. Only provided fields will be updated.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1751, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2208, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2209, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1753, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2210, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1755, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2213, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1761, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2211, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1757, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2212, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1759, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2214, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1763, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2209, 2210, 2213, 2211, 2212, 2214] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1751, - "character": 38 - } - ] - } - } - }, - { - "id": 1701, - "name": "UserResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 231, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1702, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1703, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 232, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1703] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 231, - "character": 56 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1886, - "name": "VerifyOtpParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 650, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1887, - "name": "VerifyMobileOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1895, - "name": "VerifyEmailOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1903, - "name": "VerifyTokenHashParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2464, - "name": "VerifyPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2370, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2465, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2466, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startAuthentication" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2372, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2467, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.get()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2374, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2466, 2467] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2370, - "character": 48 - } - ] - } - } - }, - { - "id": 2455, - "name": "VerifyPasskeyRegistrationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2359, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2456, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2457, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startRegistration" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2361, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2458, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.create()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2363, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2457, 2458] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2359, - "character": 46 - } - ] - } - } - }, - { - "id": 1636, - "name": "WeakPassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 140, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1637, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1639, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 142, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1638, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 141, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1635, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1639, 1638] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 140, - "character": 27 - } - ] - } - } - }, - { - "id": 1635, - "name": "WeakPasswordReasons", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 139, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1885, - "name": "Web3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 649, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1850, - "name": "SolanaWeb3Credentials", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1868, - "name": "EthereumWeb3Credentials", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1561, - "name": "AuthAdminApi", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/AuthAdminApi.d.ts", - "line": 2, - "character": 14 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1562, - "name": "AuthClient", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/AuthClient.d.ts", - "line": 2, - "character": 14 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1221, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1576, - "name": "lockInternals", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Debug flag for " - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": ". The auth\nclient ignores both, so this has no client-side effect." - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 14, - "character": 21 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1577, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1578, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1578] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 14, - "character": 32 - } - ] - } - } - }, - { - "id": 3412, - "name": "REALTIME_CHANNEL_STATES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 134, - "character": 21 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3414, - "name": "closed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 135, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "closed" - } - }, - { - "id": 3415, - "name": "errored", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 136, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "errored" - } - }, - { - "id": 3416, - "name": "joined", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 137, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "joined" - } - }, - { - "id": 3417, - "name": "joining", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 138, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "joining" - } - }, - { - "id": 3418, - "name": "leaving", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 139, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "leaving" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3414, 3415, 3416, 3417, 3418] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 134, - "character": 46 - } - ] - } - } - }, - { - "id": 2174, - "name": "SIGN_OUT_SCOPES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1665, - "character": 21 - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - }, - { - "id": 2, - "name": "createClient", - "variant": "declaration", - "kind": 64, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Supabase Client." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Creating a Supabase client", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('profiles').select('*')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 47, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L47" - } - ], - "signatures": [ - { - "id": 3, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 47, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L47" - } - ], - "typeParameters": [ - { - "id": 4, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 6, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 7, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 51, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [7] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 51, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L51" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 8, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "reference", - "target": 5, - "typeArguments": [ - { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - } - } - ], - "parameters": [ - { - "id": 9, - "name": "supabaseUrl", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 10, - "name": "supabaseKey", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 11, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1072, - "typeArguments": [ - { - "type": "reference", - "target": 8, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClientOptions", - "package": "@supabase/supabase-js" - } - } - ], - "type": { - "type": "reference", - "target": 941, - "typeArguments": [ - { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 8, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClient", - "package": "@supabase/supabase-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2522, - "name": "isAuthApiError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 47, - "character": 24 - } - ], - "signatures": [ - { - "id": 2523, - "name": "isAuthApiError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 47, - "character": 24 - } - ], - "parameters": [ - { - "id": 2524, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2561, - "name": "AuthApiError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2519, - "name": "isAuthError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 32, - "character": 24 - } - ], - "signatures": [ - { - "id": 2520, - "name": "isAuthError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 32, - "character": 24 - } - ], - "parameters": [ - { - "id": 2521, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2528, - "name": "isAuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 154, - "character": 24 - } - ], - "signatures": [ - { - "id": 2529, - "name": "isAuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 154, - "character": 24 - } - ], - "parameters": [ - { - "id": 2530, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2531, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 200, - "character": 24 - } - ], - "signatures": [ - { - "id": 2532, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 200, - "character": 24 - } - ], - "parameters": [ - { - "id": 2533, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2537, - "name": "isAuthRefreshDiscardedError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 238, - "character": 24 - } - ], - "signatures": [ - { - "id": 2538, - "name": "isAuthRefreshDiscardedError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 238, - "character": 24 - } - ], - "parameters": [ - { - "id": 2539, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2534, - "name": "isAuthRetryableFetchError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 214, - "character": 24 - } - ], - "signatures": [ - { - "id": 2535, - "name": "isAuthRetryableFetchError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 214, - "character": 24 - } - ], - "parameters": [ - { - "id": 2536, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2525, - "name": "isAuthSessionMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 94, - "character": 24 - } - ], - "signatures": [ - { - "id": 2526, - "name": "isAuthSessionMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 94, - "character": 24 - } - ], - "parameters": [ - { - "id": 2527, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2540, - "name": "isAuthWeakPasswordError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 268, - "character": 24 - } - ], - "signatures": [ - { - "id": 2541, - "name": "isAuthWeakPasswordError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 268, - "character": 24 - } - ], - "parameters": [ - { - "id": 2542, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1563, - "name": "navigatorLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 24 - } - ], - "signatures": [ - { - "id": 1564, - "name": "navigatorLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient", - "target": 1221 - }, - { - "kind": "text", - "text": ".\n\nYou can turn on debugging by setting the " - }, - { - "kind": "code", - "text": "`supabase.gotrue-js.locks.debug`" - }, - { - "kind": "text", - "text": "\nlocal storage item to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " - }, - { - "kind": "code", - "text": "`request`" - }, - { - "kind": "text", - "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: navigatorLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 24 - } - ], - "typeParameters": [ - { - "id": 1565, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1566, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1567, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1568, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1569, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 83 - } - ], - "signatures": [ - { - "id": 1570, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 83 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1579, - "name": "processLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 24 - } - ], - "signatures": [ - { - "id": 1580, - "name": "processLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#navigatorLock" - }, - { - "kind": "text", - "text": " in browser environments." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: processLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nawait processLock('migrate', 5000, async () => {\n await runMigration()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 24 - } - ], - "typeParameters": [ - { - "id": 1581, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1582, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1583, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1584, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1585, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 81 - } - ], - "signatures": [ - { - "id": 1586, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 81 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1581, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1581, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1704, - "name": "Session", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 234, - "character": 17 - } - ], - "target": 42 - }, - { - "id": 1742, - "name": "User", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 349, - "character": 17 - } - ], - "target": 15 - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [925, 3393, 3398, 3403, 3407] - }, - { - "title": "Classes", - "children": [ - 2561, 2543, 2666, 2649, 2796, 2633, 2724, 2695, 2758, 2740, 2617, 2579, 2775, 2597, 912, - 890, 879, 901, 1124, 1221, 1571, 57, 830, 141, 729, 559, 2822, 3152, 2813, 850, 941, - 3419 - ] - }, - { - "title": "Interfaces", - "children": [ - 1750, 1707, 2392, 2492, 42, 15, 1961, 2343, 2096, 2228, 2512, 2025, 2166, 2146, 1764, - 1112, 1734, 1743, 1710, 1739, 1895, 1887, 1903, 3431, 3481 - ] - }, - { - "title": "Type Aliases", - "children": [ - 1705, 1589, 1588, 2018, 1810, 2086, 2083, 2093, 2090, 2009, 2013, 2008, 2010, 2011, - 2012, 2128, 2004, 2127, 2129, 2020, 2014, 2005, 2003, 1996, 2382, 2383, 2389, 2390, - 1671, 2488, 2485, 2477, 2478, 2484, 2482, 2475, 2476, 2483, 1662, 1666, 1676, 1680, - 2109, 2288, 2198, 2264, 2332, 2331, 2251, 1122, 1908, 1867, 1868, 1632, 1723, 1722, 868, - 1955, 1945, 1964, 1969, 1965, 1976, 1950, 1939, 1599, 2106, 2130, 2328, 1590, 1995, - 1994, 1992, 1991, 1993, 1977, 2125, 2124, 2126, 1990, 1978, 1989, 1982, 1981, 1983, - 1987, 1906, 2363, 2369, 2182, 2176, 2216, 2180, 2215, 2178, 2181, 2179, 2384, 2379, - 1685, 2252, 2117, 2110, 2429, 2434, 2472, 2438, 2424, 2415, 2420, 2468, 55, 51, 53, - 1640, 1587, 1117, 1121, 1115, 3136, 3150, 3273, 3314, 3321, 3328, 3352, 3333, 3343, - 3362, 3372, 3382, 3391, 2450, 1645, 1654, 2136, 1910, 1774, 1824, 1812, 2444, 1788, - 1793, 1924, 2121, 2175, 1780, 1834, 1850, 1698, 2459, 1642, 1072, 2103, 2309, 2207, - 1701, 1886, 2464, 2455, 1636, 1635, 1885 - ] - }, - { - "title": "Variables", - "children": [1561, 1562, 1576, 3412, 2174] - }, - { - "title": "Functions", - "children": [2, 2522, 2519, 2528, 2531, 2537, 2534, 2525, 2540, 1563, 1579] - }, - { - "title": "References", - "children": [1704, 1742] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "children": [12, 1] - } - ], - "packageName": "@supabase/supabase-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase JS SDK

    \n\n

    Isomorphic JavaScript SDK for Supabase - combining Auth, Database, Storage, Functions, and Realtime.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/supabase-js)](https://www.npmjs.com/package/@supabase/supabase-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/supabase-js)](https://pkg.pr.new/~/supabase/supabase-js)\n\n
    \n\n## Usage\n\nFirst of all, you need to install the library:\n\n" - }, - { - "kind": "code", - "text": "```sh\nnpm install @supabase/supabase-js\n```" - }, - { - "kind": "text", - "text": "\n\nThen you're able to import the library and establish the connection with the database:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Create a single supabase client for interacting with your database\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n```" - }, - { - "kind": "text", - "text": "\n\n### UMD\n\nYou can use plain " - }, - { - "kind": "code", - "text": "`\n```" - }, - { - "kind": "text", - "text": "\n\nor even:\n\n" - }, - { - "kind": "code", - "text": "```html\n\n```" - }, - { - "kind": "text", - "text": "\n\nThen you can use it from a global " - }, - { - "kind": "code", - "text": "`supabase`" - }, - { - "kind": "text", - "text": " variable:\n\n" - }, - { - "kind": "code", - "text": "```html\n\n```" - }, - { - "kind": "text", - "text": "\n\n### ESM\n\nYou can use " - }, - { - "kind": "code", - "text": "`\n```" - }, - { - "kind": "text", - "text": "\n\n### Deno\n\nYou can use supabase-js in the Deno runtime via [JSR](https://jsr.io/@supabase/supabase-js):\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from 'jsr:@supabase/supabase-js@2'\n```" - }, - { - "kind": "text", - "text": "\n\n### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Provide a custom `fetch` implementation as an option\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n global: {\n fetch: (...args) => fetch(...args),\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n### Distributed Tracing with OpenTelemetry\n\nThe Supabase JS SDK can attach W3C/OpenTelemetry trace context headers (" - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": ") to outgoing requests, enabling end-to-end request tracing from your client application through Supabase services.\n\nTrace propagation is **opt-in** and disabled by default. When enabled, headers are only attached to requests targeting Supabase domains (" - }, - { - "kind": "code", - "text": "`*.supabase.co`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`*.supabase.in`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`localhost`" - }, - { - "kind": "text", - "text": ").\n\n#### Enable trace propagation\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {\n tracePropagation: true,\n})\n\nconst tracer = trace.getTracer('my-app')\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // This request now includes the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - }, - { - "kind": "text", - "text": "\n\nIf " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " is not installed or no active context exists, the SDK silently no-ops.\n\n#### Advanced configuration\n\n" - }, - { - "kind": "code", - "text": "```typescript\ninterface TracePropagationOptions {\n // Enable trace propagation (default: false).\n enabled?: boolean\n\n // Respect upstream sampling decisions (default: true).\n // When true, headers are skipped if the upstream trace is not sampled.\n respectSamplingDecision?: boolean\n}\n```" - }, - { - "kind": "text", - "text": "\n\n" - }, - { - "kind": "code", - "text": "```js\n// Always propagate, even for non-sampled traces.\nconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Support Policy\n\nThis section outlines the scope of support for various runtime environments in Supabase JavaScript client.\n\n### Node.js\n\nWe only support Node.js versions that are in **Active LTS** or **Maintenance** status as defined by the [official Node.js release schedule](https://nodejs.org/en/about/previous-releases#release-schedule). This means we support versions that are currently receiving long-term support and critical bug fixes.\n\nWhen a Node.js version reaches end-of-life and is no longer in Active LTS or Maintenance status, Supabase will drop it in a **minor release**, and **this won't be considered a breaking change**.\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped in version " - }, - { - "kind": "code", - "text": "`2.79.0`" - }, - { - "kind": "text", - "text": ".\n>\n> If you must use Node.js 18, please use version " - }, - { - "kind": "code", - "text": "`2.78.0`" - }, - { - "kind": "text", - "text": ", which is the last version that supported Node.js 18.\n\n### Deno\n\nWe support Deno versions that are currently receiving active development and security updates. We follow the [official Deno release schedule](https://docs.deno.com/runtime/fundamentals/stability_and_releases/) and only support versions from the " - }, - { - "kind": "code", - "text": "`stable`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`lts`" - }, - { - "kind": "text", - "text": " release channels.\n\nWhen a Deno version reaches end-of-life and is no longer receiving security updates, Supabase will drop it in a **minor release**, and **this won't be considered a breaking change**.\n\n### Browsers\n\nAll modern browsers are supported. We support browsers that provide native " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " API. For Realtime features, browsers must also support native " - }, - { - "kind": "code", - "text": "`WebSocket`" - }, - { - "kind": "text", - "text": " API.\n\n### Bun\n\nWe support Bun runtime environments. Bun provides native fetch support and is compatible with Node.js APIs. Since Bun does not follow a structured release schedule like Node.js or Deno, we support current stable versions of Bun and may drop support for older versions in minor releases without considering it a breaking change.\n\n### React Native\n\nWe support React Native environments with fetch polyfills provided by the framework. Since React Native does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.\n\n### Cloudflare Workers\n\nWe support Cloudflare Workers runtime environments. Cloudflare Workers provides native fetch support. Since Cloudflare Workers does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.\n\n### Important Notes\n\n- **Experimental features**: Features marked as experimental may be removed or changed without notice\n\n## Known Build Warnings\n\n### " - }, - { - "kind": "code", - "text": "`UNUSED_EXTERNAL_IMPORT`" - }, - { - "kind": "text", - "text": " in Vite / Rollup / Nuxt\n\nWhen bundling your app, you may see warnings like:\n\n" - }, - { - "kind": "code", - "text": "```\n\"PostgrestError\" is imported from external module \"@supabase/postgrest-js\" but never used in \"...supabase-js/dist/index.mjs\".\n\"FunctionRegion\", \"FunctionsError\", \"FunctionsFetchError\", \"FunctionsHttpError\" and \"FunctionsRelayError\" are imported from external module \"@supabase/functions-js\" but never used in \"...\".\n```" - }, - { - "kind": "text", - "text": "\n\n**This is a false positive — your bundle is fine.** Here is why it happens:\n\n" - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": " re-exports " - }, - { - "kind": "code", - "text": "`PostgrestError`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FunctionsError`" - }, - { - "kind": "text", - "text": ", and related symbols so you can import them directly from " - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": ". However, our build tool merges all imports from the same package into a single import statement in the built output:\n\n" - }, - { - "kind": "code", - "text": "```js\n// dist/index.mjs (simplified)\nimport { PostgrestClient, PostgrestError } from '@supabase/postgrest-js'\n// ^ used internally ^ re-exported for you\n```" - }, - { - "kind": "text", - "text": "\n\nYour bundler checks which names from that import are used _in the code body_, and flags " - }, - { - "kind": "code", - "text": "`PostgrestError`" - }, - { - "kind": "text", - "text": " as unused because it only appears in an " - }, - { - "kind": "code", - "text": "`export`" - }, - { - "kind": "text", - "text": " statement — not called or assigned. The export itself is the usage, but downstream bundlers don't track this correctly. This is a known Rollup/Vite limitation with re-exported external imports.\n\n**Nothing is broken.** Tree-shaking and bundle size are unaffected.\n\nTo suppress the warning:\n\n**Vite / Rollup (" - }, - { - "kind": "code", - "text": "`vite.config.js`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`rollup.config.js`" - }, - { - "kind": "text", - "text": "):**\n\n" - }, - { - "kind": "code", - "text": "```js\nexport default {\n build: {\n rollupOptions: {\n onwarn(warning, warn) {\n if (warning.code === 'UNUSED_EXTERNAL_IMPORT' && warning.exporter?.includes('@supabase/'))\n return\n warn(warning)\n },\n },\n },\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Nuxt (" - }, - { - "kind": "code", - "text": "`nuxt.config.ts`" - }, - { - "kind": "text", - "text": "):**\n\n" - }, - { - "kind": "code", - "text": "```ts\nexport default defineNuxtConfig({\n vite: {\n build: {\n rollupOptions: {\n onwarn(warning, warn) {\n if (warning.code === 'UNUSED_EXTERNAL_IMPORT' && warning.exporter?.includes('@supabase/'))\n return\n warn(warning)\n },\n },\n },\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 3 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From the monorepo root\npnpm nx build supabase-js\n\n# Or with watch mode for development\npnpm nx build supabase-js --watch\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\nThere's a complete guide on how to set up your environment for running locally the " - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " integration tests. Please refer to [TESTING.md](" - }, - { - "kind": "relative-link", - "text": "./TESTING.md", - "target": 4 - }, - { - "kind": "text", - "text": ").\n\n## Badges\n\n[![Coverage Status](https://coveralls.io/repos/github/supabase/supabase-js/badge.svg?branch=master)](https://coveralls.io/github/supabase/supabase-js?branch=master)" - } - ], - "symbolIdMap": { - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "2": { - "sourceFileName": "src/index.ts", - "qualifiedName": "createClient" - }, - "3": { - "sourceFileName": "src/index.ts", - "qualifiedName": "createClient" - }, - "4": { - "sourceFileName": "src/index.ts", - "qualifiedName": "Database" - }, - "5": { - "sourceFileName": "src/index.ts", - "qualifiedName": "SchemaNameOrClientOptions" - }, - "6": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__type" - }, - "7": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "8": { - "sourceFileName": "src/index.ts", - "qualifiedName": "SchemaName" - }, - "9": { - "sourceFileName": "src/index.ts", - "qualifiedName": "supabaseUrl" - }, - "10": { - "sourceFileName": "src/index.ts", - "qualifiedName": "supabaseKey" - }, - "11": { - "sourceFileName": "src/index.ts", - "qualifiedName": "options" - }, - "12": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "" - }, - "13": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "CorsHeaders" - }, - "14": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "corsHeaders" - }, - "15": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User" - }, - "16": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.id" - }, - "17": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.app_metadata" - }, - "18": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.user_metadata" - }, - "19": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.aud" - }, - "20": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.confirmation_sent_at" - }, - "21": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.recovery_sent_at" - }, - "22": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email_change_sent_at" - }, - "23": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.new_email" - }, - "24": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.new_phone" - }, - "25": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.invited_at" - }, - "26": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.action_link" - }, - "27": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email" - }, - "28": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.phone" - }, - "29": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.created_at" - }, - "30": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.confirmed_at" - }, - "31": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email_confirmed_at" - }, - "32": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.phone_confirmed_at" - }, - "33": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.last_sign_in_at" - }, - "34": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.role" - }, - "35": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.updated_at" - }, - "36": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.identities" - }, - "37": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.is_anonymous" - }, - "38": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.is_sso_user" - }, - "39": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.factors" - }, - "40": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.deleted_at" - }, - "41": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.banned_until" - }, - "42": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session" - }, - "43": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.provider_token" - }, - "44": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.provider_refresh_token" - }, - "45": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.access_token" - }, - "46": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.refresh_token" - }, - "47": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.expires_in" - }, - "48": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.expires_at" - }, - "49": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.token_type" - }, - "50": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.user" - }, - "51": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponse" - }, - "52": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "53": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestSingleResponse" - }, - "54": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "55": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestMaybeSingleResponse" - }, - "56": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "57": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder" - }, - "58": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "59": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder" - }, - "60": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ClientOptions" - }, - "61": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.Result$1" - }, - "62": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ThrowOnError" - }, - "63": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "64": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "65": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "66": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "67": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "68": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "69": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "70": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "71": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "72": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "73": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "74": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "75": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "76": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "77": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "78": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "79": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "80": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "81": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "82": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "83": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "84": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "85": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "86": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "87": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "88": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "89": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "90": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "91": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "92": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "93": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "94": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "95": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "96": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "97": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "98": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "99": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "100": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "101": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "102": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "103": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "104": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "105": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "106": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "107": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "108": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "109": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "110": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "111": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "112": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "113": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "114": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "115": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "116": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "117": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "118": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "119": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "120": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "121": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "122": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "123": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "124": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "125": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "127": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.returns" - }, - "128": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.returns" - }, - "129": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "130": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "131": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "132": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "133": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "134": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "135": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "136": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "137": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "138": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ClientOptions" - }, - "139": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.Result$1" - }, - "140": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ThrowOnError" - }, - "141": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder" - }, - "142": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "143": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder" - }, - "144": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions" - }, - "145": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Schema" - }, - "146": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Row" - }, - "147": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Result$1" - }, - "148": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.RelationName" - }, - "149": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Relationships" - }, - "150": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Method" - }, - "151": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "152": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "153": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "154": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "155": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "156": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "157": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "158": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "159": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "160": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "161": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "162": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "163": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "164": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "165": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "166": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "167": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "168": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "169": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "170": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "171": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "172": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.eq" - }, - "173": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.eq" - }, - "174": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "175": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "176": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "177": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "178": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.neq" - }, - "179": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.neq" - }, - "180": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "181": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "182": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "183": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "184": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "185": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "186": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "187": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "188": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "189": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "190": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "191": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "192": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "193": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "194": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "195": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "196": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "197": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "198": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "199": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "200": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "201": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "202": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "203": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "204": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "205": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "206": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "207": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "208": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "209": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "210": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "211": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "212": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "213": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "214": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "215": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "216": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "217": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "218": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "219": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "220": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "221": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "222": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "223": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "224": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "225": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "226": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "227": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "228": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "229": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "230": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "231": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "232": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "233": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "234": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "235": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "236": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "237": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "238": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "239": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "240": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "241": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "242": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "243": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "244": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "245": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "246": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "247": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "248": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "249": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "250": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "251": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "252": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "253": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "254": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "255": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "256": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "257": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "258": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "259": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "260": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "261": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "262": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "263": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "264": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "265": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "266": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "267": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "268": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "269": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "270": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "271": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "272": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "273": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "274": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "275": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "276": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "277": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "278": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "279": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "280": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "281": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "282": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "283": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "284": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "285": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "286": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "287": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.isDistinct" - }, - "288": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.isDistinct" - }, - "289": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "290": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "291": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "292": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.in" - }, - "293": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.in" - }, - "294": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "295": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "296": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "297": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.notIn" - }, - "298": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.notIn" - }, - "299": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "300": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "301": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "302": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "303": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "304": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "305": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "306": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "307": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "308": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "309": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "310": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "311": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "312": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "313": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "314": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "315": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "316": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "317": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "318": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "319": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "320": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "321": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "322": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "323": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "324": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "325": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "326": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "327": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "328": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "329": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "330": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "331": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "332": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "333": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "334": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "335": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "336": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "337": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "338": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "339": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "340": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "341": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "342": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "343": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "344": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "345": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "346": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "347": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "348": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "349": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "350": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "351": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "352": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "353": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "354": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "355": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "356": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "357": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "358": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "359": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "360": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "361": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "362": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "363": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "364": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "365": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "366": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "367": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "368": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "369": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "370": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "371": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "372": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "373": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.config" - }, - "374": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.type" - }, - "375": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "376": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "377": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "378": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "379": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "380": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.config" - }, - "381": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.type" - }, - "382": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "383": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "384": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "385": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "386": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "387": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "388": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "389": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "390": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "391": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "392": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "393": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "394": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "395": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "396": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "397": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "398": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "399": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "400": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "401": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "402": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "403": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.or" - }, - "404": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.or" - }, - "405": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "filters" - }, - "406": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "407": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "408": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "409": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "410": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "411": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "412": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "413": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "414": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "415": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "416": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "417": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "418": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "419": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "420": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "421": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "422": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "423": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResultOne" - }, - "424": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "425": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "426": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "427": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "428": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "429": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "430": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "431": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "432": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "433": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "434": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "435": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "436": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "437": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "438": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "439": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "440": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "441": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "442": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "443": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "444": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "445": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "446": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "447": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "448": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "449": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "450": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "451": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "452": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "454": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "455": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "456": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "457": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "458": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "count" - }, - "459": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "460": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "461": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "462": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "463": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "464": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "465": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "from" - }, - "466": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "to" - }, - "467": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__2" - }, - "468": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "469": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "470": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "471": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "472": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "473": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "signal" - }, - "474": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "475": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "476": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "477": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "478": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "479": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "480": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "481": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "482": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "483": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "484": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "485": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "486": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "487": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "488": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.analyze" - }, - "489": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.verbose" - }, - "490": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.settings" - }, - "491": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.buffers" - }, - "492": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.wal" - }, - "493": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.format" - }, - "494": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "495": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "496": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "497": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "498": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "499": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "500": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "501": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "502": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "503": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "504": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "505": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "506": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "507": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "508": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "509": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "510": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "511": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "512": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "513": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "514": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "515": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "516": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "517": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "518": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "519": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "520": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "521": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "522": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "523": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "524": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "525": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "526": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "527": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "528": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "529": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "530": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "531": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "532": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "533": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "534": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "535": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "536": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "537": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "538": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "539": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "540": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "541": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "542": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "543": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "544": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "545": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "546": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "547": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "548": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "549": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "550": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "551": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "552": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions" - }, - "553": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Schema" - }, - "554": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Row" - }, - "555": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Result$1" - }, - "556": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.RelationName" - }, - "557": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Relationships" - }, - "558": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Method" - }, - "559": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder" - }, - "560": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "561": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder" - }, - "562": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions" - }, - "563": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Schema" - }, - "564": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Row" - }, - "565": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Result$1" - }, - "566": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.RelationName" - }, - "567": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Relationships" - }, - "568": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Method" - }, - "569": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "570": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "571": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "572": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "573": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "574": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "575": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "576": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "577": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "578": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "579": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "580": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "581": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "582": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "583": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "584": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "585": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "586": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "587": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "588": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "589": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "590": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "591": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "592": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "593": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResultOne" - }, - "594": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "595": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "596": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "597": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "598": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "599": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "600": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "601": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "602": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "603": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "604": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "605": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "606": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "607": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "608": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "609": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "610": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "611": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "612": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "613": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "614": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "615": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "617": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "618": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "619": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "620": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "621": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "622": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "623": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "624": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "625": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "626": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "627": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "628": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "count" - }, - "629": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "630": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "631": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "632": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "633": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "634": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "635": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "from" - }, - "636": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "to" - }, - "637": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__2" - }, - "638": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "639": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "640": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "641": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "642": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "643": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "signal" - }, - "644": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "645": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "646": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "647": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "648": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "649": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "650": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "651": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "652": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "653": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "654": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "655": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "656": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "657": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "658": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.analyze" - }, - "659": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.verbose" - }, - "660": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.settings" - }, - "661": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.buffers" - }, - "662": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.wal" - }, - "663": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.format" - }, - "664": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "665": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "666": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "667": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "668": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "669": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "670": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "671": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "672": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "673": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "674": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "675": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "676": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "677": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "678": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "679": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "680": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "681": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "682": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "683": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "684": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "685": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "686": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "687": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "688": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "689": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "690": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "691": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "692": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "693": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "694": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "695": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "696": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "697": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "698": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "699": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "700": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "701": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "702": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "703": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "704": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "705": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "706": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "707": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "708": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "709": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "710": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "711": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "712": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "713": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "714": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "715": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "716": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "717": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "718": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "719": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "720": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "721": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "722": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions" - }, - "723": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Schema" - }, - "724": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Row" - }, - "725": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Result$1" - }, - "726": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.RelationName" - }, - "727": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Relationships" - }, - "728": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Method" - }, - "729": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder" - }, - "730": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.__constructor" - }, - "731": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder" - }, - "732": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions" - }, - "733": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Schema" - }, - "734": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relation$1" - }, - "735": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.RelationName" - }, - "736": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relationships" - }, - "737": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "738": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Relationships" - }, - "739": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "url" - }, - "740": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "741": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "742": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "743": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "744": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "745": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "746": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "747": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "748": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "749": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "750": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "751": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "752": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "753": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "754": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.url" - }, - "755": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.headers" - }, - "756": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.schema" - }, - "757": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.signal" - }, - "758": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.fetch" - }, - "759": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "760": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "761": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "762": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "763": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "764": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "765": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "766": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.urlLengthLimit" - }, - "767": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.retry" - }, - "769": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.select" - }, - "770": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.select" - }, - "771": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "772": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "773": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "774": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "775": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "776": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.head" - }, - "777": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "778": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "779": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.insert" - }, - "780": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.insert" - }, - "781": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "782": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "783": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "784": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "785": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "786": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "787": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "788": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "789": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "790": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "791": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.defaultToNull" - }, - "792": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.upsert" - }, - "793": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.upsert" - }, - "794": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "795": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "796": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "797": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "798": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "799": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "800": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "801": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "802": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.onConflict" - }, - "803": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ignoreDuplicates" - }, - "804": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "805": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "806": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.defaultToNull" - }, - "807": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.update" - }, - "808": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.update" - }, - "809": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "810": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "811": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "812": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Update" - }, - "813": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "814": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "815": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "816": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "817": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.delete" - }, - "818": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.delete" - }, - "819": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "820": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "821": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "822": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "823": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions" - }, - "824": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Schema" - }, - "825": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relation$1" - }, - "826": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.RelationName" - }, - "827": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relationships" - }, - "828": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "829": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Relationships" - }, - "830": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError" - }, - "831": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.__constructor" - }, - "832": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError" - }, - "833": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "context" - }, - "834": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "835": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "836": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "837": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "838": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "839": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.details" - }, - "840": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.hint" - }, - "841": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.code" - }, - "842": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.toJSON" - }, - "843": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.toJSON" - }, - "844": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "845": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.name" - }, - "846": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "847": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "848": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "849": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "850": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "851": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.__constructor" - }, - "852": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "853": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "854": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "855": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "856": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "857": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "858": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "859": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "860": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "861": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "862": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "863": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "864": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "865": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "866": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError.__isStorageError" - }, - "867": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError.namespace" - }, - "868": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionInvokeOptions" - }, - "869": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "870": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.headers" - }, - "871": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.__index" - }, - "874": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.method" - }, - "875": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.region" - }, - "876": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.body" - }, - "877": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.signal" - }, - "878": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.timeout" - }, - "879": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "880": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError.__constructor" - }, - "881": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "882": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "883": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "884": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "885": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "886": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "887": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "888": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "889": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "890": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "891": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError.__constructor" - }, - "892": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "893": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "894": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "895": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "896": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "897": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "898": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "899": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "900": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "901": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "902": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError.__constructor" - }, - "903": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "904": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "905": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "906": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "907": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "908": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "909": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "910": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "911": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "912": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError" - }, - "913": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.__constructor" - }, - "914": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError" - }, - "915": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "message" - }, - "916": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "name" - }, - "917": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "918": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "919": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "920": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "921": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "922": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "923": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "924": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "925": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion" - }, - "926": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.Any" - }, - "927": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast1" - }, - "928": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast2" - }, - "929": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSouth1" - }, - "930": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast1" - }, - "931": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast2" - }, - "932": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.CaCentral1" - }, - "933": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuCentral1" - }, - "934": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest1" - }, - "935": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest2" - }, - "936": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest3" - }, - "937": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.SaEast1" - }, - "938": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsEast1" - }, - "939": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsWest1" - }, - "940": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsWest2" - }, - "941": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default" - }, - "942": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.__constructor" - }, - "943": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default" - }, - "944": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Database" - }, - "945": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaNameOrClientOptions" - }, - "946": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "947": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "948": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaName" - }, - "949": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Schema" - }, - "950": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "951": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "952": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "953": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "954": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "955": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "956": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "957": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "958": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "959": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "960": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "961": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "supabaseUrl" - }, - "962": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "supabaseKey" - }, - "963": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "options" - }, - "964": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.auth" - }, - "965": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.realtime" - }, - "966": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storage" - }, - "967": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.realtimeUrl" - }, - "968": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.authUrl" - }, - "969": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storageUrl" - }, - "970": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functionsUrl" - }, - "971": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rest" - }, - "972": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storageKey" - }, - "973": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.fetch" - }, - "974": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "975": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "976": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "977": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "978": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "979": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "980": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "981": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.changedAccessToken" - }, - "982": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.accessToken" - }, - "983": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "984": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "985": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.headers" - }, - "986": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.settings" - }, - "987": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.supabaseUrl" - }, - "988": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.supabaseKey" - }, - "989": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functions" - }, - "990": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functions" - }, - "991": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "992": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "993": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "TableName" - }, - "994": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "Table" - }, - "995": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "relation" - }, - "996": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "997": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "ViewName" - }, - "998": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "View" - }, - "999": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "relation" - }, - "1000": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.schema" - }, - "1001": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.schema" - }, - "1002": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "DynamicSchema" - }, - "1003": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "schema" - }, - "1004": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rpc" - }, - "1005": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rpc" - }, - "1006": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "FnName" - }, - "1007": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "Args" - }, - "1008": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "FilterBuilder" - }, - "1009": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "fn" - }, - "1010": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "args" - }, - "1011": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "options" - }, - "1012": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1013": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.head" - }, - "1014": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.get" - }, - "1015": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.count" - }, - "1016": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.channel" - }, - "1017": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.channel" - }, - "1018": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "name" - }, - "1019": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "opts" - }, - "1020": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.getChannels" - }, - "1021": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.getChannels" - }, - "1022": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeChannel" - }, - "1023": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeChannel" - }, - "1024": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "channel" - }, - "1025": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "1026": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "1055": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Database" - }, - "1056": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaNameOrClientOptions" - }, - "1057": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1058": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1059": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaName" - }, - "1060": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Schema" - }, - "1061": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "1062": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1063": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1064": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1065": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "1066": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1067": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1068": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1069": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1070": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1071": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1072": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseClientOptions" - }, - "1073": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1074": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.db" - }, - "1075": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1076": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.schema" - }, - "1077": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.timeout" - }, - "1078": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "1079": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.auth" - }, - "1080": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1081": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "1082": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "1083": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "1084": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "1085": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1086": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1087": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "url" - }, - "1088": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1089": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1090": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1092": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1093": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "1094": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "1095": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "1096": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "1097": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "1098": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "1099": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "1100": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "1101": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.realtime" - }, - "1102": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1103": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.global" - }, - "1104": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1105": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "1106": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "1107": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.accessToken" - }, - "1108": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1109": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1110": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.tracePropagation" - }, - "1111": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SchemaName" - }, - "1112": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions" - }, - "1113": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions.enabled" - }, - "1114": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions.respectSamplingDecision" - }, - "1115": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryResult" - }, - "1116": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1117": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryData" - }, - "1118": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1119": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1120": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1121": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryError" - }, - "1122": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DatabaseWithoutInternals" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DB" - }, - "1124": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "1125": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.__constructor" - }, - "1126": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "1127": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__0" - }, - "1128": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1129": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.url" - }, - "1130": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.headers" - }, - "1131": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1132": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "1134": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.fetch" - }, - "1135": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1136": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1137": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1138": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1139": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1140": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1141": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1142": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.experimental" - }, - "1143": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.mfa" - }, - "1144": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.oauth" - }, - "1145": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.customProviders" - }, - "1146": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.passkey" - }, - "1147": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.url" - }, - "1148": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.headers" - }, - "1149": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1150": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "1152": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.fetch" - }, - "1153": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1154": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1155": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1156": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1157": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1158": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1159": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1160": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.experimental" - }, - "1161": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "1162": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "1163": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "jwt" - }, - "1164": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "scope" - }, - "1165": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1166": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1167": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1168": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "1169": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "1170": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "email" - }, - "1171": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "options" - }, - "1172": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1173": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1174": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.redirectTo" - }, - "1175": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "1176": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "1177": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "1178": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "1179": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "1180": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "1181": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "1182": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "1183": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "1184": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1185": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1186": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1187": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "1188": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.aud" - }, - "1189": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1190": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1191": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1192": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1193": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "1194": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1195": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "1196": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "1197": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "1198": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "1199": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "1200": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "1201": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "1202": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "1203": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "1204": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "id" - }, - "1205": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "shouldSoftDelete" - }, - "1221": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "1223": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.__constructor" - }, - "1224": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "1225": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1227": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.admin" - }, - "1228": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.mfa" - }, - "1229": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.oauth" - }, - "1230": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.passkey" - }, - "1231": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.storageKey" - }, - "1232": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.flowType" - }, - "1233": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1234": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1235": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1236": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1237": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1238": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "value" - }, - "1239": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1240": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1241": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1242": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1243": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1244": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "value" - }, - "1245": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshToken" - }, - "1246": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.persistSession" - }, - "1247": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.storage" - }, - "1248": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.userStorage" - }, - "1249": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.memoryStorage" - }, - "1250": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1251": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1253": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stateChangeEmitters" - }, - "1254": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshTicker" - }, - "1255": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshTickTimeout" - }, - "1256": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.visibilityChangedCallback" - }, - "1257": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1258": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1259": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshingDeferred" - }, - "1260": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._sessionRemovalEpoch" - }, - "1261": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initializePromise" - }, - "1262": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.detectSessionInUrl" - }, - "1263": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1264": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1265": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "url" - }, - "1266": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1267": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1268": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1270": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.url" - }, - "1271": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.headers" - }, - "1272": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1273": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1275": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.hasCustomAuthorizationHeader" - }, - "1276": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.suppressGetSessionWarning" - }, - "1277": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.fetch" - }, - "1278": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1279": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1280": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1281": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1282": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1283": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1284": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1285": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lock" - }, - "1286": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lockAcquired" - }, - "1287": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.pendingInLock" - }, - "1288": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1289": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lockAcquireTimeout" - }, - "1290": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.experimental" - }, - "1291": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.broadcastChannel" - }, - "1292": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.logDebugMessages" - }, - "1293": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.logger" - }, - "1294": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1295": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1296": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "message" - }, - "1297": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "args" - }, - "1298": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "1299": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "1303": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "1304": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "1306": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "1307": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "1308": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1309": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "1310": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "1311": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1312": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "1313": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "1314": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1315": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "1316": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "1317": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1318": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "1319": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "1320": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "authCode" - }, - "1321": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "1322": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "1323": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1324": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1325": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1326": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1327": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1328": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "1329": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1330": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1331": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1332": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1333": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1334": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "1335": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1339": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "1340": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "1341": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1342": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "1343": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "1344": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1345": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "1346": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "1347": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1348": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "1349": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "1350": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1351": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "1352": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "1354": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "1355": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "1356": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1357": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "1358": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "1359": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1360": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1361": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1362": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1363": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1364": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1365": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1366": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1368": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1369": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1370": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1371": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1372": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1373": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1377": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "1378": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "1379": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "1381": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "1382": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "1383": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "1384": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1385": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1386": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1387": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._updateUser" - }, - "1388": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._updateUser" - }, - "1389": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "1390": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1391": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1392": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1393": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "1394": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "1395": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1396": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1397": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "1398": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1399": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._setSession" - }, - "1400": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._setSession" - }, - "1401": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1402": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "1404": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1405": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "1406": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "1407": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1408": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1409": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1410": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._refreshSession" - }, - "1411": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._refreshSession" - }, - "1412": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1413": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1414": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1418": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "1419": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "1420": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1421": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1422": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1423": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._signOut" - }, - "1424": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._signOut" - }, - "1425": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__0" - }, - "1426": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1427": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1428": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1429": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1430": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "1431": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1432": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1433": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "1434": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "1435": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1436": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1437": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1438": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "1439": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1440": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "1441": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1442": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1443": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "1444": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "1445": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1446": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1447": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1448": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "1450": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "1451": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "1452": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "email" - }, - "1453": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1454": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1455": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.redirectTo" - }, - "1456": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.captchaToken" - }, - "1457": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1458": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1459": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1460": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1461": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1462": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1463": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1464": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "1465": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "1466": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1467": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1468": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1469": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.identities" - }, - "1470": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1471": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1472": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1473": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1474": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1475": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1476": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1477": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1478": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1481": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "1482": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "1483": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "identity" - }, - "1484": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1485": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1486": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1487": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1488": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1489": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1490": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1502": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "1503": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "1504": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "1505": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "1506": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "1507": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "1525": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "1526": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "1527": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "1528": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1529": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1530": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1531": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.allowExpired" - }, - "1532": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.jwks" - }, - "1533": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1534": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1535": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1536": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1537": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1538": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.claims" - }, - "1539": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.header" - }, - "1540": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.signature" - }, - "1541": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1542": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1543": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1544": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1545": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1546": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1547": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1548": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "1549": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "1550": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1551": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "1552": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "1553": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1561": { - "sourceFileName": "../auth-js/src/AuthAdminApi.ts", - "qualifiedName": "AuthAdminApi" - }, - "1562": { - "sourceFileName": "../auth-js/src/AuthClient.ts", - "qualifiedName": "AuthClient" - }, - "1563": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "1564": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "1565": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "R" - }, - "1566": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "name" - }, - "1567": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "1568": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "fn" - }, - "1569": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1570": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1571": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "1572": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.__constructor" - }, - "1573": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "1574": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "message" - }, - "1575": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.isAcquireTimeout" - }, - "1576": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "internals" - }, - "1577": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1578": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type.debug" - }, - "1579": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "1580": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "1581": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "R" - }, - "1582": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "name" - }, - "1583": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "1584": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "fn" - }, - "1585": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1586": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1587": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Provider" - }, - "1588": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthChangeEventMFA" - }, - "1589": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthChangeEvent" - }, - "1590": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "LockFunc" - }, - "1591": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1592": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1593": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "name" - }, - "1594": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "acquireTimeout" - }, - "1595": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "fn" - }, - "1596": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1597": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1598": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "R" - }, - "1599": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueClientOptions" - }, - "1600": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1601": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1602": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "1603": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1604": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1606": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "1607": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "1608": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1609": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1610": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "url" - }, - "1611": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "1612": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1613": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1615": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "1616": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "1617": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1618": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "1619": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "1620": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "1621": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "1622": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1623": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1624": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "message" - }, - "1625": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "args" - }, - "1626": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "1627": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.hasCustomAuthorizationHeader" - }, - "1628": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "1629": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "1630": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "1631": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "1632": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ExperimentalFeatureFlags" - }, - "1633": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1634": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkey" - }, - "1635": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "1636": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPassword" - }, - "1637": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1638": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.reasons" - }, - "1639": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1640": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Prettify" - }, - "1641": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1642": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "StrictOmit" - }, - "1643": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1644": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "1645": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequestResult" - }, - "1646": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1647": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1648": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1649": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1650": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1651": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1652": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1653": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ErrorType" - }, - "1654": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequestResultSafeDestructure" - }, - "1655": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1656": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1657": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1658": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1659": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1660": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1661": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1662": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthResponse" - }, - "1663": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1664": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1665": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1666": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthResponsePassword" - }, - "1667": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1668": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1669": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1670": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.weak_password" - }, - "1671": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOtpResponse" - }, - "1672": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1673": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1674": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1675": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.messageId" - }, - "1676": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthTokenResponse" - }, - "1677": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1678": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1679": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1680": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthTokenResponsePassword" - }, - "1681": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1682": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1683": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1684": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.weakPassword" - }, - "1685": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthResponse" - }, - "1686": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1687": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1688": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1689": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1690": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1691": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1692": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1693": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1694": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1695": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1696": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1697": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1698": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SSOResponse" - }, - "1699": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1700": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1701": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserResponse" - }, - "1702": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1703": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1704": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session" - }, - "1705": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMRMethod" - }, - "1706": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1707": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry" - }, - "1708": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry.method" - }, - "1709": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry.timestamp" - }, - "1710": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity" - }, - "1711": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.id" - }, - "1712": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.user_id" - }, - "1713": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_data" - }, - "1714": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1715": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1717": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_id" - }, - "1718": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.provider" - }, - "1719": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.created_at" - }, - "1720": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.last_sign_in_at" - }, - "1721": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.updated_at" - }, - "1722": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorType" - }, - "1723": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Factor" - }, - "1724": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1725": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1726": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1727": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factor_type" - }, - "1728": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.status" - }, - "1729": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1730": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1731": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.last_challenged_at" - }, - "1732": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Type" - }, - "1733": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Status" - }, - "1734": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata" - }, - "1735": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.provider" - }, - "1736": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.providers" - }, - "1737": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.__index" - }, - "1739": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserMetadata" - }, - "1740": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserMetadata.__index" - }, - "1742": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User" - }, - "1743": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes" - }, - "1744": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.current_password" - }, - "1745": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.email" - }, - "1746": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.phone" - }, - "1747": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.password" - }, - "1748": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.nonce" - }, - "1749": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.data" - }, - "1750": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes" - }, - "1751": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.user_metadata" - }, - "1752": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.app_metadata" - }, - "1753": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.email_confirm" - }, - "1754": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.phone_confirm" - }, - "1755": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.ban_duration" - }, - "1756": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.role" - }, - "1757": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.password_hash" - }, - "1758": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.id" - }, - "1759": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "nonce" - }, - "1760": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "email" - }, - "1761": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "password" - }, - "1762": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "phone" - }, - "1763": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "current_password" - }, - "1764": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription" - }, - "1765": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.id" - }, - "1766": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.callback" - }, - "1767": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1768": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1769": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "event" - }, - "1770": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "session" - }, - "1771": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.unsubscribe" - }, - "1772": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1773": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1774": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInAnonymouslyCredentials" - }, - "1775": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1776": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1777": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1778": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1779": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1780": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignUpWithPasswordCredentials" - }, - "1781": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1782": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1783": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1784": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1785": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1786": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1787": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "1788": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasswordCredentials" - }, - "1789": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1790": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1791": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1792": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1793": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasswordlessCredentials" - }, - "1794": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1795": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1796": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1797": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1798": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1799": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "1800": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1801": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1802": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1803": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1804": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1805": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1806": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "1807": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1808": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1809": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "1810": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthFlowType" - }, - "1811": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1812": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithOAuthCredentials" - }, - "1813": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1814": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1815": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1816": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1817": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1818": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1819": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.queryParams" - }, - "1820": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1821": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1823": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1824": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithIdTokenCredentials" - }, - "1825": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1826": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1827": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1828": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token" - }, - "1829": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1830": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nonce" - }, - "1831": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1832": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1833": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1834": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SolanaWallet" - }, - "1835": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1836": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signIn" - }, - "1837": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1838": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1839": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "inputs" - }, - "1840": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.publicKey" - }, - "1841": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1842": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.toBase58" - }, - "1843": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1844": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1845": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signMessage" - }, - "1846": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1847": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1848": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "message" - }, - "1849": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "encoding" - }, - "1850": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SolanaWeb3Credentials" - }, - "1851": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1852": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1853": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1854": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1855": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1856": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1857": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1858": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1859": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signInWithSolana" - }, - "1860": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1861": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1862": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1863": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1864": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1865": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1866": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1867": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EthereumWallet" - }, - "1868": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EthereumWeb3Credentials" - }, - "1869": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1870": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1871": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1872": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1873": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1874": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1875": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1876": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1877": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signInWithEthereum" - }, - "1878": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1879": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1880": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1881": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1882": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1883": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1884": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1885": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Web3Credentials" - }, - "1886": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyOtpParams" - }, - "1887": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams" - }, - "1888": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.phone" - }, - "1889": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.token" - }, - "1890": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.type" - }, - "1891": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.options" - }, - "1892": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1893": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1894": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1895": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams" - }, - "1896": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.email" - }, - "1897": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.token" - }, - "1898": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.type" - }, - "1899": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.options" - }, - "1900": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1901": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1902": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1903": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams" - }, - "1904": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.token_hash" - }, - "1905": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.type" - }, - "1906": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MobileOtpType" - }, - "1907": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1908": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EmailOtpType" - }, - "1909": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1910": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ResendParams" - }, - "1911": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1912": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1913": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1914": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1915": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1916": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1917": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1918": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1919": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1920": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1921": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1922": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1923": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1924": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithSSO" - }, - "1925": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1926": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providerId" - }, - "1927": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1928": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1929": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1930": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1931": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1932": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1933": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.domain" - }, - "1934": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1935": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1936": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1937": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1938": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1939": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateSignupLinkParams" - }, - "1940": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1941": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1942": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1943": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.password" - }, - "1944": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1945": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateInviteOrMagiclinkParams" - }, - "1946": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1947": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1948": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1949": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1950": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateRecoveryLinkParams" - }, - "1951": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1952": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1953": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1954": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1955": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateEmailChangeLinkParams" - }, - "1956": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1957": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1958": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1959": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.newEmail" - }, - "1960": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1961": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions" - }, - "1962": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.data" - }, - "1963": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.redirectTo" - }, - "1964": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkParams" - }, - "1965": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkResponse" - }, - "1966": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1967": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.properties" - }, - "1968": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1969": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkProperties" - }, - "1970": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1971": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.action_link" - }, - "1972": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_otp" - }, - "1973": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.hashed_token" - }, - "1974": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_to" - }, - "1975": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.verification_type" - }, - "1976": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkType" - }, - "1977": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParams" - }, - "1978": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAUnenrollParams" - }, - "1979": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1980": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factorId" - }, - "1981": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParams" - }, - "1982": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParams" - }, - "1983": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFields" - }, - "1984": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1985": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.webauthn" - }, - "1986": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1987": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParams" - }, - "1988": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1989": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParams" - }, - "1990": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFATOTPChannel" - }, - "1991": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeTOTPParams" - }, - "1992": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParams" - }, - "1993": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParams" - }, - "1994": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParams" - }, - "1995": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyParams" - }, - "1996": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponseData" - }, - "1997": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1998": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1999": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_type" - }, - "2000": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_in" - }, - "2001": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.refresh_token" - }, - "2002": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2003": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponse" - }, - "2004": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponse" - }, - "2005": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAUnenrollResponse" - }, - "2006": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2007": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2008": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponse" - }, - "2009": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponse" - }, - "2010": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponse" - }, - "2011": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseDataJSON" - }, - "2012": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnServerResponse" - }, - "2013": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponse" - }, - "2014": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAListFactorsResponse" - }, - "2015": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2016": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.all" - }, - "2017": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "2018": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthenticatorAssuranceLevels" - }, - "2019": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2020": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - }, - "2021": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2022": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.currentLevel" - }, - "2023": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nextLevel" - }, - "2024": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.currentAuthenticationMethods" - }, - "2025": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi" - }, - "2026": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2027": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2028": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2029": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2030": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2031": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2032": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2033": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2034": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2035": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2036": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2037": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2038": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2039": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2040": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2041": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2042": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2043": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2044": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2045": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2046": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2047": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2048": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2049": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2050": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2051": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2052": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2053": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2054": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2055": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2056": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2057": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2058": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2059": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2060": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2061": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2062": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2063": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2064": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2065": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2066": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2067": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2068": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2069": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2070": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2071": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "2072": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "2073": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2074": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "2075": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "2076": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2077": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "2078": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "2079": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "2080": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "2081": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "jwt" - }, - "2082": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.webauthn" - }, - "2083": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorResponse" - }, - "2084": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2085": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2086": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorParams" - }, - "2087": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2088": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2089": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2090": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsResponse" - }, - "2091": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2092": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factors" - }, - "2093": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsParams" - }, - "2094": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2095": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2096": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi" - }, - "2097": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "2098": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "2099": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2100": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "2101": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "2102": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2103": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SupportedStorage" - }, - "2104": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2105": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.isServer" - }, - "2106": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "InitializeResult" - }, - "2107": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2108": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2109": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CallRefreshTokenResult" - }, - "2110": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Pagination" - }, - "2111": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2112": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nextPage" - }, - "2113": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lastPage" - }, - "2114": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.total" - }, - "2115": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "2117": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PageParams" - }, - "2118": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2119": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.page" - }, - "2120": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.perPage" - }, - "2121": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignOut" - }, - "2122": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2123": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2124": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParams" - }, - "2125": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParams" - }, - "2126": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnParams" - }, - "2127": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponse" - }, - "2128": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponse" - }, - "2129": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnResponse" - }, - "2130": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtHeader" - }, - "2131": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2132": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.alg" - }, - "2133": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2134": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.kid" - }, - "2135": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.typ" - }, - "2136": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequiredClaims" - }, - "2137": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2138": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "2139": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "2140": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2141": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "2142": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "2143": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "2144": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "2145": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "2146": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload" - }, - "2147": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.email" - }, - "2148": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.phone" - }, - "2149": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.is_anonymous" - }, - "2150": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.jti" - }, - "2151": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.nbf" - }, - "2152": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.app_metadata" - }, - "2153": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.user_metadata" - }, - "2154": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.amr" - }, - "2155": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.ref" - }, - "2156": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "2157": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "2158": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2159": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "2160": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "2161": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "2162": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "2163": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "2164": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.__index" - }, - "2166": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK" - }, - "2167": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.kty" - }, - "2168": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2169": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.key_ops" - }, - "2170": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.alg" - }, - "2171": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.kid" - }, - "2172": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.__index" - }, - "2174": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SIGN_OUT_SCOPES" - }, - "2175": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignOutScope" - }, - "2176": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientGrantType" - }, - "2177": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2178": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientResponseType" - }, - "2179": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientType" - }, - "2180": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientRegistrationType" - }, - "2181": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientTokenEndpointAuthMethod" - }, - "2182": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClient" - }, - "2183": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2184": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2185": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2186": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2187": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_type" - }, - "2188": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2189": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.registration_type" - }, - "2190": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2191": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2192": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2193": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2194": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "2195": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2196": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2197": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "2198": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CreateOAuthClientParams" - }, - "2199": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2200": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2201": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2202": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2203": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2204": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "2205": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2206": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2207": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UpdateOAuthClientParams" - }, - "2208": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2209": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2210": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2211": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2212": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2213": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2214": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2215": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientResponse" - }, - "2216": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientListResponse" - }, - "2217": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2218": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2219": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2220": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "2221": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2222": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2223": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2224": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2225": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2226": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "2227": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2228": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi" - }, - "2229": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "2230": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "2231": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2232": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "2233": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "2234": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2235": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "2236": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "2237": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2238": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "2239": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "2240": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2241": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2242": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "2243": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "2244": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2245": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2246": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2247": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2248": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "2249": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "2250": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2251": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderType" - }, - "2252": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OIDCDiscoveryDocument" - }, - "2253": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2254": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2255": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_endpoint" - }, - "2256": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint" - }, - "2257": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2258": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_endpoint" - }, - "2259": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.revocation_endpoint" - }, - "2260": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_scopes" - }, - "2261": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_response_types" - }, - "2262": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_subject_types" - }, - "2263": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_id_token_signing_algs" - }, - "2264": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomOAuthProvider" - }, - "2265": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2266": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2267": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "2268": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "2269": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2270": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2271": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2272": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2273": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2274": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2275": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2276": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2277": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2278": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2279": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2280": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2281": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2282": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2283": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2284": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2285": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_document" - }, - "2286": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2287": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "2288": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CreateCustomProviderParams" - }, - "2289": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2290": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "2291": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "2292": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2293": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2294": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2295": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2296": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2297": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2298": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2299": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2300": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2301": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2302": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2303": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2304": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2305": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2306": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2307": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2308": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2309": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UpdateCustomProviderParams" - }, - "2310": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2311": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2312": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2313": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2314": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2315": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2316": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2317": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2318": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2319": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2320": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2321": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2322": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2323": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2324": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2325": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2326": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2327": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2328": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ListCustomProvidersParams" - }, - "2329": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2330": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "2331": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderResponse" - }, - "2332": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderListResponse" - }, - "2333": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2334": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2335": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2336": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "2337": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2338": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2339": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2340": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2341": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "2342": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2343": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi" - }, - "2344": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "2345": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "2346": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2347": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "2348": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "2349": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2350": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "2351": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "2352": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2353": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "2354": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "2355": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2356": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2357": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "2358": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "2359": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2360": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2361": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2362": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2363": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationClient" - }, - "2364": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2365": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2366": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2367": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.uri" - }, - "2368": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2369": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationDetails" - }, - "2370": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2371": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_id" - }, - "2372": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uri" - }, - "2373": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "2374": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2375": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2376": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2377": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "2378": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2379": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthRedirect" - }, - "2380": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2381": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_url" - }, - "2382": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthAuthorizationDetailsResponse" - }, - "2383": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthConsentResponse" - }, - "2384": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthGrant" - }, - "2385": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2386": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "2387": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2388": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.granted_at" - }, - "2389": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthGrantsResponse" - }, - "2390": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthRevokeGrantResponse" - }, - "2391": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2392": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi" - }, - "2393": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "2394": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "2395": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2396": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "2397": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "2398": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2399": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2400": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2401": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "2402": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "2403": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "2404": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2405": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2406": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2407": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "2408": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "2409": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "2410": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "2411": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "2412": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2413": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2414": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clientId" - }, - "2415": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationOptionsResponse" - }, - "2416": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2417": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2418": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2419": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "2420": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationVerifyParams" - }, - "2421": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2422": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2423": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2424": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyMetadata" - }, - "2425": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2426": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2427": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "2428": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2429": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationOptionsResponse" - }, - "2430": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2431": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2432": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2433": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "2434": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationVerifyParams" - }, - "2435": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2436": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2437": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2438": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyListItem" - }, - "2439": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2440": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2441": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "2442": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2443": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.last_used_at" - }, - "2444": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasskeyCredentials" - }, - "2445": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2446": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2447": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2448": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "2449": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "2450": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RegisterPasskeyCredentials" - }, - "2451": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2452": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2453": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2454": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "2455": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyPasskeyRegistrationParams" - }, - "2456": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2457": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "2458": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2459": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "StartPasskeyAuthenticationParams" - }, - "2460": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2461": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2462": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2463": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "2464": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyPasskeyAuthenticationParams" - }, - "2465": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2466": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "2467": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2468": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyUpdateParams" - }, - "2469": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2470": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2471": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendlyName" - }, - "2472": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyDeleteParams" - }, - "2473": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2474": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2475": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationOptionsResponse" - }, - "2476": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationVerifyResponse" - }, - "2477": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationOptionsResponse" - }, - "2478": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationVerifyResponse" - }, - "2479": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2480": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "2481": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2482": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyListResponse" - }, - "2483": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyUpdateResponse" - }, - "2484": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyDeleteResponse" - }, - "2485": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminListParams" - }, - "2486": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2487": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2488": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminDeleteParams" - }, - "2489": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2490": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2491": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2492": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi" - }, - "2493": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "2494": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "2495": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "2496": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "2497": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2498": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "2499": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "2500": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2501": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "2502": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "2503": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2504": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "2505": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "2506": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "2507": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "2508": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2509": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "2510": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "2511": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2512": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi" - }, - "2513": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "2514": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "2515": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2516": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "2517": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "2518": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2519": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "2520": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "2521": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2522": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "2523": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "2524": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2525": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "2526": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "2527": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2528": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "2529": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "2530": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2531": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "2532": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "2533": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2534": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "2535": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "2536": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2537": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "2538": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "2539": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2540": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "2541": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "2542": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2543": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "2544": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__constructor" - }, - "2545": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "2546": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2547": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2548": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2549": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2550": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2551": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "2552": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2553": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2554": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2555": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2556": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2557": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2558": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2559": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2560": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2561": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "2562": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError.__constructor" - }, - "2563": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "2564": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2565": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2566": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2567": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError.status" - }, - "2568": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2569": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2570": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2571": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2572": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2573": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2574": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2575": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2576": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2577": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2578": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2579": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "2580": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.__constructor" - }, - "2581": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "2582": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2583": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "originalError" - }, - "2584": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.originalError" - }, - "2585": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2586": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2587": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "2588": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2589": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2590": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2591": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2592": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2593": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2594": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2595": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2596": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2597": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "2598": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.__constructor" - }, - "2599": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "2600": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2601": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "name" - }, - "2602": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2603": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2604": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2605": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2606": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2607": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2608": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2609": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2610": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2611": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2612": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2613": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2614": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2615": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2616": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2617": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "2618": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError.__constructor" - }, - "2619": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "2620": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2621": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2622": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2623": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2624": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2625": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2626": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2627": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2628": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2629": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2630": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2631": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2632": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2633": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "2634": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError.__constructor" - }, - "2635": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "2636": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2637": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2638": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2639": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2640": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2641": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2642": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2643": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2644": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2645": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2646": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2647": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2648": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2649": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "2650": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError.__constructor" - }, - "2651": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "2652": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2653": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2654": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2655": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2656": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2657": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2658": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2659": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2660": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2661": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2662": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2663": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2664": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2665": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2666": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "2667": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.__constructor" - }, - "2668": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "2669": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2670": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "details" - }, - "2671": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2672": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2673": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2674": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.details" - }, - "2675": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2676": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2677": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2678": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "2679": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "2680": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2681": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2682": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2683": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2684": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2685": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2686": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "2687": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2688": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2689": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2690": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2691": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2692": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2693": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2694": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2695": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "2696": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.__constructor" - }, - "2697": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "2698": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2699": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "details" - }, - "2700": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2701": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2702": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2703": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.details" - }, - "2704": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2705": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2706": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2707": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "2708": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "2709": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2710": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2711": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2712": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2713": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2714": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2715": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "2716": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2717": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2718": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2719": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2720": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2721": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2722": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2723": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2724": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "2725": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError.__constructor" - }, - "2726": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "2727": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2728": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2729": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2730": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2731": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2732": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2733": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2734": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2735": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2736": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2737": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2738": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2739": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2740": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "2741": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError.__constructor" - }, - "2742": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "2743": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2744": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2745": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2746": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2747": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2748": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2749": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2750": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2751": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2752": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2753": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2754": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2755": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2756": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2757": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2758": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "2759": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError.__constructor" - }, - "2760": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "2761": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2762": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2763": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2764": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2765": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2766": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2767": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2768": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2769": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2770": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2771": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2772": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2773": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2774": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2775": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "2776": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.__constructor" - }, - "2777": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "2778": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2779": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2780": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "reasons" - }, - "2781": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.reasons" - }, - "2782": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "2783": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "2784": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2785": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2786": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2787": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2788": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2789": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2790": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.reasons" - }, - "2791": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2792": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2793": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2794": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2795": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2796": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "2797": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError.__constructor" - }, - "2798": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "2799": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2800": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2801": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2802": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2803": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2804": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2805": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2806": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2807": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2808": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2809": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2810": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2811": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2812": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2813": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "2814": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.__constructor" - }, - "2815": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "2816": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "channel" - }, - "2817": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "opts" - }, - "2818": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.channel" - }, - "2819": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "2820": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "2822": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "2823": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.__constructor" - }, - "2824": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "2825": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "topic" - }, - "2826": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "params" - }, - "2827": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "socket" - }, - "2828": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.topic" - }, - "2829": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.params" - }, - "2830": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.socket" - }, - "2831": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.bindings" - }, - "2832": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subTopic" - }, - "2833": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.broadcastEndpointURL" - }, - "2834": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.private" - }, - "2835": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presence" - }, - "2836": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2837": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2838": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2839": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "state" - }, - "2840": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "2841": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "2842": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "2843": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "2844": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "2845": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "2846": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "2847": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "2848": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "2849": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "2850": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2851": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2852": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2853": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "status" - }, - "2854": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "err" - }, - "2855": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "2857": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "2858": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "2859": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2860": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2861": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2863": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2864": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "2865": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "2866": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2867": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2868": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2870": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "2871": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2872": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2874": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "2875": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "2876": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "2877": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2878": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2880": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2881": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2882": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2883": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2884": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2885": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2886": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2887": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2888": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2889": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2890": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2891": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2892": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2894": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2895": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2896": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2897": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2898": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2899": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2900": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2901": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2902": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2903": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2904": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2905": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2907": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2908": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2909": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2910": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2911": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2912": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2913": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2914": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2915": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2916": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2917": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2918": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2920": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2921": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2922": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2923": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2924": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2925": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2926": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2927": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2928": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2929": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2930": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2931": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2933": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2934": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2935": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2936": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2937": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2938": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2939": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2940": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2941": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2942": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2944": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2945": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2946": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2947": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2948": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2949": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2950": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2951": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2952": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2953": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2955": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2956": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2957": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2958": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2959": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2960": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2961": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2962": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2963": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2964": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2966": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2967": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2968": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2969": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2970": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2971": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2972": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2973": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2974": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2975": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2977": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2978": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2979": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2980": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2981": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2982": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2983": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2984": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2985": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2986": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2987": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2988": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2989": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2990": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2991": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2992": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2993": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "2994": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2995": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "2996": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2997": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "2998": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "2999": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3001": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3002": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3003": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3004": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3006": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3007": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3008": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3009": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3010": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3011": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3012": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3013": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3014": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3015": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3016": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3017": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "3018": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3019": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "3020": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "3021": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3022": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3023": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3024": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3025": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3026": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3027": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3028": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3029": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3030": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3031": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3032": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3033": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3034": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3035": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3036": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3037": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3038": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3039": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3041": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3042": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3043": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3044": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3045": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3046": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3047": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3048": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3049": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3050": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3051": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3052": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3053": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3054": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3055": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3056": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3058": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3059": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3060": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3061": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3062": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3063": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3064": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3065": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3066": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3067": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3068": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3069": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3070": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3071": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3072": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3073": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3075": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3076": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3077": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3078": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3079": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3080": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3081": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3082": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3083": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3084": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3085": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3086": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3087": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3088": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3089": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3090": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3092": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3093": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3094": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "3095": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3096": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3097": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3098": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3099": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "3100": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "3101": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "event" - }, - "3102": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3103": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "3104": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3105": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.timeout" - }, - "3106": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3107": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "3108": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3109": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "3110": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.status" - }, - "3111": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.error" - }, - "3112": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "3113": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "3114": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "args" - }, - "3115": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3116": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3117": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3118": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3119": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3121": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "3122": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3123": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3125": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "3126": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "3127": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3128": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "3129": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "3130": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "3131": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "3132": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "3133": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "3134": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "3135": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "other" - }, - "3136": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelOptions" - }, - "3137": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3138": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.config" - }, - "3139": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3140": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.broadcast" - }, - "3141": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3142": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.self" - }, - "3143": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.ack" - }, - "3144": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replay" - }, - "3145": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.presence" - }, - "3146": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3147": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.key" - }, - "3148": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.enabled" - }, - "3149": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.private" - }, - "3150": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelSendResponse" - }, - "3151": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3152": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "3153": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.__constructor" - }, - "3154": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "3155": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "endPoint" - }, - "3156": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "options" - }, - "3157": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channels" - }, - "3158": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.accessTokenValue" - }, - "3159": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.accessToken" - }, - "3160": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3161": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3162": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.apiKey" - }, - "3163": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.httpEndpoint" - }, - "3164": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.headers" - }, - "3165": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3166": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3168": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.params" - }, - "3169": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3170": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3172": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.ref" - }, - "3173": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.logLevel" - }, - "3174": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.fetch" - }, - "3175": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "3176": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "3177": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "3178": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "3179": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "3180": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "3181": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "3182": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.worker" - }, - "3183": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.workerUrl" - }, - "3184": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.workerRef" - }, - "3185": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.serializer" - }, - "3186": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "3187": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "3188": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "3189": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "3190": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "3191": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "3192": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "3193": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "3194": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "3195": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "3196": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "3197": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "3198": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "3199": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "3200": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "3201": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "3202": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "3203": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "3204": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "3205": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "3206": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "3207": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "3208": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "3209": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "3210": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3211": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3212": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "3213": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "3214": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "3215": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3216": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3217": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "3218": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "3219": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3220": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.open" - }, - "3221": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.close" - }, - "3222": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.error" - }, - "3223": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.message" - }, - "3230": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "3231": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "3232": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "3233": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "3234": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "3235": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "3236": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "code" - }, - "3237": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "reason" - }, - "3238": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "3239": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "3240": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "3241": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "3242": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "channel" - }, - "3243": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "3244": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "3245": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "3246": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "3247": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "3248": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "3249": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3250": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "3251": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "3252": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "3253": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "3254": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "3255": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "3256": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "3257": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "3258": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "3259": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "3260": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "topic" - }, - "3261": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "params" - }, - "3262": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "3263": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "3264": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3265": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "3266": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "3267": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "token" - }, - "3268": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "3269": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "3270": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "3271": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "3272": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "callback" - }, - "3273": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeClientOptions" - }, - "3274": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3275": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.transport" - }, - "3276": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.timeout" - }, - "3277": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatIntervalMs" - }, - "3278": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatCallback" - }, - "3279": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3280": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3281": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "status" - }, - "3282": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "latency" - }, - "3283": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.vsn" - }, - "3284": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.logger" - }, - "3285": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3286": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3287": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "3288": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "3289": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3290": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.encode" - }, - "3291": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.decode" - }, - "3292": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.reconnectAfterMs" - }, - "3293": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3294": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3295": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "3296": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.headers" - }, - "3297": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3298": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3300": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.params" - }, - "3301": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3302": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3304": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.log_level" - }, - "3305": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.logLevel" - }, - "3306": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.fetch" - }, - "3307": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.worker" - }, - "3308": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.workerUrl" - }, - "3309": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.accessToken" - }, - "3310": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3311": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3312": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.disconnectOnEmptyChannelsAfterMs" - }, - "3313": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.sessionStorage" - }, - "3314": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeMessage" - }, - "3315": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3316": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.topic" - }, - "3317": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.event" - }, - "3318": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.payload" - }, - "3319": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.ref" - }, - "3320": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.join_ref" - }, - "3321": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesFilter" - }, - "3322": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3323": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3324": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.schema" - }, - "3325": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.table" - }, - "3326": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.filter" - }, - "3327": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3328": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayload" - }, - "3329": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3330": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3331": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3333": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresInsertPayload" - }, - "3334": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3335": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3336": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3337": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3338": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3339": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3340": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3341": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3343": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresUpdatePayload" - }, - "3344": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3345": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3346": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3347": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3348": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3349": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3350": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3352": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresDeletePayload" - }, - "3353": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3354": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3355": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3356": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3357": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3358": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3359": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3360": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3362": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceJoinPayload" - }, - "3363": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3364": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "3365": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "3366": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "3367": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.newPresences" - }, - "3368": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3369": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3370": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3372": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceLeavePayload" - }, - "3373": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3374": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "3375": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "3376": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "3377": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.leftPresences" - }, - "3378": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3379": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3380": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3382": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceState" - }, - "3383": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3384": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3386": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3387": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3388": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3390": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3391": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeRemoveChannelResponse" - }, - "3392": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3393": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES" - }, - "3394": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" - }, - "3395": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" - }, - "3396": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" - }, - "3397": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" - }, - "3398": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "3399": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - }, - "3400": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "3401": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "3402": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "3403": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" - }, - "3404": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" - }, - "3405": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "3406": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "3407": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES" - }, - "3408": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" - }, - "3409": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" - }, - "3410": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" - }, - "3411": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" - }, - "3412": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_CHANNEL_STATES" - }, - "3413": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3414": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.closed" - }, - "3415": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.errored" - }, - "3416": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.joined" - }, - "3417": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.joining" - }, - "3418": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.leaving" - }, - "3419": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory" - }, - "3421": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "3422": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "3423": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "3424": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "3425": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "url" - }, - "3426": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "protocols" - }, - "3427": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "3428": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "3431": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike" - }, - "3432": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CONNECTING" - }, - "3433": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.OPEN" - }, - "3434": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSING" - }, - "3435": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSED" - }, - "3436": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.readyState" - }, - "3437": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.url" - }, - "3438": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.protocol" - }, - "3439": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "3440": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "3441": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "code" - }, - "3442": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "reason" - }, - "3443": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "3444": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "3445": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "data" - }, - "3446": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onopen" - }, - "3447": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3448": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3449": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3450": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3451": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onmessage" - }, - "3452": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3453": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3454": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3455": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3456": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onclose" - }, - "3457": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3458": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3459": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3460": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3461": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onerror" - }, - "3462": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3463": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3464": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3465": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3466": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "3467": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "3468": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "3469": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "3470": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "3471": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "3472": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "3473": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "3474": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.binaryType" - }, - "3475": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.bufferedAmount" - }, - "3476": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.extensions" - }, - "3477": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.dispatchEvent" - }, - "3478": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3479": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3480": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "event" - }, - "3481": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3482": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3483": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3484": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "address" - }, - "3485": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "subprotocols" - }, - "3486": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor.__index" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "src/cors.ts", - "3": "../../../CONTRIBUTING.md", - "4": "TESTING.md" - }, - "reflections": { - "1": 1, - "2": 12 - } - } -} diff --git a/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json b/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json deleted file mode 100644 index 3716a5110c9..00000000000 --- a/apps/docs/spec/enrichments/tsdoc_v2/supabase_dereferenced.json +++ /dev/null @@ -1,111365 +0,0 @@ -{ - "id": 0, - "name": "@supabase/supabase-js", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 12, - "name": "cors", - "variant": "declaration", - "kind": 2, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Canonical CORS configuration for Supabase Edge Functions\n\nThis module exports CORS headers that stay synchronized with the Supabase SDK.\nWhen new headers are added to the SDK, they are automatically included here,\npreventing CORS errors in Edge Functions." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Basic usage", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { corsHeaders } from '@supabase/supabase-js/cors'\n\nDeno.serve(async (req) => {\n if (req.method === 'OPTIONS') {\n return new Response('ok', { headers: corsHeaders })\n }\n\n return new Response(\n JSON.stringify({ data: 'Hello' }),\n { headers: { ...corsHeaders, 'Content-Type': 'application/json' } }\n )\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 13, - "name": "CorsHeaders", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type representing CORS headers as a record of header names to values" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 54, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L54" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 14, - "name": "corsHeaders", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default CORS headers for Supabase Edge Functions.\n\nIncludes all headers sent by Supabase client libraries and allows all standard HTTP methods.\nUse this for simple CORS configurations with wildcard origin." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Basic usage", - "content": [ - { - "kind": "code", - "text": "```typescript\nimport { corsHeaders } from '@supabase/supabase-js/cors'\n\nDeno.serve(async (req) => {\n if (req.method === 'OPTIONS') {\n return new Response('ok', { headers: corsHeaders })\n }\n\n return new Response(\n JSON.stringify({ data: 'Hello' }),\n { headers: { ...corsHeaders, 'Content-Type': 'application/json' } }\n )\n})\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Edge Functions" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 80, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L80" - } - ], - "type": { - "type": "reference", - "target": 13, - "name": "CorsHeaders", - "package": "@supabase/supabase-js" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Type Aliases", - "children": [13] - }, - { - "title": "Variables", - "children": [14] - } - ], - "categories": [ - { - "title": "Edge Functions", - "children": [14] - }, - { - "title": "Other", - "children": [13] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/cors.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/cors.ts#L1" - } - ] - }, - { - "id": 1, - "name": "index", - "variant": "declaration", - "kind": 2, - "flags": {}, - "children": [ - { - "id": 925, - "name": "FunctionRegion", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 926, - "name": "Any", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "any" - } - }, - { - "id": 927, - "name": "ApNortheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-1" - } - }, - { - "id": 928, - "name": "ApNortheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 79, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-northeast-2" - } - }, - { - "id": 929, - "name": "ApSouth1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 80, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-south-1" - } - }, - { - "id": 930, - "name": "ApSoutheast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 81, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-1" - } - }, - { - "id": 931, - "name": "ApSoutheast2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 82, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ap-southeast-2" - } - }, - { - "id": 932, - "name": "CaCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 83, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ca-central-1" - } - }, - { - "id": 933, - "name": "EuCentral1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 84, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-central-1" - } - }, - { - "id": 934, - "name": "EuWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 85, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-1" - } - }, - { - "id": 935, - "name": "EuWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 86, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-2" - } - }, - { - "id": 936, - "name": "EuWest3", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 87, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "eu-west-3" - } - }, - { - "id": 937, - "name": "SaEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 88, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "sa-east-1" - } - }, - { - "id": 938, - "name": "UsEast1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 89, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-east-1" - } - }, - { - "id": 939, - "name": "UsWest1", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 90, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-west-1" - } - }, - { - "id": 940, - "name": "UsWest2", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 91, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "us-west-2" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 926, 927, 928, 929, 930, 931, 932, 933, 934, 935, 936, 937, 938, 939, 940 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 76, - "character": 20 - } - ] - }, - { - "id": 3393, - "name": "REALTIME_LISTEN_TYPES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3394, - "name": "BROADCAST", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 123, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3396, - "name": "POSTGRES_CHANGES", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 125, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 3395, - "name": "PRESENCE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 124, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 3397, - "name": "SYSTEM", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 126, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "system" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3394, 3396, 3395, 3397] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 122, - "character": 20 - } - ] - }, - { - "id": 3398, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3399, - "name": "ALL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 117, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "*" - } - }, - { - "id": 3402, - "name": "DELETE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 120, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "DELETE" - } - }, - { - "id": 3400, - "name": "INSERT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 118, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "INSERT" - } - }, - { - "id": 3401, - "name": "UPDATE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 119, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "UPDATE" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3399, 3402, 3400, 3401] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 116, - "character": 20 - } - ] - }, - { - "id": 3403, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3405, - "name": "JOIN", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "join" - } - }, - { - "id": 3406, - "name": "LEAVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - }, - { - "id": 3404, - "name": "SYNC", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3405, 3406, 3404] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 28, - "character": 20 - } - ] - }, - { - "id": 3407, - "name": "REALTIME_SUBSCRIBE_STATES", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3411, - "name": "CHANNEL_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 132, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "CHANNEL_ERROR" - } - }, - { - "id": 3410, - "name": "CLOSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 131, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "CLOSED" - } - }, - { - "id": 3408, - "name": "SUBSCRIBED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 129, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "SUBSCRIBED" - } - }, - { - "id": 3409, - "name": "TIMED_OUT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 130, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "TIMED_OUT" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [3411, 3410, 3408, 3409] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 128, - "character": 20 - } - ] - }, - { - "id": 2561, - "name": "AuthApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error returned directly from the GoTrue REST API." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthApiError } from '@supabase/auth-js'\n\nthrow new AuthApiError('Invalid credentials', 400, 'invalid_credentials')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2562, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 45, - "character": 4 - } - ], - "signatures": [ - { - "id": 2563, - "name": "AuthApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 45, - "character": 4 - } - ], - "parameters": [ - { - "id": 2564, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2565, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2566, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2561, - "name": "AuthApiError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2570, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2568, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2569, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2567, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2571, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2572, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2573, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2577, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2578, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2575, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2574, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2576, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2577, 2575, 2574, 2576] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2562] - }, - { - "title": "Properties", - "children": [2570, 2568, 2567] - }, - { - "title": "Methods", - "children": [2571] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 43, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2543, - "name": "AuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error thrown by Supabase Auth helpers." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthError } from '@supabase/auth-js'\n\nthrow new AuthError('Unexpected auth error', 500, 'unexpected')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2544, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 24, - "character": 4 - } - ], - "signatures": [ - { - "id": 2545, - "name": "AuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 2546, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2547, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2548, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 2552, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2549, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2550, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2551, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 2553, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2554, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2555, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2559, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2560, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2557, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2556, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2558, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2559, 2557, 2556, 2558] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2544] - }, - { - "title": "Properties", - "children": [2552, 2549, 2551] - }, - { - "title": "Methods", - "children": [2553] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 13, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2561, - "name": "AuthApiError" - }, - { - "type": "reference", - "target": 2579, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError" - } - ] - }, - { - "id": 2666, - "name": "AuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when implicit grant redirects contain an error." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthImplicitGrantRedirectError } from '@supabase/auth-js'\n\nthrow new AuthImplicitGrantRedirectError('OAuth redirect failed', {\n error: 'access_denied',\n code: 'oauth_error',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2667, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 4 - } - ], - "signatures": [ - { - "id": 2668, - "name": "AuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 4 - } - ], - "parameters": [ - { - "id": 2669, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2670, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2671, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2673, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 141, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2672, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 140, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2673, 2672] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 139, - "character": 43 - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2694, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2692, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2693, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2674, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 135, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2675, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2677, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 137, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2676, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 136, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2677, 2676] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 135, - "character": 13 - } - ] - } - } - ] - } - }, - { - "id": 2690, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2691, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2678, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 4 - } - ], - "signatures": [ - { - "id": 2679, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2680, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2684, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 147, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2685, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2686, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 148, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2687, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2689, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 150, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2688, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 149, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2689, 2688] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 148, - "character": 17 - } - ] - } - } - ] - } - }, - { - "id": 2682, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 145, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2681, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 144, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2683, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 146, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2684, 2686, 2682, 2681, 2683] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 143, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2667] - }, - { - "title": "Properties", - "children": [2694, 2692, 2674, 2690, 2691] - }, - { - "title": "Methods", - "children": [2678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 134, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2649, - "name": "AuthInvalidCredentialsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when email/password credentials are invalid." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidCredentialsError } from '@supabase/auth-js'\n\nthrow new AuthInvalidCredentialsError('Email or password is incorrect')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2650, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 119, - "character": 4 - } - ], - "signatures": [ - { - "id": 2651, - "name": "AuthInvalidCredentialsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 119, - "character": 4 - } - ], - "parameters": [ - { - "id": 2652, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2649, - "name": "AuthInvalidCredentialsError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2657, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2655, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2653, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2654, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2658, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2659, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2660, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2664, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2665, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2662, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2661, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2663, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2664, 2662, 2661, 2663] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2650] - }, - { - "title": "Properties", - "children": [2657, 2655, 2653, 2654] - }, - { - "title": "Methods", - "children": [2658] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 118, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2796, - "name": "AuthInvalidJwtError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a JWT cannot be verified or parsed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidJwtError } from '@supabase/auth-js'\n\nthrow new AuthInvalidJwtError('Token signature is invalid')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2797, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 280, - "character": 4 - } - ], - "signatures": [ - { - "id": 2798, - "name": "AuthInvalidJwtError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 280, - "character": 4 - } - ], - "parameters": [ - { - "id": 2799, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2796, - "name": "AuthInvalidJwtError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2804, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2802, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2803, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2800, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2801, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2805, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2806, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2807, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2811, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2812, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2809, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2808, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2810, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2811, 2809, 2808, 2810] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2797] - }, - { - "title": "Properties", - "children": [2804, 2802, 2800, 2801] - }, - { - "title": "Methods", - "children": [2805] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 279, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2633, - "name": "AuthInvalidTokenResponseError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the token response is malformed." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthInvalidTokenResponseError } from '@supabase/auth-js'\n\nthrow new AuthInvalidTokenResponseError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2634, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 106, - "character": 4 - } - ], - "signatures": [ - { - "id": 2635, - "name": "AuthInvalidTokenResponseError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2633, - "name": "AuthInvalidTokenResponseError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2640, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2638, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2639, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2636, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2637, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2641, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2642, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2643, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2647, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2648, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2645, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2644, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2646, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2647, 2645, 2644, 2646] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2634] - }, - { - "title": "Properties", - "children": [2640, 2638, 2636, 2637] - }, - { - "title": "Methods", - "children": [2641] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 105, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the PKCE code verifier is not found in storage.\nThis typically happens when the auth flow was initiated in a different\nbrowser, device, or the storage was cleared." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCECodeVerifierMissingError } from '@supabase/auth-js'\n\nthrow new AuthPKCECodeVerifierMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2725, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 198, - "character": 4 - } - ], - "signatures": [ - { - "id": 2726, - "name": "AuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 198, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2731, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2729, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2730, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2727, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2728, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2732, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2733, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2734, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2738, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2739, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2736, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2735, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2737, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2738, 2736, 2735, 2737] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2725] - }, - { - "title": "Properties", - "children": [2731, 2729, 2727, 2728] - }, - { - "title": "Methods", - "children": [2732] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 197, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2695, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown during PKCE code exchanges." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'\n\nthrow new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2696, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 4 - } - ], - "signatures": [ - { - "id": 2697, - "name": "AuthPKCEGrantCodeExchangeError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 4 - } - ], - "parameters": [ - { - "id": 2698, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2699, - "name": "details", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2700, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2702, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 172, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2701, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 171, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2702, 2701] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 170, - "character": 43 - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2695, - "name": "AuthPKCEGrantCodeExchangeError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2723, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2721, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2722, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2703, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 166, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2704, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2706, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 168, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2705, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 167, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2706, 2705] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 166, - "character": 13 - } - ] - } - } - ] - } - }, - { - "id": 2719, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2720, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2707, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 4 - } - ], - "signatures": [ - { - "id": 2708, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2709, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2713, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 178, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2714, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2715, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 179, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 2716, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2718, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 181, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2717, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 180, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2718, 2717] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 179, - "character": 17 - } - ] - } - } - ] - } - }, - { - "id": 2711, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 176, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2710, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 175, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2712, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 177, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2713, 2715, 2711, 2710, 2712] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 174, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2696] - }, - { - "title": "Properties", - "children": [2723, 2721, 2703, 2719, 2720] - }, - { - "title": "Methods", - "children": [2707] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 165, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2758, - "name": "AuthRefreshDiscardedError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returned when the server rotated a refresh token successfully but the\nclient chose not to persist the rotated tokens because the local session\nchanged mid-flight. Usually means a concurrent " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " cleared storage\nbetween when the refresh started and when it came back.\n\nSet on the " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " field of the refresh result so callers can tell \"we\ngot rotated tokens but threw them away\" apart from \"the refresh failed.\"\nThe rotated session on the server will be picked up on the next refresh\nvia GoTrue's parent-of-active path." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { isAuthRefreshDiscardedError } from '@supabase/auth-js'\n\nif (isAuthRefreshDiscardedError(error)) {\n // Concurrent signOut/sign-in raced our refresh. Treat as a no-op.\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2759, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 236, - "character": 4 - } - ], - "signatures": [ - { - "id": 2760, - "name": "AuthRefreshDiscardedError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 236, - "character": 4 - } - ], - "parameters": [ - { - "id": 2761, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2766, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2764, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2765, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2762, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2763, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2767, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2768, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2769, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2773, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2774, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2771, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2770, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2772, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2773, 2771, 2770, 2772] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2759] - }, - { - "title": "Properties", - "children": [2766, 2764, 2762, 2763] - }, - { - "title": "Methods", - "children": [2767] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 235, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2740, - "name": "AuthRetryableFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a transient fetch issue occurs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthRetryableFetchError } from '@supabase/auth-js'\n\nthrow new AuthRetryableFetchError('Service temporarily unavailable', 503)\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2741, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 212, - "character": 4 - } - ], - "signatures": [ - { - "id": 2742, - "name": "AuthRetryableFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 212, - "character": 4 - } - ], - "parameters": [ - { - "id": 2743, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2744, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2749, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2747, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2748, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2745, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2746, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2750, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2751, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2752, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2756, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2757, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2754, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2753, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2755, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2756, 2754, 2753, 2755] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2741] - }, - { - "title": "Properties", - "children": [2749, 2747, 2745, 2746] - }, - { - "title": "Methods", - "children": [2750] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 211, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2617, - "name": "AuthSessionMissingError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when an operation requires a session but none is present." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthSessionMissingError } from '@supabase/auth-js'\n\nthrow new AuthSessionMissingError()\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2618, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 92, - "character": 4 - } - ], - "signatures": [ - { - "id": 2619, - "name": "AuthSessionMissingError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 92, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2624, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2622, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2623, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2620, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2621, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2625, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2626, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2627, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2631, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2632, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2629, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2628, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2630, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2631, 2629, 2628, 2630] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2618] - }, - { - "title": "Properties", - "children": [2624, 2622, 2620, 2621] - }, - { - "title": "Methods", - "children": [2625] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 91, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2579, - "name": "AuthUnknownError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps non-standard errors so callers can inspect the root cause." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthUnknownError } from '@supabase/auth-js'\n\ntry {\n await someAuthCall()\n} catch (err) {\n throw new AuthUnknownError('Auth failed', err)\n}\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2580, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 64, - "character": 4 - } - ], - "signatures": [ - { - "id": 2581, - "name": "AuthUnknownError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 64, - "character": 4 - } - ], - "parameters": [ - { - "id": 2582, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2583, - "name": "originalError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 2579, - "name": "AuthUnknownError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2588, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2585, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2586, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2584, - "name": "originalError", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 2587, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2589, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2590, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2591, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2595, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2593, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2592, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2594, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2595, 2593, 2592, 2594] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2580] - }, - { - "title": "Properties", - "children": [2588, 2585, 2584, 2587] - }, - { - "title": "Methods", - "children": [2589] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 62, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2775, - "name": "AuthWeakPasswordError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when a supplied password is considered weak." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { AuthWeakPasswordError } from '@supabase/auth-js'\n\nthrow new AuthWeakPasswordError('Password too short', 400, ['min_length'])\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2776, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 259, - "character": 4 - } - ], - "signatures": [ - { - "id": 2777, - "name": "AuthWeakPasswordError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 259, - "character": 4 - } - ], - "parameters": [ - { - "id": 2778, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2779, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2780, - "name": "reasons", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2599, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2598, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 2795, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2608, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 2793, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2606, - "name": "CustomAuthError.code" - } - }, - { - "id": 2791, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2604, - "name": "CustomAuthError.name" - } - }, - { - "id": 2781, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reasons why the password is deemed weak." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 258, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 2792, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2605, - "name": "CustomAuthError.status" - } - }, - { - "id": 2782, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 4 - } - ], - "signatures": [ - { - "id": 2783, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2784, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2788, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 264, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2789, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2786, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 262, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2785, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 261, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2790, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 265, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "length" - }, - { - "type": "literal", - "value": "characters" - }, - { - "type": "literal", - "value": "pwned" - } - ] - } - } - }, - { - "id": 2787, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 263, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2788, 2786, 2785, 2790, 2787] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 260, - "character": 14 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": 2610, - "name": "CustomAuthError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2609, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2776] - }, - { - "title": "Properties", - "children": [2795, 2793, 2791, 2781, 2792] - }, - { - "title": "Methods", - "children": [2782] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 254, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 2597, - "name": "CustomAuthError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Flexible error class used to create named auth errors at runtime." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { CustomAuthError } from '@supabase/auth-js'\n\nthrow new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 2598, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 79, - "character": 4 - } - ], - "signatures": [ - { - "id": 2599, - "name": "CustomAuthError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 79, - "character": 4 - } - ], - "parameters": [ - { - "id": 2600, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2601, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2602, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2603, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 2597, - "name": "CustomAuthError", - "package": "@supabase/auth-js" - }, - "overwrites": { - "type": "reference", - "target": 2545, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 2544, - "name": "AuthError.constructor" - } - }, - { - "id": 2608, - "name": "__isAuthError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 23, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2552, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 2606, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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 " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#status" - }, - { - "kind": "text", - "text": " will also be undefined." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2607, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 2549, - "name": "AuthError.code" - } - }, - { - "id": 2604, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "AuthError.name" - } - }, - { - "id": 2605, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code that caused the error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": 2551, - "name": "AuthError.status" - } - }, - { - "id": 2609, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "signatures": [ - { - "id": 2610, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2611, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2615, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 29, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/error-codes.ts", - "qualifiedName": "ErrorCode" - }, - "name": "ErrorCode", - "package": "@supabase/auth-js" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2616, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - } - ] - } - }, - { - "id": 2613, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 27, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2612, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2614, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 28, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2615, 2613, 2612, 2614] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 25, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2554, - "name": "AuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2553, - "name": "AuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2598] - }, - { - "title": "Properties", - "children": [2608, 2606, 2604, 2605] - }, - { - "title": "Methods", - "children": [2609] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 76, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", - "target": 2633, - "name": "AuthInvalidTokenResponseError" - }, - { - "type": "reference", - "target": 2649, - "name": "AuthInvalidCredentialsError" - }, - { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError" - }, - { - "type": "reference", - "target": 2695, - "name": "AuthPKCEGrantCodeExchangeError" - }, - { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError" - }, - { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError" - }, - { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError" - }, - { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError" - }, - { - "type": "reference", - "target": 2796, - "name": "AuthInvalidJwtError" - } - ] - }, - { - "id": 912, - "name": "FunctionsError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base error for Supabase Edge Function invocations." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsError } from '@supabase/functions-js'\n\nthrow new FunctionsError('Unexpected error invoking function', 'FunctionsError', {\n requestId: 'abc123',\n})\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 913, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 30, - "character": 4 - } - ], - "signatures": [ - { - "id": 914, - "name": "FunctionsError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 30, - "character": 4 - } - ], - "parameters": [ - { - "id": 915, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 916, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 917, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 918, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 919, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 920, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 921, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 924, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 923, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 922, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [924, 923, 922] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [913] - }, - { - "title": "Properties", - "children": [918] - }, - { - "title": "Methods", - "children": [919] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 28, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 879, - "name": "FunctionsHttpError" - }, - { - "type": "reference", - "target": 890, - "name": "FunctionsFetchError" - }, - { - "type": "reference", - "target": 901, - "name": "FunctionsRelayError" - } - ] - }, - { - "id": 890, - "name": "FunctionsFetchError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the network request to an Edge Function fails." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsFetchError } from '@supabase/functions-js'\n\nthrow new FunctionsFetchError({ requestId: 'abc123' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 891, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 48, - "character": 4 - } - ], - "signatures": [ - { - "id": 892, - "name": "FunctionsFetchError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 48, - "character": 4 - } - ], - "parameters": [ - { - "id": 893, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 890, - "name": "FunctionsFetchError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 894, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 895, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 896, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 897, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 900, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 899, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 898, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [900, 899, 898] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [891] - }, - { - "title": "Properties", - "children": [894] - }, - { - "title": "Methods", - "children": [895] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 47, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 879, - "name": "FunctionsHttpError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Edge Function returns a non-2xx status code." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsHttpError } from '@supabase/functions-js'\n\nthrow new FunctionsHttpError({ status: 500 })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 880, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 74, - "character": 4 - } - ], - "signatures": [ - { - "id": 881, - "name": "FunctionsHttpError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 74, - "character": 4 - } - ], - "parameters": [ - { - "id": 882, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 879, - "name": "FunctionsHttpError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 883, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 884, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 885, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 886, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 889, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 888, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 887, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [889, 888, 887] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [880] - }, - { - "title": "Properties", - "children": [883] - }, - { - "title": "Methods", - "children": [884] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 73, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 901, - "name": "FunctionsRelayError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error thrown when the Supabase relay cannot reach the Edge Function." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { FunctionsRelayError } from '@supabase/functions-js'\n\nthrow new FunctionsRelayError({ region: 'us-east-1' })\n```" - } - ] - } - ] - }, - "children": [ - { - "id": 902, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 61, - "character": 4 - } - ], - "signatures": [ - { - "id": 903, - "name": "FunctionsRelayError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 61, - "character": 4 - } - ], - "parameters": [ - { - "id": 904, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 901, - "name": "FunctionsRelayError", - "package": "@supabase/functions-js" - }, - "overwrites": { - "type": "reference", - "target": 914, - "name": "FunctionsError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 913, - "name": "FunctionsError.constructor" - } - }, - { - "id": 905, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 918, - "name": "FunctionsError.context" - } - }, - { - "id": 906, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "signatures": [ - { - "id": 907, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 908, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 911, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 910, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 909, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [911, 910, 909] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 31, - "character": 14 - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 920, - "name": "FunctionsError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 919, - "name": "FunctionsError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [902] - }, - { - "title": "Properties", - "children": [905] - }, - { - "title": "Methods", - "children": [906] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 60, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 912, - "name": "FunctionsError", - "package": "@supabase/functions-js" - } - ] - }, - { - "id": 1124, - "name": "GoTrueAdminApi", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1125, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 4 - } - ], - "signatures": [ - { - "id": 1126, - "name": "GoTrueAdminApi", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an admin API client that can be used to manage users and OAuth clients." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-secret-key')\nconst { data, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueAdminApi } from '@supabase/auth-js'\n\nconst admin = new GoTrueAdminApi({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { Authorization: `Bearer ${process.env.SUPABASE_SECRET_KEY}` },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 4 - } - ], - "parameters": [ - { - "id": 1127, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1128, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1142, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 53, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1134, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 52, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1135, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1136, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1137, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1138, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1139, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1140, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1141, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1130, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 49, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 49, - "character": 18 - } - ], - "indexSignatures": [ - { - "id": 1132, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 50, - "character": 12 - } - ], - "parameters": [ - { - "id": 1133, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1129, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 48, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1142, 1134, 1130, 1129] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 47, - "character": 56 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1145, - "name": "customProviders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2343, - "name": "GoTrueAdminCustomProvidersApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1160, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 25, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1152, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 24, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1153, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1154, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1155, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1156, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1157, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1158, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1159, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1148, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 21, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1149, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 21, - "character": 23 - } - ], - "indexSignatures": [ - { - "id": 1150, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 22, - "character": 8 - } - ], - "parameters": [ - { - "id": 1151, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1143, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all MFA administration methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 6, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2096, - "name": "GoTrueAdminMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1144, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 11, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2228, - "name": "GoTrueAdminOAuthApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1146, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all passkey administration methods.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2512, - "name": "GoTrueAdminPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1147, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 20, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1178, - "name": "createUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 335, - "character": 4 - } - ], - "signatures": [ - { - "id": 1179, - "name": "createUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To confirm the user's email address or phone number, set " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " to true. Both arguments default to false.\n- " - }, - { - "kind": "code", - "text": "`createUser()`" - }, - { - "kind": "text", - "text": " will not send a confirmation email to the user. You can use [" - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the " - }, - { - "kind": "code", - "text": "`email_confirm`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone_confirm`" - }, - { - "kind": "text", - "text": " param to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "With custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n password: 'password',\n user_metadata: { name: 'Yoda' }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With custom user metadata\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n email_confirm: true\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Auto-confirm the user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n phone: '1234567890',\n phone_confirm: true\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 335, - "character": 4 - } - ], - "parameters": [ - { - "id": 1180, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1750, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1202, - "name": "deleteUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 613, - "character": 4 - } - ], - "signatures": [ - { - "id": 1203, - "name": "deleteUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a user. Requires a " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`deleteUser()`" - }, - { - "kind": "text", - "text": " method requires the user's ID, which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Removes a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.deleteUser(\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Removes a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {}\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 613, - "character": 4 - } - ], - "parameters": [ - { - "id": 1204, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user id you want to remove." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1205, - "name": "shouldSoftDelete", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1175, - "name": "generateLink", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 254, - "character": 4 - } - ], - "signatures": [ - { - "id": 1176, - "name": "generateLink", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates email links and OTPs to be sent via a custom email provider." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The following types can be passed into " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": ": " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_current`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`email_change_new`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " only generates the email link for " - }, - { - "kind": "code", - "text": "`email_change_email`" - }, - { - "kind": "text", - "text": " if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\n- " - }, - { - "kind": "code", - "text": "`generateLink()`" - }, - { - "kind": "text", - "text": " handles the creation of the user for " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Generate a signup link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'signup',\n email: 'email@example.com',\n password: 'secret'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Generate a signup link\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"properties\": {\n \"action_link\": \"\",\n \"email_otp\": \"999999\",\n \"hashed_token\": \"\",\n \"verification_type\": \"signup\"\n },\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"email@example.com\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"email@example.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate an invite link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'invite',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a magic link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'magiclink',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate a recovery link", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'recovery',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Generate links to change current email address", - "content": [ - { - "kind": "code", - "text": "```js\n// generate an email change link to be sent to the current email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_current',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n\n// generate an email change link to be sent to the new email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_new',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 254, - "character": 4 - } - ], - "parameters": [ - { - "id": 1177, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1964, - "name": "GenerateLinkParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1965, - "name": "GenerateLinkResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1195, - "name": "getUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 435, - "character": 4 - } - ], - "signatures": [ - { - "id": 1196, - "name": "getUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get user by id." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Fetches the user object from the database based on the user's id.\n- The " - }, - { - "kind": "code", - "text": "`getUserById()`" - }, - { - "kind": "text", - "text": " method requires the user's id which maps to the " - }, - { - "kind": "code", - "text": "`auth.users.id`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - { - "tag": "@example", - "name": "Fetch the user object using the access_token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.getUserById(1)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Fetch the user object using the access_token jwt\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 435, - "character": 4 - } - ], - "parameters": [ - { - "id": 1197, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1168, - "name": "inviteUserByEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 4 - } - ], - "signatures": [ - { - "id": 1169, - "name": "inviteUserByEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends an invite link to an email address." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Sends an invite link to the user's email address.\n- The " - }, - { - "kind": "code", - "text": "`inviteUserByEmail()`" - }, - { - "kind": "text", - "text": " method is typically used by administrators to invite users to join the application.\n- Note that PKCE is not supported when using " - }, - { - "kind": "code", - "text": "`inviteUserByEmail`" - }, - { - "kind": "text", - "text": ". This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow." - } - ] - }, - { - "tag": "@example", - "name": "Invite a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Invite a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"invited_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 4 - } - ], - "parameters": [ - { - "id": 1170, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1171, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options to be included when inviting." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1172, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1173, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store additional metadata about the user. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.user_metadata`" - }, - { - "kind": "text", - "text": " column." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 133, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1174, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 135, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1173, 1174] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 131, - "character": 47 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1181, - "name": "listUsers", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 4 - } - ], - "signatures": [ - { - "id": 1182, - "name": "listUsers", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Defaults to return 50 users per page." - } - ] - }, - { - "tag": "@example", - "name": "Get a page of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Paginated list of users", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\n page: 1,\n perPage: 1000\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 4 - } - ], - "parameters": [ - { - "id": 1183, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object which supports " - }, - { - "kind": "code", - "text": "`page`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`perPage`" - }, - { - "kind": "text", - "text": " as numbers, to alter the paginated results." - } - ] - }, - "type": { - "type": "reference", - "target": 2117, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1184, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1185, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 362, - "character": 8 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1186, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1188, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 364, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1187, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 363, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1188, 1187] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 362, - "character": 14 - } - ] - } - }, - { - "type": "reference", - "target": 2110, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1189, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 366, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1185, 1189] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 361, - "character": 44 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1190, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1191, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 368, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1192, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1193, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 369, - "character": 12 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1193] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 368, - "character": 14 - } - ] - } - } - }, - { - "id": 1194, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 371, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1191, 1194] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 367, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1161, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 4 - } - ], - "signatures": [ - { - "id": 1162, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a logged-in session." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 4 - } - ], - "parameters": [ - { - "id": 1163, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A valid, logged-in JWT." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1164, - "name": "scope", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logout sope." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1166, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 64, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1167, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 65, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1166, 1167] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 63, - "character": 56 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1198, - "name": "updateUserById", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 580, - "character": 4 - } - ], - "signatures": [ - { - "id": 1199, - "name": "updateUserById", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the user data. Changes are applied directly without confirmation flows." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "**Important:** This is a server-side operation and does **not** trigger client-side\n" - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " listeners. The admin API has no connection to client state.\n\nTo sync changes to the client after calling this method:\n1. On the client, call " - }, - { - "kind": "code", - "text": "`supabase.auth.refreshSession()`" - }, - { - "kind": "text", - "text": " to fetch the updated user data\n2. This will trigger the " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event and notify all listeners" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\n// Server-side (Edge Function)\nconst { data, error } = await supabase.auth.admin.updateUserById(\n userId,\n { user_metadata: { preferences: { theme: 'dark' } } }\n)\n\n// Client-side (to sync the changes)\nconst { data, error } = await supabase.auth.refreshSession()\n// onAuthStateChange listeners will now be notified with updated user\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.refreshSession", - "target": 1405 - }, - { - "kind": "text", - "text": " for syncing admin changes to the client" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient.updateUser", - "target": 1381 - }, - { - "kind": "text", - "text": " for client-side user updates (triggers listeners automatically)" - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '11111111-1111-1111-1111-111111111111',\n { email: 'new@email.com' }\n)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updates a user's email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"new@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { password: 'new_password' }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { user_metadata: { hello: 'world' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Updates a user's app_metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { app_metadata: { plan: 'trial' } }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's email address", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { email_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Confirms a user's phone number", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { phone_confirm: true }\n)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Ban a user for 100 years", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { ban_duration: '876000h' }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 580, - "character": 4 - } - ], - "parameters": [ - { - "id": 1200, - "name": "uid", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's unique identifier" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1201, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ] - }, - "type": { - "type": "reference", - "target": 1750, - "name": "AdminUserAttributes", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1125] - }, - { - "title": "Properties", - "children": [1145, 1160, 1152, 1148, 1143, 1144, 1146, 1147] - }, - { - "title": "Methods", - "children": [1178, 1202, 1175, 1195, 1168, 1181, 1161, 1198] - } - ], - "categories": [ - { - "title": "Auth", - "children": [1178, 1202, 1175, 1195, 1168, 1181, 1161, 1198] - }, - { - "title": "Other", - "children": [1125, 1145, 1160, 1152, 1148, 1143, 1144, 1146, 1147] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueAdminApi.d.ts", - "line": 4, - "character": 21 - } - ] - }, - { - "id": 1221, - "name": "GoTrueClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1223, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 134, - "character": 4 - } - ], - "signatures": [ - { - "id": 1224, - "name": "GoTrueClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { GoTrueClient } from '@supabase/auth-js'\n\nconst auth = new GoTrueClient({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { apikey: 'your-publishable-key' },\n storageKey: 'supabase-auth',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 134, - "character": 4 - } - ], - "parameters": [ - { - "id": 1225, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1599, - "name": "GoTrueClientOptions", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": 1221, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 1260, - "name": "_sessionRemovalEpoch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Monotonic counter incremented at the top of " - }, - { - "kind": "code", - "text": "`_removeSession`" - }, - { - "kind": "text", - "text": ", before any\n" - }, - { - "kind": "code", - "text": "`await`" - }, - { - "kind": "text", - "text": ". The commit guard inside " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": " captures this value\nbefore " - }, - { - "kind": "code", - "text": "`_saveSession`" - }, - { - "kind": "text", - "text": " and re-checks it after, so a " - }, - { - "kind": "code", - "text": "`signOut`" - }, - { - "kind": "text", - "text": " that\ninterleaves inside " - }, - { - "kind": "code", - "text": "`_saveSession`" - }, - { - "kind": "text", - "text": "'s storage-write awaits is still caught\n(the post-fetch storage snapshot alone misses that window)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 69, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1227, - "name": "admin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - }, - { - "id": 1254, - "name": "autoRefreshTicker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 58, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/timers.d.ts", - "qualifiedName": "__global.NodeJS.Timeout" - }, - "name": "Timeout", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.Timeout" - } - ] - } - }, - { - "id": 1255, - "name": "autoRefreshTickTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 59, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/timers.d.ts", - "qualifiedName": "__global.NodeJS.Timeout" - }, - "name": "Timeout", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.Timeout" - } - ] - } - }, - { - "id": 1245, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 47, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1291, - "name": "broadcastChannel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to broadcast state change events to other tabs listening." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 109, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "BroadcastChannel" - }, - "name": "BroadcastChannel", - "package": "typescript" - } - ] - } - }, - { - "id": 1262, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1263, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 45 - } - ], - "signatures": [ - { - "id": 1264, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 45 - } - ], - "parameters": [ - { - "id": 1265, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1266, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1267, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 77, - "character": 64 - } - ], - "indexSignatures": [ - { - "id": 1268, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 78, - "character": 8 - } - ], - "parameters": [ - { - "id": 1269, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1290, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. Defaults to an empty object.\nSee " - }, - { - "kind": "code", - "text": "`GoTrueClientOptions.experimental`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 105, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1277, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 86, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1278, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 1279, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 1280, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1281, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1282, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 1283, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 1284, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1232, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 35, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 1810, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1275, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 84, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1271, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 81, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1272, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 81, - "character": 23 - } - ], - "indexSignatures": [ - { - "id": 1273, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 82, - "character": 8 - } - ], - "parameters": [ - { - "id": 1274, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1261, - "name": "initializePromise", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Keeps track of the async client initialization.\nWhen null or not yet resolved the auth state is " - }, - { - "kind": "code", - "text": "`unknown`" - }, - { - "kind": "text", - "text": "\nOnce resolved the auth state is known and it's safe to call any further client methods.\nKeep extra care to never reject or throw uncaught errors" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 76, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2106, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - ] - } - }, - { - "id": 1285, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom lock function passed via " - }, - { - "kind": "code", - "text": "`settings.lock`" - }, - { - "kind": "text", - "text": ". When non-null, every auth\noperation runs inside " - }, - { - "kind": "code", - "text": "`_acquireLock`" - }, - { - "kind": "text", - "text": ". When null (the default), the client\nuses its lockless coordination (refresh single-flight + commit guard).\nTODO(v3): remove along with the legacy lock path." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 93, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 1590, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1286, - "name": "lockAcquired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 94, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1289, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is supplied. TODO(v3): remove." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 100, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1292, - "name": "logDebugMessages", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 110, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1293, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 14 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1294, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 22 - } - ], - "signatures": [ - { - "id": 1295, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 111, - "character": 22 - } - ], - "parameters": [ - { - "id": 1296, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1297, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 1249, - "name": "memoryStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 54, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1250, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 54, - "character": 29 - } - ], - "indexSignatures": [ - { - "id": 1251, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 55, - "character": 8 - } - ], - "parameters": [ - { - "id": 1252, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ] - } - }, - { - "id": 1228, - "name": "mfa", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the MFA methods." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2025, - "name": "GoTrueMFAApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1229, - "name": "oauth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for the OAuth 2.1 authorization server methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\nUsed to implement the authorization code flow on the consent page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2392, - "name": "AuthOAuthServerApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1230, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Namespace for passkey methods.\nIncludes lower-level two-step registration/authentication and passkey management.\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "; otherwise all methods throw." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2492, - "name": "AuthPasskeyApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 1287, - "name": "pendingInLock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 95, - "character": 14 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - }, - { - "id": 1246, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 48, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1259, - "name": "refreshingDeferred", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 61, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/helpers.ts", - "qualifiedName": "Deferred" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2109, - "name": "CallRefreshTokenResult", - "package": "@supabase/auth-js" - } - ], - "name": "Deferred", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1253, - "name": "stateChangeEmitters", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 57, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.collection.d.ts", - "qualifiedName": "Map" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - ], - "name": "Map", - "package": "typescript" - } - }, - { - "id": 1247, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 49, - "character": 14 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 1231, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The storage key used to identify the values saved in localStorage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 34, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1276, - "name": "suppressGetSessionWarning", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 85, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1288, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 96, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1270, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 80, - "character": 14 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1248, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 53, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1256, - "name": "visibilityChangedCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 14 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 1257, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 42 - } - ], - "signatures": [ - { - "id": 1258, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 60, - "character": 42 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 1233, - "name": "jwks", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 18 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 18 - } - ], - "getSignature": { - "id": 1234, - "name": "jwks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The JWKS used for verifying asymmetric JWTs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 18 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1235, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1236, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 40, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1236] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 39, - "character": 26 - } - ] - } - } - }, - "setSignature": { - "id": 1237, - "name": "jwks", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 18 - } - ], - "parameters": [ - { - "id": 1238, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1239, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1240, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 43, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1240] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 42, - "character": 30 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 1241, - "name": "jwks_cached_at", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 45, - "character": 18 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 46, - "character": 18 - } - ], - "getSignature": { - "id": 1242, - "name": "jwks_cached_at", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 45, - "character": 18 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - "setSignature": { - "id": 1243, - "name": "jwks_cached_at", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 46, - "character": 18 - } - ], - "parameters": [ - { - "id": 1244, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 1410, - "name": "_refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 14 - } - ], - "signatures": [ - { - "id": 1411, - "name": "_refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 14 - } - ], - "parameters": [ - { - "id": 1412, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1414, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1911, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1910, - "character": 47 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1399, - "name": "_setSession", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 14 - } - ], - "signatures": [ - { - "id": 1400, - "name": "_setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 14 - } - ], - "parameters": [ - { - "id": 1401, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1403, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1779, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1404, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1780, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1403, 1404] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1778, - "character": 42 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1423, - "name": "_signOut", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 14 - } - ], - "signatures": [ - { - "id": 1424, - "name": "_signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 14 - } - ], - "parameters": [ - { - "id": 1425, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2121, - "name": "SignOut", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1426, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1427, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1974, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1427] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1973, - "character": 53 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1387, - "name": "_updateUser", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 14 - } - ], - "signatures": [ - { - "id": 1388, - "name": "_updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 14 - } - ], - "parameters": [ - { - "id": 1389, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 1390, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1392, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1648, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1392] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1647, - "character": 64 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1506, - "name": "dispose", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2320, - "character": 4 - } - ], - "signatures": [ - { - "id": 1507, - "name": "dispose", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tears down the client's background work: stops the auto-refresh interval,\nremoves the " - }, - { - "kind": "code", - "text": "`visibilitychange`" - }, - { - "kind": "text", - "text": " listener, closes the cross-tab\n" - }, - { - "kind": "code", - "text": "`BroadcastChannel`" - }, - { - "kind": "text", - "text": ", and clears registered " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " subscribers.\n\nCall this from cleanup hooks when the client is being replaced before\nits JS realm is destroyed. React Strict Mode and HMR are the common\ncases. Any in-flight " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " calls continue to completion and may still\nwrite to storage; dispose doesn't abort them or erase storage.\n\nLifecycle caveat: because in-flight refreshes are not aborted, a\ndisposed instance can still persist a rotated session to storage after\n" - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " returns. A subsequent " - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " against the same\n" - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " will pick up that session on its next read. If you need\nstrict isolation between client lifecycles, await any pending auth\noperation before calling " - }, - { - "kind": "code", - "text": "`dispose()`" - }, - { - "kind": "text", - "text": " (or change the " - }, - { - "kind": "code", - "text": "`storageKey`" - }, - { - "kind": "text", - "text": " for\nthe replacement client).\n\nSafe to call repeatedly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@example", - "name": "Cleanup on React unmount", - "content": [ - { - "kind": "code", - "text": "```ts\nuseEffect(() => {\n const client = createClient(...)\n return () => { client.auth.dispose() }\n}, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2320, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1318, - "name": "exchangeCodeForSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 797, - "character": 4 - } - ], - "signatures": [ - { - "id": 1319, - "name": "exchangeCodeForSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Used when " - }, - { - "kind": "code", - "text": "`flowType`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`pkce`" - }, - { - "kind": "text", - "text": " in client options." - } - ] - }, - { - "tag": "@example", - "name": "Exchange Auth Code", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Exchange Auth Code\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n session: {\n access_token: '',\n token_type: 'bearer',\n expires_in: 3600,\n expires_at: 1700000000,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com'\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n \"provider\": \"email\",\n \"providers\": [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n provider_token: '',\n provider_refresh_token: ''\n },\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n redirectType: null\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 797, - "character": 4 - } - ], - "parameters": [ - { - "id": 1320, - "name": "authCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1525, - "name": "getClaims", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 4 - } - ], - "signatures": [ - { - "id": 1526, - "name": "getClaims", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" - }, - { - "kind": "code", - "text": "`/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser" - }, - { - "kind": "text", - "text": ") to verify the JWT." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\n- A network request is sent to your project's JWT signing key discovery endpoint " - }, - { - "kind": "code", - "text": "`https://project-id.supabase.co/auth/v1/.well-known/jwks.json`" - }, - { - "kind": "text", - "text": ", which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook)." - } - ] - }, - { - "tag": "@example", - "name": "Get JWT claims, header and signature", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getClaims()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get JWT claims, header and signature\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"claims\": {\n \"aal\": \"aal1\",\n \"amr\": [{\n \"method\": \"email\",\n \"timestamp\": 1715766000\n }],\n \"app_metadata\": {},\n \"aud\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"exp\": 1715769600,\n \"iat\": 1715766000,\n \"is_anonymous\": false,\n \"iss\": \"https://project-id.supabase.co/auth/v1\",\n \"phone\": \"+13334445555\",\n \"role\": \"authenticated\",\n \"session_id\": \"11111111-1111-1111-1111-111111111111\",\n \"sub\": \"11111111-1111-1111-1111-111111111111\",\n \"user_metadata\": {}\n },\n \"header\": {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"signature\": [/** Uint8Array */],\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 4 - } - ], - "parameters": [ - { - "id": 1527, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getSession" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1528, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Various additional options that allow you to customize the\n behavior of this method." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1529, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1531, - "name": "allowExpired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " the " - }, - { - "kind": "code", - "text": "`exp`" - }, - { - "kind": "text", - "text": " claim will not be validated against the current time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2468, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1532, - "name": "jwks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2470, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1533, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1534, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2471, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1534] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2470, - "character": 15 - } - ] - } - } - }, - { - "id": 1530, - "name": "keys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Please use options.jwks instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2466, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2166, - "name": "JWK", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1531, 1532, 1530] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2462, - "character": 38 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1535, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1536, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2474, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1537, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1538, - "name": "claims", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2475, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 2146, - "name": "JwtPayload", - "package": "@supabase/auth-js" - } - }, - { - "id": 1539, - "name": "header", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2476, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 2130, - "name": "JwtHeader", - "package": "@supabase/auth-js" - } - }, - { - "id": 1540, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2477, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1538, 1539, 1540] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2474, - "character": 14 - } - ] - } - } - }, - { - "id": 1541, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2479, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1536, 1541] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2473, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1542, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1543, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2481, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1544, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2482, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1543, 1544] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2480, - "character": 8 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1545, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1546, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2484, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1547, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2485, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1546, 1547] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2483, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1357, - "name": "getSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 4 - } - ], - "signatures": [ - { - "id": 1358, - "name": "getSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#getUser()" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " instead.\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\n- The session contains an access token (signed JWT), a refresh token and the user object.\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\n- When using in a browser, or you've called " - }, - { - "kind": "code", - "text": "`startAutoRefresh()`" - }, - { - "kind": "text", - "text": " in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using " - }, - { - "kind": "code", - "text": "`getClaims()`" - }, - { - "kind": "text", - "text": " or your own JWT verification library to securely establish the user's identity and access. You can also use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch the user object directly from the Auth server for this purpose.\n- Cross-tab refresh races are handled by the GoTrue server (the rotated token from the first tab is returned to subsequent tabs via the parent-of-active mechanism), so no client-side serialization is needed." - } - ] - }, - { - "tag": "@example", - "name": "Get the session data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getSession()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the session data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1359, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1360, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1417, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1361, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1362, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1418, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1362] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1417, - "character": 14 - } - ] - } - } - }, - { - "id": 1363, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1420, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1360, 1363] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1416, - "character": 26 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1364, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1365, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1422, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1366, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1367, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1423, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1367] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1422, - "character": 14 - } - ] - } - } - }, - { - "id": 1368, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1425, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1365, 1368] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1421, - "character": 8 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1369, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1370, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1427, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1371, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1372, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1428, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1372] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1427, - "character": 14 - } - ] - } - } - }, - { - "id": 1373, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1430, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1370, 1373] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1426, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1377, - "name": "getUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1528, - "character": 4 - } - ], - "signatures": [ - { - "id": 1378, - "name": "getUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method fetches the user object from the database instead of local session.\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\n- Should always be used when checking for user authorization on the server. On the client, you can instead use " - }, - { - "kind": "code", - "text": "`getSession().session.user`" - }, - { - "kind": "text", - "text": " for faster results. " - }, - { - "kind": "code", - "text": "`getSession`" - }, - { - "kind": "text", - "text": " is insecure on the server." - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with the current existing session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the logged in user with the current existing session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the logged in user with a custom access token jwt", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data: { user } } = await supabase.auth.getUser(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1528, - "character": 4 - } - ], - "parameters": [ - { - "id": 1379, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1464, - "name": "getUserIdentities", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 4 - } - ], - "signatures": [ - { - "id": 1465, - "name": "getUserIdentities", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets all the identities linked to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`getUserIdentities()`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Returns a list of identities linked to the user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.getUserIdentities()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Returns a list of identities linked to the user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"2024-01-01T00:00:00Z\",\n \"user_id\": \"2024-01-01T00:00:00Z\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ]\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1466, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1467, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2126, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1469, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2127, - "character": 12 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1469] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2126, - "character": 14 - } - ] - } - } - }, - { - "id": 1470, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2129, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1467, 1470] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2125, - "character": 33 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1471, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1472, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2131, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1473, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2132, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1472, 1473] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2130, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1303, - "name": "initialize", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 154, - "character": 4 - } - ], - "signatures": [ - { - "id": 1304, - "name": "initialize", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 154, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2106, - "name": "InitializeResult", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1298, - "name": "isThrowOnErrorEnabled", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 138, - "character": 4 - } - ], - "signatures": [ - { - "id": 1299, - "name": "isThrowOnErrorEnabled", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns whether error throwing mode is enabled for this client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 138, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 1474, - "name": "linkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2138, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2142, - "character": 4 - } - ], - "signatures": [ - { - "id": 1475, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2138, - "character": 4 - } - ], - "parameters": [ - { - "id": 1476, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1812, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1685, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1477, - "name": "linkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Links an OIDC identity to an existing user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2142, - "character": 4 - } - ], - "parameters": [ - { - "id": 1478, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1824, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1428, - "name": "onAuthStateChange", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 4 - } - ], - "signatures": [ - { - "id": 1429, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens.\nSafe to use without an async function as callback." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 4 - } - ], - "parameters": [ - { - "id": 1430, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1431, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 32 - } - ], - "signatures": [ - { - "id": 1432, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 32 - } - ], - "parameters": [ - { - "id": 1433, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1434, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1435, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1436, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1983, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1437, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1438, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1984, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1438] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1983, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1436] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1982, - "character": 92 - } - ] - } - } - }, - { - "id": 1439, - "name": "onAuthStateChange", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive a notification every time an auth event happens. Common reentry\npatterns (" - }, - { - "kind": "code", - "text": "`getUser`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`setSession`" - }, - { - "kind": "text", - "text": ", reading the session from inside a\nhandler) complete normally. One hazard remains: calling " - }, - { - "kind": "code", - "text": "`refreshSession`" - }, - { - "kind": "text", - "text": "\n(or anything that routes through " - }, - { - "kind": "code", - "text": "`_callRefreshToken`" - }, - { - "kind": "text", - "text": ") from inside a\n" - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " handler. " - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " resolves only after\n" - }, - { - "kind": "code", - "text": "`_notifyAllSubscribers`" - }, - { - "kind": "text", - "text": " returns, so the inner refresh dedupes onto the\nouter's unresolved promise and the two wait on each other." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Async callbacks can deadlock when they trigger a nested\nrefresh from a " - }, - { - "kind": "code", - "text": "`TOKEN_REFRESHED`" - }, - { - "kind": "text", - "text": " event. Prefer the sync overload, or move\nrefresh-triggering work outside the callback." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 4 - } - ], - "parameters": [ - { - "id": 1440, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A callback function to be invoked when an auth event happens." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1441, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 32 - } - ], - "signatures": [ - { - "id": 1442, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 32 - } - ], - "parameters": [ - { - "id": 1443, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1444, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1446, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2003, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1448, - "name": "subscription", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2004, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1764, - "name": "Subscription", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1448] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2003, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1446] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2002, - "character": 101 - } - ] - } - } - } - ] - }, - { - "id": 1351, - "name": "reauthenticate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1269, - "character": 4 - } - ], - "signatures": [ - { - "id": 1352, - "name": "reauthenticate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used together with " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " when a user's password needs to be updated.\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\n- After receiving the OTP, include it as the " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " in your " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " call to finalize the password change." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Send reauthentication nonce\nSends a reauthentication nonce to the user's email or phone number." - } - ] - }, - { - "tag": "@example", - "name": "Send reauthentication nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.reauthenticate()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1269, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1405, - "name": "refreshSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 4 - } - ], - "signatures": [ - { - "id": 1406, - "name": "refreshSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method will refresh and return a new session whether the current one is expired or not." - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using the current session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession()\nconst { session, user } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Refresh session using the current session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Refresh session using a refresh token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\nconst { session, user } = data\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 4 - } - ], - "parameters": [ - { - "id": 1407, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session. If passed in, it must contain a refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1408, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1409, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1908, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1409] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1907, - "character": 36 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1551, - "name": "registerPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2508, - "character": 4 - } - ], - "signatures": [ - { - "id": 1552, - "name": "registerPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Register a passkey for the current authenticated user. Handles the full WebAuthn ceremony:\n1. Fetches registration challenge from server\n2. Prompts user via navigator.credentials.create()\n3. Verifies credential with server\n\nRequires an active session. Requires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2508, - "character": 4 - } - ], - "parameters": [ - { - "id": 1553, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2450, - "name": "RegisterPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1354, - "name": "resend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1330, - "character": 4 - } - ], - "signatures": [ - { - "id": 1355, - "name": "resend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Resends a signup confirmation, email change or phone change email to the user.\n- Passwordless sign-ins can be resent by calling the " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " method again.\n- Password recovery emails can be resent by calling the " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " method again.\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " again to resend the OTP).\n- You can specify a redirect url when you resend an email link using the " - }, - { - "kind": "code", - "text": "`emailRedirectTo`" - }, - { - "kind": "text", - "text": " option." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend an email signup confirmation\nResends the email signup confirmation to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend an email signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'signup',\n email: 'email@example.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend a phone signup confirmation\nResends the phone signup confirmation email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend a phone signup confirmation", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'sms',\n phone: '1234567890'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend email change email\nResends the email change email to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend email change email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'email_change',\n email: 'email@example.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Resend phone change OTP\nResends the phone change OTP to the user" - } - ] - }, - { - "tag": "@example", - "name": "Resend phone change OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'phone_change',\n phone: '1234567890'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1330, - "character": 4 - } - ], - "parameters": [ - { - "id": 1356, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1910, - "name": "ResendParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1671, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1450, - "name": "resetPasswordForEmail", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 4 - } - ], - "signatures": [ - { - "id": 1451, - "name": "resetPasswordForEmail", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a password reset request to an email address. This method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\n- The " - }, - { - "kind": "code", - "text": "`resetPasswordForEmail()`" - }, - { - "kind": "text", - "text": " only sends a password reset link to the user's email.\nTo update the user's password, see [" - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-updateuser).\n- A " - }, - { - "kind": "code", - "text": "`PASSWORD_RECOVERY`" - }, - { - "kind": "text", - "text": " event will be emitted when the password recovery link is clicked.\nYou can use [" - }, - { - "kind": "code", - "text": "`onAuthStateChange()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\n- When the user clicks the reset link in the email they are redirected back to your application.\nYou can configure the URL that the user is redirected to with the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter.\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- After the user has been redirected successfully, prompt them for a new password and call " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": ":\n" - }, - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: new_password\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\n redirectTo: 'https://example.com/update-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Reset password\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {}\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Reset password (React)", - "content": [ - { - "kind": "code", - "text": "```js\n/**\n * Step 1: Send the user an email to get a password reset token.\n * This email contains a link which sends the user back to your application.\n */\nconst { data, error } = await supabase.auth\n .resetPasswordForEmail('user@email.com')\n\n/**\n * Step 2: Once the user is redirected back to your application,\n * ask the user to reset their password.\n */\n useEffect(() => {\n supabase.auth.onAuthStateChange(async (event, session) => {\n if (event == \"PASSWORD_RECOVERY\") {\n const newPassword = prompt(\"What would you like your new password to be?\");\n const { data, error } = await supabase.auth\n .updateUser({ password: newPassword })\n\n if (data) alert(\"Password updated successfully!\")\n if (error) alert(\"There was an error updating your password.\")\n }\n })\n }, [])\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 4 - } - ], - "parameters": [ - { - "id": 1452, - "name": "email", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email address of the user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1453, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1456, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2077, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1455, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to send the user to after they click the password reset link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2076, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1456, 1455] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2075, - "character": 51 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1457, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1458, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2079, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1459, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 1460, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2080, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1458, 1460] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2078, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1461, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1462, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2082, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1463, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2083, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1462, 1463] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2081, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1393, - "name": "setSession", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 4 - } - ], - "signatures": [ - { - "id": 1394, - "name": "setSession", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method sets the session using an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`refresh_token`" - }, - { - "kind": "text", - "text": ".\n- If successful, a " - }, - { - "kind": "code", - "text": "`SIGNED_IN`" - }, - { - "kind": "text", - "text": " event is emitted." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Set the session\nSets the session data from an access_token and refresh_token, then returns an auth response or error." - } - ] - }, - { - "tag": "@example", - "name": "Set the session", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.setSession({\n access_token,\n refresh_token\n })\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set the session\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"11111111-1111-1111-1111-111111111111\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"2024-01-01T00:00:00Z\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"token_type\": \"bearer\",\n \"expires_in\": 3500,\n \"expires_at\": 1700000000\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 4 - } - ], - "parameters": [ - { - "id": 1395, - "name": "currentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The current session that minimally contains an access token and refresh token." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1396, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1397, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1775, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1398, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1776, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1397, 1398] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1774, - "character": 31 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1306, - "name": "signInAnonymously", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 235, - "character": 4 - } - ], - "signatures": [ - { - "id": 1307, - "name": "signInAnonymously", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new anonymous user." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A session where the is_anonymous claim in the access token JWT set to true" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Returns an anonymous user\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the " - }, - { - "kind": "code", - "text": "`options`" - }, - { - "kind": "text", - "text": " param." - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n captchaToken\n }\n});\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create an anonymous user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create an anonymous user with custom user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n data\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 235, - "character": 4 - } - ], - "parameters": [ - { - "id": 1308, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1774, - "name": "SignInAnonymouslyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1339, - "name": "signInWithIdToken", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 977, - "character": 4 - } - ], - "signatures": [ - { - "id": 1340, - "name": "signInWithIdToken", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use an ID token to sign in.\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API." - } - ] - }, - { - "tag": "@example", - "name": "Sign In using ID Token", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithIdToken({\n provider: 'google',\n token: 'your-id-token'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign In using ID Token\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 977, - "character": 4 - } - ], - "parameters": [ - { - "id": 1341, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1824, - "name": "SignInWithIdTokenCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1676, - "name": "AuthTokenResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1315, - "name": "signInWithOAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 626, - "character": 4 - } - ], - "signatures": [ - { - "id": 1316, - "name": "signInWithOAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in using a third-party provider with redirect\n- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the " - }, - { - "kind": "code", - "text": "`redirectTo`" - }, - { - "kind": "text", - "text": " parameter. This parameter defaults to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign in using a third-party provider with redirect", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n redirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with scopes and access provider tokens\nIf you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the " - }, - { - "kind": "code", - "text": "`scopes`" - }, - { - "kind": "text", - "text": " option takes in **a space-separated list** of scopes.\n\nBecause OAuth sign-in often includes redirects, you should register an " - }, - { - "kind": "code", - "text": "`onAuthStateChange`" - }, - { - "kind": "text", - "text": " callback immediately after you create the Supabase client. This callback will listen for the presence of " - }, - { - "kind": "code", - "text": "`provider_token`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`provider_refresh_token`" - }, - { - "kind": "text", - "text": " properties on the " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\n\nFinally, make sure you remove them from local storage on the " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with scopes and access provider tokens", - "content": [ - { - "kind": "code", - "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n\n// Call this on your Sign in with GitHub button to initiate OAuth\n// with GitHub with the requested elevated scopes.\nawait supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n scopes: 'repo gist notifications'\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 626, - "character": 4 - } - ], - "parameters": [ - { - "id": 1317, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1812, - "name": "SignInWithOAuthCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1685, - "name": "OAuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1342, - "name": "signInWithOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1055, - "character": 4 - } - ], - "signatures": [ - { - "id": 1343, - "name": "signInWithOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " 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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email or phone number.\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\n- If the user doesn't exist, " - }, - { - "kind": "code", - "text": "`signInWithOtp()`" - }, - { - "kind": "text", - "text": " will signup the user instead. To restrict this behavior, you can set " - }, - { - "kind": "code", - "text": "`shouldCreateUser`" - }, - { - "kind": "text", - "text": " in " - }, - { - "kind": "code", - "text": "`SignInWithPasswordlessCredentials.options`" - }, - { - "kind": "text", - "text": " to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ".\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\n- If you're using phone, you can configure whether you want the user to receive a OTP.\n- The magic link's destination URL is determined by the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include " - }, - { - "kind": "code", - "text": "`{{ .Token }}`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`{{ .ConfirmationURL }}`" - }, - { - "kind": "text", - "text": ".\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with email\nThe user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n email: 'example@email.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": null,\n \"session\": null\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with SMS OTP\nThe user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with SMS OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign in with WhatsApp OTP\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with WhatsApp OTP", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n options: {\n channel:'whatsapp',\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1055, - "character": 4 - } - ], - "parameters": [ - { - "id": 1344, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1793, - "name": "SignInWithPasswordlessCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1671, - "name": "AuthOtpResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1548, - "name": "signInWithPasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2497, - "character": 4 - } - ], - "signatures": [ - { - "id": 1549, - "name": "signInWithPasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with a passkey. Handles the full WebAuthn ceremony:\n1. Fetches authentication challenge from server\n2. Prompts user via navigator.credentials.get()\n3. Verifies credential with server and creates session\n\nRequires " - }, - { - "kind": "code", - "text": "`auth.experimental.passkey: true`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2497, - "character": 4 - } - ], - "parameters": [ - { - "id": 1550, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2444, - "name": "SignInWithPasskeyCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1312, - "name": "signInWithPassword", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 546, - "character": 4 - } - ], - "signatures": [ - { - "id": 1313, - "name": "signInWithPassword", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in an existing user with an email and password or phone and password.\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\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Requires either an email and password or a phone number and password." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign in with email and password\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with phone and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n phone: '+13334445555',\n password: 'some-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nLog the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so fields like " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " aren't hidden. The " - }, - { - "kind": "code", - "text": "`error.code`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`'invalid_credentials'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'email_not_confirmed'`" - }, - { - "kind": "text", - "text": ") is often more useful for branching than " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": ", and the full object surfaces both." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\nif (error) {\n console.error(error)\n return\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 546, - "character": 4 - } - ], - "parameters": [ - { - "id": 1314, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1788, - "name": "SignInWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1680, - "name": "AuthTokenResponsePassword", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1348, - "name": "signInWithSSO", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1247, - "character": 4 - } - ], - "signatures": [ - { - "id": 1349, - "name": "signInWithSSO", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\n- If you've associated an email domain to the identity provider, you can use the " - }, - { - "kind": "code", - "text": "`domain`" - }, - { - "kind": "text", - "text": " property to start a sign-in flow.\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the " - }, - { - "kind": "code", - "text": "`providerId`" - }, - { - "kind": "text", - "text": " property. For example:\n - Mapping specific user email addresses with an identity provider.\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with email domain", - "content": [ - { - "kind": "code", - "text": "```js\n // You can extract the user's email domain and use it to trigger the\n // authentication flow with the correct identity provider.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n domain: 'company.com'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with provider UUID", - "content": [ - { - "kind": "code", - "text": "```js\n // Useful when you need to map a user's sign in request according\n // to different rules that can't use email domains.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1247, - "character": 4 - } - ], - "parameters": [ - { - "id": 1350, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1924, - "name": "SignInWithSSO", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1698, - "name": "SSOResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1321, - "name": "signInWithWeb3", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 4 - } - ], - "signatures": [ - { - "id": 1322, - "name": "signInWithWeb3", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." - } - ], - "blockTags": [ - { - "tag": "@reference", - "content": [ - { - "kind": "text", - "text": "https://eips.ethereum.org/EIPS/eip-4361" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it." - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana or Ethereum (Window API)", - "content": [ - { - "kind": "code", - "text": "```js\n // uses window.ethereum for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n\n // uses window.solana for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Ethereum (Message and Signature)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n message: '',\n signature: '',\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Brave)", - "content": [ - { - "kind": "code", - "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet: window.braveSolana\n })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign in with Solana (Wallet Adapter)", - "content": [ - { - "kind": "code", - "text": "```jsx\n function SignInButton() {\n const wallet = useWallet()\n\n return (\n <>\n {wallet.connected ? (\n {\n supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet,\n })\n }}\n >\n Sign in with Solana\n \n ) : (\n \n )}\n \n )\n}\n\nfunction App() {\n const endpoint = clusterApiUrl('devnet')\n const wallets = useMemo(() => [], [])\n\n return (\n \n \n \n \n \n \n \n )\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 4 - } - ], - "parameters": [ - { - "id": 1323, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1885, - "name": "Web3Credentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1324, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1325, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 887, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1326, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1327, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 888, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1328, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 889, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1327, 1328] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 887, - "character": 14 - } - ] - } - } - }, - { - "id": 1329, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 891, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1325, 1329] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 886, - "character": 58 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1330, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1331, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 893, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1332, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1333, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 894, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1334, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 895, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1333, 1334] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 893, - "character": 14 - } - ] - } - } - }, - { - "id": 1335, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 897, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1331, 1335] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 892, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1418, - "name": "signOut", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 4 - } - ], - "signatures": [ - { - "id": 1419, - "name": "signOut", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inside a browser context, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " - }, - { - "kind": "code", - "text": "`\"SIGNED_OUT\"`" - }, - { - "kind": "text", - "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " - }, - { - "kind": "code", - "text": "`auth.api.signOut(JWT: string)`" - }, - { - "kind": "text", - "text": ".\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n\nIf using " - }, - { - "kind": "code", - "text": "`others`" - }, - { - "kind": "text", - "text": " scope, no " - }, - { - "kind": "code", - "text": "`SIGNED_OUT`" - }, - { - "kind": "text", - "text": " event is fired!\n\n**Warning:** the default " - }, - { - "kind": "code", - "text": "`scope`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`'global'`" - }, - { - "kind": "text", - "text": ". This signs the user out of\n**every device they are currently signed in on**, not just the current\ntab/session. If you only want to sign the user out of the current session\n(the behavior most other auth libraries default to), pass\n" - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " explicitly." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, " - }, - { - "kind": "code", - "text": "`signOut()`" - }, - { - "kind": "text", - "text": " uses the **global** scope, which signs out the user\n on every device they are signed in on (not just the current one). Pass\n " - }, - { - "kind": "code", - "text": "`{ scope: 'local' }`" - }, - { - "kind": "text", - "text": " to only sign out the current session. This is\n usually what apps want on a \"Sign out\" button, especially when users\n sign in from multiple devices and do not expect signing out of one to\n terminate the others.\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires." - } - ] - }, - { - "tag": "@example", - "name": "Sign out of every device (global – default)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out only the current session (recommended for most apps)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign out of all other sessions, keep the current one", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 4 - } - ], - "parameters": [ - { - "id": 1420, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2121, - "name": "SignOut", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1421, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1422, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1971, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1422] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1970, - "character": 40 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1309, - "name": "signUp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 413, - "character": 4 - } - ], - "signatures": [ - { - "id": 1310, - "name": "signUp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A logged-in session if the server has \"autoconfirm\" ON" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A user if the server has \"autoconfirm\" OFF" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\n- **Confirm email** determines if users need to confirm their email address after signing up.\n - If **Confirm email** is enabled, a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " is returned but " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " is null.\n - If **Confirm email** is disabled, both a " - }, - { - "kind": "code", - "text": "`user`" - }, - { - "kind": "text", - "text": " and a " - }, - { - "kind": "code", - "text": "`session`" - }, - { - "kind": "text", - "text": " are returned.\n- When the user confirms their email address, they are redirected to the [" - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your " - }, - { - "kind": "code", - "text": "`SITE_URL`" - }, - { - "kind": "text", - "text": " or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\n- If signUp() is called for an existing confirmed user:\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, " - }, - { - "kind": "code", - "text": "`User already registered`" - }, - { - "kind": "text", - "text": " is returned.\n- To fetch the currently logged-in user, refer to [" - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-getuser)." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with an email and password", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Sign up with an email and password\n" - }, - { - "kind": "code", - "text": "```json\n// Some fields may be null if \"confirm email\" is enabled.\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (SMS)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'sms'\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a phone number and password (whatsapp)\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a phone number and password (whatsapp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'whatsapp'\n }\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Sign up with additional user metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n data: {\n first_name: 'John',\n age: 27,\n }\n }\n }\n)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Sign up with a redirect URL\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." - } - ] - }, - { - "tag": "@example", - "name": "Sign up with a redirect URL", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 413, - "character": 4 - } - ], - "parameters": [ - { - "id": 1311, - "name": "credentials", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1780, - "name": "SignUpWithPasswordCredentials", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1502, - "name": "startAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2258, - "character": 4 - } - ], - "signatures": [ - { - "id": 1503, - "name": "startAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClientOptions#autoRefreshToken", - "target": 1615 - }, - { - "kind": "text", - "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "#stopAutoRefresh" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- To give this hint to the application, you should be calling this method when the app is in focus and calling " - }, - { - "kind": "code", - "text": "`supabase.auth.stopAutoRefresh()`" - }, - { - "kind": "text", - "text": " when it's out of focus." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2258, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1504, - "name": "stopAutoRefresh", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2289, - "character": 4 - } - ], - "signatures": [ - { - "id": 1505, - "name": "stopAutoRefresh", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#startAutoRefresh" - }, - { - "kind": "text", - "text": " for more details." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session." - } - ] - }, - { - "tag": "@example", - "name": "Start and stop auto refresh in React Native", - "content": [ - { - "kind": "code", - "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2289, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1481, - "name": "unlinkIdentity", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 4 - } - ], - "signatures": [ - { - "id": 1482, - "name": "unlinkIdentity", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " - }, - { - "kind": "code", - "text": "`unlinkIdentity()`" - }, - { - "kind": "text", - "text": ".\n- The user must have at least 2 identities in order to unlink an identity.\n- The identity to be unlinked must belong to the user." - } - ] - }, - { - "tag": "@example", - "name": "Unlink an identity", - "content": [ - { - "kind": "code", - "text": "```js\n// retrieve all identities linked to a user\nconst identities = await supabase.auth.getUserIdentities()\n\n// find the google identity\nconst googleIdentity = identities.find(\n identity => identity.provider === 'google'\n)\n\n// unlink the google identity\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 4 - } - ], - "parameters": [ - { - "id": 1483, - "name": "identity", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1484, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1485, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2171, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1486, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 1487, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2172, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1485, 1487] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2170, - "character": 52 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1488, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1489, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2174, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1490, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2175, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1489, 1490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 2173, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1381, - "name": "updateUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 4 - } - ], - "signatures": [ - { - "id": 1382, - "name": "updateUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates user data for a logged in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- In order to use the " - }, - { - "kind": "code", - "text": "`updateUser()`" - }, - { - "kind": "text", - "text": " method, the user needs to be signed in first.\n- By default, email updates sends a confirmation link to both the user's current and new email.\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers)." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\nSends a \"Confirm Email Change\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email)." - } - ] - }, - { - "tag": "@example", - "name": "Update the email for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n email: 'new@email.com'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update the email for an authenticated user\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"new_email\": \"new@email.com\",\n \"email_change_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the phone number for an authenticated user\nSends a one-time password (OTP) to the new phone number." - } - ] - }, - { - "tag": "@example", - "name": "Update the phone number for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n phone: '123456789'\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update the password for an authenticated user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password'\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's metadata\nUpdates the user's custom metadata.\n\n**Note**: The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column in your Supabase database. When calling " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": ", the data will be available as " - }, - { - "kind": "code", - "text": "`user.user_metadata`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's metadata", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n data: { hello: 'world' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Update the user's password with a nonce\nIf **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." - } - ] - }, - { - "tag": "@example", - "name": "Update the user's password with a nonce", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password',\n nonce: '123456'\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 4 - } - ], - "parameters": [ - { - "id": 1383, - "name": "attributes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - } - }, - { - "id": 1384, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1386, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1645, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1386] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1644, - "character": 53 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1701, - "name": "UserResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1345, - "name": "verifyOtp", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1193, - "character": 4 - } - ], - "signatures": [ - { - "id": 1346, - "name": "verifyOtp", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- The " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " method takes in different verification types.\n- If a phone number is used, the type can either be:\n 1. " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`phone_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new phone number during a phone number update process.\n- If an email address is used, the type can be one of the following (note: " - }, - { - "kind": "code", - "text": "`signup`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`magiclink`" - }, - { - "kind": "text", - "text": " types are deprecated):\n 1. " - }, - { - "kind": "code", - "text": "`email`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\n 2. " - }, - { - "kind": "code", - "text": "`recovery`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent for account recovery, typically after a password reset request.\n 3. " - }, - { - "kind": "code", - "text": "`invite`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent as part of an invitation to join a project or organization.\n 4. " - }, - { - "kind": "code", - "text": "`email_change`" - }, - { - "kind": "text", - "text": " – Used when verifying an OTP sent to a new email address during an email update process.\n- The verification type used should be determined based on the corresponding auth method called before " - }, - { - "kind": "code", - "text": "`verifyOtp`" - }, - { - "kind": "text", - "text": " to sign up / sign-in a user.\n- The " - }, - { - "kind": "code", - "text": "`TokenHash`" - }, - { - "kind": "text", - "text": " is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details." - } - ] - }, - { - "tag": "@example", - "name": "Verify Signup One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify Signup One-Time Password (OTP)\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify SMS One-Time Password (OTP)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Verify Email Auth (Token Hash)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 1193, - "character": 4 - } - ], - "parameters": [ - { - "id": 1347, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1886, - "name": "VerifyOtpParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1662, - "name": "AuthResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1223] - }, - { - "title": "Properties", - "children": [ - 1260, 1227, 1254, 1255, 1245, 1291, 1262, 1290, 1277, 1232, 1275, 1271, 1261, 1285, - 1286, 1289, 1292, 1293, 1249, 1228, 1229, 1230, 1287, 1246, 1259, 1253, 1247, 1231, - 1276, 1288, 1270, 1248, 1256 - ] - }, - { - "title": "Accessors", - "children": [1233, 1241] - }, - { - "title": "Methods", - "children": [ - 1410, 1399, 1423, 1387, 1506, 1318, 1525, 1357, 1377, 1464, 1303, 1298, 1474, 1428, - 1351, 1405, 1551, 1354, 1450, 1393, 1306, 1339, 1315, 1342, 1548, 1312, 1348, 1321, - 1418, 1309, 1502, 1504, 1481, 1381, 1345 - ] - } - ], - "categories": [ - { - "title": "Auth", - "children": [ - 1506, 1318, 1525, 1357, 1377, 1464, 1303, 1351, 1405, 1551, 1354, 1450, 1393, 1306, - 1339, 1315, 1342, 1548, 1312, 1348, 1321, 1418, 1309, 1502, 1504, 1481, 1381, 1345 - ] - }, - { - "title": "Other", - "children": [ - 1223, 1260, 1227, 1254, 1255, 1245, 1291, 1262, 1290, 1277, 1232, 1275, 1271, 1261, - 1285, 1286, 1289, 1292, 1293, 1249, 1228, 1229, 1230, 1287, 1246, 1259, 1253, 1247, - 1231, 1276, 1288, 1270, 1248, 1256, 1233, 1241, 1410, 1399, 1423, 1387, 1298, 1474, - 1428 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/GoTrueClient.d.ts", - "line": 6, - "character": 21 - } - ] - }, - { - "id": 1571, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client doesn't call " - }, - { - "kind": "code", - "text": "`navigator.locks`" - }, - { - "kind": "text", - "text": ", so this error\nnever originates from " - }, - { - "kind": "code", - "text": "`supabase.auth.*`" - }, - { - "kind": "text", - "text": " calls. Direct callers of\n" - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " still receive it on acquire timeout." - } - ] - } - ] - }, - "children": [ - { - "id": 1572, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 29, - "character": 4 - } - ], - "signatures": [ - { - "id": 1573, - "name": "NavigatorLockAcquireTimeoutError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 29, - "character": 4 - } - ], - "parameters": [ - { - "id": 1574, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1571, - "name": "NavigatorLockAcquireTimeoutError", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.constructor" - } - }, - { - "id": 1575, - "name": "isAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 28, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": true - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "LockAcquireTimeoutError.isAcquireTimeout" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [1572] - }, - { - "title": "Properties", - "children": [1575] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 36, - "character": 21 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError" - }, - "name": "LockAcquireTimeoutError", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 57, - "name": "PostgrestBuilder", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 58, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 59, - "name": "PostgrestBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 60, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 61, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 62, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "parameters": [ - { - "id": 63, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 69, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 72, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 73, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 74, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 75, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 76, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 77, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 78, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 79, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 67, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 80, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 65, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 83, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 68, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 81, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 70, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 71, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 66, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 82, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [69, 72, 67, 80, 65, 83, 68, 81, 70, 71, 66, 82] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 88, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 91, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 92, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 93, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 94, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 95, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 96, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 97, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 98, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 86, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 99, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 84, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 102, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 87, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 100, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 89, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 90, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 85, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 101, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 130, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 131, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 132, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 133, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 134, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 135, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [135] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 136, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 137, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [137] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 111, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 112, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 113, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 127, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 824, - "character": 2 - } - ], - "signatures": [ - { - "id": 128, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 824, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 129, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 129, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 107, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 108, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 109, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 110, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 105, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 106, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 114, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 115, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 116, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - }, - { - "id": 117, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 118, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 119, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 120, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 121, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 122, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 123, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 124, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 125, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PromiseLike.then" - } - }, - { - "id": 103, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 104, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 60, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [58] - }, - { - "title": "Properties", - "children": [88, 91, 86, 99, 84, 102, 87, 100, 89, 90, 85, 101] - }, - { - "title": "Methods", - "children": [130, 111, 127, 107, 105, 114, 103] - } - ], - "categories": [ - { - "title": "Database", - "children": [58, 130, 127, 107, 105, 103] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [111] - }, - { - "title": "Other", - "children": [88, 91, 86, 99, 84, 102, 87, 100, 89, 90, 85, 101, 114] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 674, - "character": 23 - } - ], - "typeParameters": [ - { - "id": 138, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 139, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 140, - "name": "ThrowOnError", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "default": { - "type": "literal", - "value": false - } - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 559, - "name": "PostgrestTransformBuilder" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 62, - "name": "ThrowOnError", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.ThrowOnError", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 61, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - }, - { - "id": 830, - "name": "PostgrestError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error format\n\nReturned by every PostgREST request that fails. When something fails, the\nsingle most useful field is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — Postgres often returns the\nactionable fix there, not in " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": ". Always log the full object (e.g.\n" - }, - { - "kind": "code", - "text": "`console.error(error)`" - }, - { - "kind": "text", - "text": "); logging only " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": " hides the hint.\n\nRead the fields in roughly this order of usefulness:\n\n- " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — actionable guidance from the database when available. For\n permission-denied errors (" - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "), this is the literal SQL to fix the\n problem, e.g.\n " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.users TO anon;\"`" - }, - { - "kind": "text", - "text": ".\n Missing column? " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " suggests the column you probably meant. Whenever\n Postgres knows the fix, it puts it in " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": ".\n- " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": " — stable error code from PostgREST (e.g. " - }, - { - "kind": "code", - "text": "`PGRST301`" - }, - { - "kind": "text", - "text": ") or Postgres\n (e.g. " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": "). Branch on this rather than on " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " text.\n- " - }, - { - "kind": "code", - "text": "`details`" - }, - { - "kind": "text", - "text": " — extra context, often the offending value, key, or row.\n- " - }, - { - "kind": "code", - "text": "`message`" - }, - { - "kind": "text", - "text": " — human-readable summary. Useful in UI strings; less useful\n for debugging.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", - "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" - } - ] - }, - "children": [ - { - "id": 831, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 2 - } - ], - "signatures": [ - { - "id": 832, - "name": "PostgrestError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport PostgrestError from '@supabase/postgrest-js'\n\nthrow new PostgrestError({\n message: 'Row level security prevented the request',\n details: 'RLS denied the insert',\n hint: 'Check your policies',\n code: 'PGRST301',\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 2 - } - ], - "parameters": [ - { - "id": 833, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 834, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 838, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 836, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 837, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 46, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 835, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [838, 836, 837, 835] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 43, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 830, - "name": "PostgrestError", - "package": "@supabase/postgrest-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 841, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 29, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 839, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 27, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 840, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 28, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 842, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 2 - } - ], - "signatures": [ - { - "id": 843, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 844, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 849, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 54, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 847, - "name": "details", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 52, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 848, - "name": "hint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 53, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 846, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 51, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 845, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 50, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [849, 847, 848, 846, 845] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 49, - "character": 12 - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [831] - }, - { - "title": "Properties", - "children": [841, 839, 840] - }, - { - "title": "Methods", - "children": [842] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 26, - "character": 14 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 141, - "name": "PostgrestFilterBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 142, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 143, - "name": "PostgrestFilterBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 144, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 145, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 146, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 147, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 148, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 149, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 150, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 151, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 157, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 160, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 161, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 162, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 163, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 164, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 165, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 166, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 167, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 155, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 168, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 153, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 171, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 156, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 169, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 158, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 159, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 154, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 170, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 157, 160, 155, 168, 153, 171, 156, 169, 158, 159, 154, 170 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 561, - "name": "PostgrestTransformBuilder.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 560, - "name": "PostgrestTransformBuilder.constructor" - } - }, - { - "id": 506, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 676, - "name": "PostgrestTransformBuilder.body" - } - }, - { - "id": 509, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 511, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 512, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 513, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 514, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 515, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 516, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 679, - "name": "PostgrestTransformBuilder.fetch" - } - }, - { - "id": 504, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 674, - "name": "PostgrestTransformBuilder.headers" - } - }, - { - "id": 517, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 687, - "name": "PostgrestTransformBuilder.isMaybeSingle" - } - }, - { - "id": 502, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 672, - "name": "PostgrestTransformBuilder.method" - } - }, - { - "id": 520, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 690, - "name": "PostgrestTransformBuilder.retryEnabled" - } - }, - { - "id": 505, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 675, - "name": "PostgrestTransformBuilder.schema" - } - }, - { - "id": 518, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 688, - "name": "PostgrestTransformBuilder.shouldStripNulls" - } - }, - { - "id": 507, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 677, - "name": "PostgrestTransformBuilder.shouldThrowOnError" - } - }, - { - "id": 508, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 678, - "name": "PostgrestTransformBuilder.signal" - } - }, - { - "id": 503, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 673, - "name": "PostgrestTransformBuilder.url" - } - }, - { - "id": 519, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 689, - "name": "PostgrestTransformBuilder.urlLengthLimit" - } - }, - { - "id": 471, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "signatures": [ - { - "id": 472, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "parameters": [ - { - "id": 473, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 642, - "name": "PostgrestTransformBuilder.abortSignal" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 641, - "name": "PostgrestTransformBuilder.abortSignal" - } - }, - { - "id": 310, - "name": "containedBy", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1879, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1880, - "character": 2 - } - ], - "signatures": [ - { - "id": 311, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1879, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 312, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 313, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 312, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 314, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 312, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 315, - "name": "containedBy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1880, - "character": 2 - } - ], - "parameters": [ - { - "id": 316, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 317, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 302, - "name": "contains", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1877, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1878, - "character": 2 - } - ], - "signatures": [ - { - "id": 303, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1877, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 304, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 305, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 304, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 306, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 304, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 307, - "name": "contains", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1878, - "character": 2 - } - ], - "parameters": [ - { - "id": 308, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 309, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 480, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "signatures": [ - { - "id": 481, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 651, - "name": "PostgrestTransformBuilder.csv" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 650, - "name": "PostgrestTransformBuilder.csv" - } - }, - { - "id": 172, - "name": "eq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1731, - "character": 2 - } - ], - "signatures": [ - { - "id": 173, - "name": "eq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nTo check if the value of " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NULL, you should use " - }, - { - "kind": "code", - "text": "`.is()`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1731, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 174, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 175, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 174, - "typeArguments": [ - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 174, - "typeArguments": [ - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 176, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 174, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 484, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "signatures": [ - { - "id": 485, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "parameters": [ - { - "id": 486, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 487, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 488, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1608, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 491, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1611, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 493, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1613, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 490, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1610, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 489, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1609, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 492, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1612, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [488, 491, 493, 490, 489, 492] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1607, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 655, - "name": "PostgrestTransformBuilder.explain" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 654, - "name": "PostgrestTransformBuilder.explain" - } - }, - { - "id": 410, - "name": "filter", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2064, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2065, - "character": 2 - } - ], - "signatures": [ - { - "id": 411, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2064, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 412, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 413, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 412, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 414, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - }, - { - "type": "literal", - "value": "not.match" - }, - { - "type": "literal", - "value": "not.eq" - }, - { - "type": "literal", - "value": "not.neq" - }, - { - "type": "literal", - "value": "not.gt" - }, - { - "type": "literal", - "value": "not.gte" - }, - { - "type": "literal", - "value": "not.lt" - }, - { - "type": "literal", - "value": "not.lte" - }, - { - "type": "literal", - "value": "not.like" - }, - { - "type": "literal", - "value": "not.ilike" - }, - { - "type": "literal", - "value": "not.is" - }, - { - "type": "literal", - "value": "not.isdistinct" - }, - { - "type": "literal", - "value": "not.in" - }, - { - "type": "literal", - "value": "not.cs" - }, - { - "type": "literal", - "value": "not.cd" - }, - { - "type": "literal", - "value": "not.sl" - }, - { - "type": "literal", - "value": "not.sr" - }, - { - "type": "literal", - "value": "not.nxl" - }, - { - "type": "literal", - "value": "not.nxr" - }, - { - "type": "literal", - "value": "not.adj" - }, - { - "type": "literal", - "value": "not.ov" - }, - { - "type": "literal", - "value": "not.fts" - }, - { - "type": "literal", - "value": "not.plfts" - }, - { - "type": "literal", - "value": "not.phfts" - }, - { - "type": "literal", - "value": "not.wfts" - }, - { - "type": "literal", - "value": "not.imatch" - } - ] - } - }, - { - "id": 415, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 416, - "name": "filter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2065, - "character": 2 - } - ], - "parameters": [ - { - "id": 417, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 418, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 419, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 482, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "signatures": [ - { - "id": 483, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 653, - "name": "PostgrestTransformBuilder.geojson" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 652, - "name": "PostgrestTransformBuilder.geojson" - } - }, - { - "id": 183, - "name": "gt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1784, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1785, - "character": 2 - } - ], - "signatures": [ - { - "id": 184, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1784, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 185, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 186, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 185, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 187, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 185, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 188, - "name": "gt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1785, - "character": 2 - } - ], - "parameters": [ - { - "id": 189, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 190, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 191, - "name": "gte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1786, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1787, - "character": 2 - } - ], - "signatures": [ - { - "id": 192, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1786, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 193, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 194, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 193, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 195, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 193, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 196, - "name": "gte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1787, - "character": 2 - } - ], - "parameters": [ - { - "id": 197, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 198, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 239, - "name": "ilike", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1798, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1799, - "character": 2 - } - ], - "signatures": [ - { - "id": 240, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1798, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 241, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 242, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 241, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 243, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 244, - "name": "ilike", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1799, - "character": 2 - } - ], - "parameters": [ - { - "id": 245, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 246, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 247, - "name": "ilikeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1800, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1801, - "character": 2 - } - ], - "signatures": [ - { - "id": 248, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1800, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 249, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 250, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 249, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 251, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 252, - "name": "ilikeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1801, - "character": 2 - } - ], - "parameters": [ - { - "id": 253, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 254, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 255, - "name": "ilikeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1802, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1803, - "character": 2 - } - ], - "signatures": [ - { - "id": 256, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1802, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 257, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 258, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 257, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 259, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 260, - "name": "ilikeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1803, - "character": 2 - } - ], - "parameters": [ - { - "id": 261, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 262, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 292, - "name": "in", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1869, - "character": 2 - } - ], - "signatures": [ - { - "id": 293, - "name": "in", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .in('name', ['Leia', 'Han'])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1869, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 294, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 295, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 296, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 294, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 279, - "name": "is", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1808, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1809, - "character": 2 - } - ], - "signatures": [ - { - "id": 280, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1808, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 281, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 282, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 281, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 283, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 281, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 284, - "name": "is", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1809, - "character": 2 - } - ], - "parameters": [ - { - "id": 285, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 286, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 287, - "name": "isDistinct", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1820, - "character": 2 - } - ], - "signatures": [ - { - "id": 288, - "name": "isDistinct", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " IS DISTINCT FROM " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nUnlike " - }, - { - "kind": "code", - "text": "`.neq()`" - }, - { - "kind": "text", - "text": ", this treats " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " as a comparable value. Two " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " values\nare considered equal (not distinct), and comparing " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": " with any non-NULL\nvalue returns true (distinct)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1820, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 289, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 290, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 291, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 289, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 215, - "name": "like", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1792, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1793, - "character": 2 - } - ], - "signatures": [ - { - "id": 216, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1792, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 217, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 218, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 217, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 219, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 220, - "name": "like", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1793, - "character": 2 - } - ], - "parameters": [ - { - "id": 221, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 222, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 223, - "name": "likeAllOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1794, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1795, - "character": 2 - } - ], - "signatures": [ - { - "id": 224, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1794, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 225, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 226, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 225, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 227, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 228, - "name": "likeAllOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1795, - "character": 2 - } - ], - "parameters": [ - { - "id": 229, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 230, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 231, - "name": "likeAnyOf", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1796, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1797, - "character": 2 - } - ], - "signatures": [ - { - "id": 232, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1796, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 233, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 234, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 233, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 235, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 236, - "name": "likeAnyOf", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1797, - "character": 2 - } - ], - "parameters": [ - { - "id": 237, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 238, - "name": "patterns", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 456, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "signatures": [ - { - "id": 457, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "parameters": [ - { - "id": 458, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 459, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 461, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1243, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 462, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1244, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [461, 462] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1242, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 627, - "name": "PostgrestTransformBuilder.limit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 626, - "name": "PostgrestTransformBuilder.limit" - } - }, - { - "id": 199, - "name": "lt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1788, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1789, - "character": 2 - } - ], - "signatures": [ - { - "id": 200, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1788, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 201, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 202, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 201, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 203, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 201, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 204, - "name": "lt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1789, - "character": 2 - } - ], - "parameters": [ - { - "id": 205, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 206, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 207, - "name": "lte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1790, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1791, - "character": 2 - } - ], - "signatures": [ - { - "id": 208, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1790, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 209, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 210, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 209, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 211, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 209, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 212, - "name": "lte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1791, - "character": 2 - } - ], - "parameters": [ - { - "id": 213, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 214, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 382, - "name": "match", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1901, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1902, - "character": 2 - } - ], - "signatures": [ - { - "id": 383, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1901, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 384, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 385, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "reference", - "target": 384, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 384, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 386, - "name": "match", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1902, - "character": 2 - } - ], - "parameters": [ - { - "id": 387, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 499, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "signatures": [ - { - "id": 500, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "parameters": [ - { - "id": 501, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 670, - "name": "PostgrestTransformBuilder.maxAffected" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 669, - "name": "PostgrestTransformBuilder.maxAffected" - } - }, - { - "id": 477, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "signatures": [ - { - "id": 478, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 479, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 479, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 648, - "name": "PostgrestTransformBuilder.maybeSingle" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 647, - "name": "PostgrestTransformBuilder.maybeSingle" - } - }, - { - "id": 178, - "name": "neq", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1783, - "character": 2 - } - ], - "signatures": [ - { - "id": 179, - "name": "neq", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is not equal to " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": ".\n\nThis filter does not include rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is " - }, - { - "kind": "code", - "text": "`NULL`" - }, - { - "kind": "text", - "text": ". To match null\nvalues, use " - }, - { - "kind": "code", - "text": "`.is(column, null)`" - }, - { - "kind": "text", - "text": " instead." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .neq('name', 'Leia')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1783, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 180, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 181, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": 180, - "typeArguments": [ - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "->" - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "." - ], - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ] - }, - "trueType": { - "type": "reference", - "target": 180, - "typeArguments": [ - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "intrinsic", - "name": "string" - }, - "extendsType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - } - }, - { - "id": 182, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter with" - } - ] - }, - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 180, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Resolved" - }, - "name": "Resolved", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 388, - "name": "not", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1903, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1904, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1905, - "character": 2 - } - ], - "signatures": [ - { - "id": 389, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1903, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 390, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 391, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 392, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "is" - } - }, - { - "id": 393, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": null - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NonNullableColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NonNullableColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NarrowResultColumn" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 390, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "NarrowResultColumn", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 394, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1904, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 395, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 396, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 395, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 397, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "FilterOperator" - }, - "name": "FilterOperator", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 398, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 395, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 399, - "name": "not", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1905, - "character": 2 - } - ], - "parameters": [ - { - "id": 400, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 401, - "name": "operator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 402, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 297, - "name": "notIn", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1876, - "character": 2 - } - ], - "signatures": [ - { - "id": 298, - "name": "notIn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows where " - }, - { - "kind": "code", - "text": "`column`" - }, - { - "kind": "text", - "text": " is NOT included in the " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " array." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1876, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 299, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 300, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The column to filter on" - } - ] - }, - "type": { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 301, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values array to filter with" - } - ] - }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "intrinsic", - "name": "never" - }, - "trueType": { - "type": "intrinsic", - "name": "unknown" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolveFilterValue" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 299, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "ResolveFilterValue", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResolvedFilterValue" - }, - "name": "ResolvedFilterValue", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 403, - "name": "or", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2057, - "character": 2 - } - ], - "signatures": [ - { - "id": 404, - "name": "or", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " - }, - { - "kind": "code", - "text": "`filters`" - }, - { - "kind": "text", - "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " - }, - { - "kind": "code", - "text": "`.or()`" - }, - { - "kind": "text", - "text": " filter across multiple tables." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using filters" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\n\n" - }, - { - "kind": "code", - "text": "```ts\n.or('id.in.(5,6,7), arraycol.cs.{\"a\",\"b\"}') // Use `()` for `in` filter, `{}` for array values and `cs` for `contains()`.\n.or('id.in.(5,6,7), arraycol.cd.{\"a\",\"b\"}') // Use `cd` for `containedBy()`\n```" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.eq.2,name.eq.Han')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n },\n {\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` with `and`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`and`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Use `or` on referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`or`" - }, - { - "kind": "text", - "text": " on referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2057, - "character": 2 - } - ], - "parameters": [ - { - "id": 405, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filters to use, following PostgREST syntax" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 406, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 407, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 408, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`referencedTable`" - }, - { - "kind": "text", - "text": " instead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2061, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 409, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to filter on referenced tables\ninstead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2062, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [408, 409] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2060, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 425, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "signatures": [ - { - "id": 426, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 427, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 428, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 427, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 429, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 430, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 431, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 432, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1115, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 433, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [431, 432, 433] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 596, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 434, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - } - ], - "parameters": [ - { - "id": 435, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 436, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 437, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 438, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1119, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 439, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 440, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1121, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [438, 439, 440] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 604, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 441, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 442, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 443, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 442, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 444, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 446, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 448, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1129, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 447, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1128, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [446, 448, 447] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 611, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 449, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "parameters": [ - { - "id": 450, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 451, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 453, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 455, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 454, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [453, 455, 454] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 619, - "name": "PostgrestTransformBuilder.order" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 595, - "name": "PostgrestTransformBuilder.order" - } - }, - { - "id": 358, - "name": "overlaps", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1891, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1892, - "character": 2 - } - ], - "signatures": [ - { - "id": 359, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1891, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 360, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 361, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 360, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 362, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 360, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - } - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 363, - "name": "overlaps", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1892, - "character": 2 - } - ], - "parameters": [ - { - "id": 364, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 365, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 544, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 545, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 546, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 547, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 548, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 549, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [549] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 550, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 551, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [551] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 715, - "name": "PostgrestTransformBuilder.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 714, - "name": "PostgrestTransformBuilder.overrideTypes" - } - }, - { - "id": 463, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "signatures": [ - { - "id": 464, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "parameters": [ - { - "id": 465, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 466, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 467, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 468, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 469, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 470, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [469, 470] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 634, - "name": "PostgrestTransformBuilder.range" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 633, - "name": "PostgrestTransformBuilder.range" - } - }, - { - "id": 350, - "name": "rangeAdjacent", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1889, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1890, - "character": 2 - } - ], - "signatures": [ - { - "id": 351, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1889, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 352, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 353, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 352, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 354, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 355, - "name": "rangeAdjacent", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1890, - "character": 2 - } - ], - "parameters": [ - { - "id": 356, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 357, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 318, - "name": "rangeGt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1881, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1882, - "character": 2 - } - ], - "signatures": [ - { - "id": 319, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1881, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 320, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 321, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 320, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 322, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 323, - "name": "rangeGt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1882, - "character": 2 - } - ], - "parameters": [ - { - "id": 324, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 325, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 326, - "name": "rangeGte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1883, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1884, - "character": 2 - } - ], - "signatures": [ - { - "id": 327, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1883, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 328, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 329, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 328, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 330, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 331, - "name": "rangeGte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1884, - "character": 2 - } - ], - "parameters": [ - { - "id": 332, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 333, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 334, - "name": "rangeLt", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1885, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1886, - "character": 2 - } - ], - "signatures": [ - { - "id": 335, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1885, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 336, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 337, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 336, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 338, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 339, - "name": "rangeLt", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1886, - "character": 2 - } - ], - "parameters": [ - { - "id": 340, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 341, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 342, - "name": "rangeLte", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1887, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1888, - "character": 2 - } - ], - "signatures": [ - { - "id": 343, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1887, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 344, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 345, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 344, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 346, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 347, - "name": "rangeLte", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1888, - "character": 2 - } - ], - "parameters": [ - { - "id": 348, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 349, - "name": "range", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 271, - "name": "regexIMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1806, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1807, - "character": 2 - } - ], - "signatures": [ - { - "id": 272, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1806, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 273, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 274, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 273, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 275, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 276, - "name": "regexIMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1807, - "character": 2 - } - ], - "parameters": [ - { - "id": 277, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 278, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 263, - "name": "regexMatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1804, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1805, - "character": 2 - } - ], - "signatures": [ - { - "id": 264, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1804, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 265, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 266, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 265, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 267, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 268, - "name": "regexMatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1805, - "character": 2 - } - ], - "parameters": [ - { - "id": 269, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 270, - "name": "pattern", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 529, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 530, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 531, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 700, - "name": "PostgrestTransformBuilder.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 699, - "name": "PostgrestTransformBuilder.retry" - } - }, - { - "id": 496, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "signatures": [ - { - "id": 497, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 498, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 498, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 667, - "name": "PostgrestTransformBuilder.returns" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 666, - "name": "PostgrestTransformBuilder.returns" - } - }, - { - "id": 494, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "signatures": [ - { - "id": 495, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 665, - "name": "PostgrestTransformBuilder.rollback" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 664, - "name": "PostgrestTransformBuilder.rollback" - } - }, - { - "id": 420, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "signatures": [ - { - "id": 421, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 422, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 423, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 424, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 591, - "name": "PostgrestTransformBuilder.select" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 590, - "name": "PostgrestTransformBuilder.select" - } - }, - { - "id": 525, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 526, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 527, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 528, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 696, - "name": "PostgrestTransformBuilder.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 695, - "name": "PostgrestTransformBuilder.setHeader" - } - }, - { - "id": 474, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "signatures": [ - { - "id": 475, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 476, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 476, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 645, - "name": "PostgrestTransformBuilder.single" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 644, - "name": "PostgrestTransformBuilder.single" - } - }, - { - "id": 523, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 524, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 694, - "name": "PostgrestTransformBuilder.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 693, - "name": "PostgrestTransformBuilder.stripNulls" - } - }, - { - "id": 366, - "name": "textSearch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 2 - } - ], - "signatures": [ - { - "id": 367, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 368, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 369, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 368, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 370, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 371, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 372, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 373, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1894, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 374, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1895, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [373, 374] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1893, - "character": 97 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 375, - "name": "textSearch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 2 - } - ], - "parameters": [ - { - "id": 376, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 377, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 378, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 380, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1898, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 381, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1899, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "plain" - }, - { - "type": "literal", - "value": "phrase" - }, - { - "type": "literal", - "value": "websearch" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [380, 381] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1897, - "character": 54 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 532, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 533, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 534, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 535, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 536, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 537, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 538, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 539, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 540, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 541, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 542, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 543, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 703, - "name": "PostgrestTransformBuilder.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 702, - "name": "PostgrestTransformBuilder.then" - } - }, - { - "id": 521, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 522, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 692, - "name": "PostgrestTransformBuilder.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 691, - "name": "PostgrestTransformBuilder.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [142] - }, - { - "title": "Properties", - "children": [506, 509, 504, 517, 502, 520, 505, 518, 507, 508, 503, 519] - }, - { - "title": "Methods", - "children": [ - 471, 310, 302, 480, 172, 484, 410, 482, 183, 191, 239, 247, 255, 292, 279, 287, 215, - 223, 231, 456, 199, 207, 382, 499, 477, 178, 388, 297, 403, 425, 358, 544, 463, 350, - 318, 326, 334, 342, 271, 263, 529, 496, 494, 420, 525, 474, 523, 366, 532, 521 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 142, 471, 480, 172, 484, 482, 292, 456, 499, 477, 178, 403, 544, 463, 496, 494, 420, - 525, 474, 523, 521 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [529] - }, - { - "title": "Other", - "children": [ - 506, 509, 504, 517, 502, 520, 505, 518, 507, 508, 503, 519, 310, 302, 410, 183, 191, - 239, 247, 255, 279, 287, 215, 223, 231, 199, 207, 382, 388, 297, 425, 358, 350, 318, - 326, 334, 342, 271, 263, 366, 532 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1684, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 552, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 553, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 554, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 555, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 556, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 557, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 558, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 144, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 145, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 146, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 147, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 148, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 149, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 150, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestFilterBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - { - "id": 729, - "name": "PostgrestQueryBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 730, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2116, - "character": 2 - } - ], - "signatures": [ - { - "id": 731, - "name": "PostgrestQueryBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a query builder scoped to a Postgres table or view." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst query = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: { apikey: 'your-publishable-key' }, retry: true }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2116, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 732, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 733, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 734, - "name": "Relation$1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 735, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 736, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 737, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 738, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2070, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [738] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 216 - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "parameters": [ - { - "id": 739, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL for the query" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 740, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 741, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 744, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom fetch implementation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2125, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 747, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 748, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 749, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 750, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 751, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 742, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom headers" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2123, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 753, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable automatic retries for transient errors (default: true)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 743, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postgres schema to use" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2124, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 752, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length before warning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2126, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [744, 742, 753, 743, 752] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2122, - "character": 5 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 758, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2076, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 759, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 760, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 761, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 762, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 763, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 764, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 765, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 755, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2073, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - } - }, - { - "id": 767, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable or disable automatic retries for transient errors.\nWhen enabled, idempotent requests (GET/HEAD/OPTIONS) that fail with network\nerrors or HTTP 503/520 responses are automatically retried with exponential\nbackoff (1s, 2s, 4s, up to 3 attempts). Defaults to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " when not specified." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2084, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 756, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2074, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 757, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2075, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 754, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2072, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 766, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2077, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 817, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3594, - "character": 2 - } - ], - "signatures": [ - { - "id": 818, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\n- If you use " - }, - { - "kind": "code", - "text": "`delete()`" - }, - { - "kind": "text", - "text": " with filters and you have\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\n rows visible through " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": " policies are deleted. Note that by default\n no rows are visible, so you need at least one " - }, - { - "kind": "code", - "text": "`SELECT`" - }, - { - "kind": "text", - "text": "/" - }, - { - "kind": "code", - "text": "`ALL`" - }, - { - "kind": "text", - "text": " policy that\n makes the rows visible.\n- When using " - }, - { - "kind": "code", - "text": "`delete().in()`" - }, - { - "kind": "text", - "text": ", specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal." - } - ] - }, - { - "tag": "@example", - "name": "Delete a single record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a single record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').delete().eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Delete multiple records", - "content": [ - { - "kind": "code", - "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .in('id', [1, 2, 3])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete multiple records\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3594, - "character": 2 - } - ], - "parameters": [ - { - "id": 819, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 820, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 821, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count deleted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3597, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 822, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [821] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3596, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 779, - "name": "insert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3063, - "character": 2 - } - ], - "signatures": [ - { - "id": 780, - "name": "insert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Create a record", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Bulk create\nA bulk create operation is handled in a single transaction.\nIf any of the inserts fail, none of the rows are inserted." - } - ] - }, - { - "tag": "@example", - "name": "Bulk create", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert([\n { id: 1, name: 'Mordor' },\n { id: 1, name: 'The Shire' },\n ])\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk create\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (id)=(1) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"countries_pkey\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3063, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 781, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 782, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 783, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 784, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3066, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [784] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3065, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 781, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 785, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 786, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3068, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [786] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3067, - "character": 85 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 781, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 787, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 788, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 789, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count inserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3073, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 791, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3074, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [789, 791] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3072, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 769, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 2 - } - ], - "signatures": [ - { - "id": 770, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT query on the table or view." - } - ], - "blockTags": [ - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "When using " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " with " - }, - { - "kind": "code", - "text": "`.range()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`.limit()`" - }, - { - "kind": "text", - "text": ", the returned " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " is the total number of rows\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\n\n- By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use " - }, - { - "kind": "code", - "text": "`range()`" - }, - { - "kind": "text", - "text": " queries to paginate through your data.\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Filters](/docs/reference/javascript/using-filters)\n- " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\n- " - }, - { - "kind": "code", - "text": "`apikey`" - }, - { - "kind": "text", - "text": " is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Getting your data", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Harry'),\n (2, 'Frodo'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Getting your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Harry\"\n },\n {\n \"id\": 2,\n \"name\": \"Frodo\"\n },\n {\n \"id\": 3,\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\nThe most useful field on a Postgres error is usually " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (" - }, - { - "kind": "code", - "text": "`code: '42501'`" - }, - { - "kind": "text", - "text": ") arrives with a " - }, - { - "kind": "code", - "text": "`hint`" - }, - { - "kind": "text", - "text": " like " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\"`" - }, - { - "kind": "text", - "text": ". Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so the hint isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('characters').select()\nif (error) {\n // Logs the full error: message, code, details, and hint.\n console.error(error)\n return\n}\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"42501\",\n \"details\": null,\n \"hint\": \"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;\",\n \"message\": \"permission denied for table characters\"\n },\n \"status\": 401,\n \"statusText\": \"Unauthorized\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Selecting specific columns", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Frodo'),\n (2, 'Harry'),\n (3, 'Katniss');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Selecting specific columns\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Frodo\"\n },\n {\n \"name\": \"Harry\"\n },\n {\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\nIf your database has foreign key relationships, you can query related tables too." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\nIf your table name contains spaces, you must use double quotes in the " - }, - { - "kind": "code", - "text": "`select`" - }, - { - "kind": "text", - "text": " statement to reference the table." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables with spaces in their names", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase\n .from('orchestral sections')\n .select(`\n name,\n \"musical instruments\" (\n name\n )\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n \"orchestral sections\" (id int8 primary key, name text);\ncreate table\n \"musical instruments\" (\n id int8 primary key,\n section_id int8 not null references \"orchestral sections\",\n name text\n );\n\ninsert into\n \"orchestral sections\" (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n \"musical instruments\" (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables with spaces in their names\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"musical instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"musical instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\nIf you're in a situation where your tables are **NOT** directly\nrelated, but instead are joined by a _join table_, you can still use\nthe " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": " method to query the related data. The join table needs\nto have the foreign keys as part of its composite primary key." - } - ] - }, - { - "tag": "@example", - "name": "Query referenced tables through a join table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n name,\n teams (\n name\n )\n `)\n\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n -- both foreign keys must be part of a composite primary key\n primary key (user_id, team_id)\n );\n\ninsert into\n users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query referenced tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Kiran\",\n \"teams\": [\n {\n \"name\": \"Green\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Evan\",\n \"teams\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\nIf you need to query the same referenced table twice, use the name of the\njoined column to identify which join to use. You can also give each\ncolumn an alias." - } - ] - }, - { - "tag": "@example", - "name": "Query the same referenced table multiple times", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:sender_id(name),\n to:receiver_id(name)\n `)\n\n// To infer types, use the name of the table (in this case `users`) and\n// the name of the foreign key constraint.\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:users!messages_sender_id_fkey(name),\n to:users!messages_receiver_id_fkey(name)\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Query the same referenced table multiple times\n" - }, - { - "kind": "code", - "text": "```sql\n create table\n users (id int8 primary key, name text);\n\n create table\n messages (\n sender_id int8 not null references users,\n receiver_id int8 not null references users,\n content text\n );\n\n insert into\n users (id, name)\n values\n (1, 'Kiran'),\n (2, 'Evan');\n\n insert into\n messages (sender_id, receiver_id, content)\n values\n (1, 2, '👋');\n ```" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleResponse Query the same referenced table multiple times\n```" - }, - { - "kind": "text", - "text": "json\n{\n \"data\": [\n {\n \"content\": \"👋\",\n \"from\": {\n \"name\": \"Kiran\"\n },\n \"to\": {\n \"name\": \"Evan\"\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleDescription Query nested foreign tables through a join table\nYou can use the result of a joined table to gather data in\nanother foreign table. With multiple references to the same foreign\ntable you must specify the column on which to conduct the join.\n\n@example Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "ts\n const { data, error } = await supabase\n .from('games')\n .select(" - }, - { - "kind": "code", - "text": "`\n game_id:id,\n away_team:teams!games_away_team_fkey (\n users (\n id,\n name\n )\n )\n `" - }, - { - "kind": "text", - "text": ")\n\n" - }, - { - "kind": "code", - "text": "```\n\n@exampleSql Query nested foreign tables through a join table\n```" - }, - { - "kind": "text", - "text": "sql\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n\n primary key (user_id, team_id)\n );\ncreate table\n games (\n id int8 primary key,\n home_team int8 not null references teams,\n away_team int8 not null references teams,\n name text\n );\n\ninsert into users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\ninsert into\n games (id, home_team, away_team, name)\nvalues\n (1, 1, 2, 'Green vs Blue'),\n (2, 2, 1, 'Blue vs Green');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Query nested foreign tables through a join table\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"data\": [\n {\n \"game_id\": 1,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n },\n {\n \"id\": 2,\n \"name\": \"Evan\"\n }\n ]\n }\n },\n {\n \"game_id\": 2,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n }\n ]\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\nIf the filter on a referenced table's column is not satisfied, the referenced\ntable returns " - }, - { - "kind": "code", - "text": "`[]`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " but the parent table is not filtered out.\nIf you want to filter out the parent table rows, use the " - }, - { - "kind": "code", - "text": "`!inner`" - }, - { - "kind": "text", - "text": " hint" - } - ] - }, - { - "tag": "@example", - "name": "Filtering through referenced tables", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections(*)')\n .eq('orchestral_sections.name', 'percussion')\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Filtering through referenced tables\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": null\n },\n {\n \"name\": \"violin\",\n \"orchestral_sections\": null\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\nYou can get the number of rows in a related table by using the\n**count** property." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with count", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`*, instruments(count)`)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table characters (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('strings') returning id\n)\ninsert into instruments (name, section_id) values\n('violin', (select id from section)),\n('viola', (select id from section)),\n('cello', (select id from section)),\n('double bass', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with count\n" - }, - { - "kind": "code", - "text": "```json\n[\n {\n \"id\": \"693694e7-d993-4360-a6d7-6294e325d9b6\",\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"count\": 4\n }\n ]\n }\n]\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying with count option\nYou can get the number of rows by using the\n[count](/docs/reference/javascript/select#parameters) option." - } - ] - }, - { - "tag": "@example", - "name": "Querying with count option", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { count, error } = await supabase\n .from('characters')\n .select('*', { count: 'exact', head: true })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying with count option\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"count\": 3,\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\nYou can select and filter data inside of\n[JSON](/docs/guides/database/json) columns. Postgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nquerying JSON data." - } - ] - }, - { - "tag": "@example", - "name": "Querying JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n id, name,\n address->city\n `)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Frodo', '{\"city\":\"Hobbiton\"}');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Frodo\",\n \"city\": \"Hobbiton\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\nIf you don't want to return the referenced table contents, you can leave the parenthesis empty.\nLike " - }, - { - "kind": "code", - "text": "`.select('name, orchestral_sections!inner()')`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Querying referenced table with inner join", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections!inner(name)')\n .eq('orchestral_sections.name', 'woodwinds')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table instruments (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('woodwinds') returning id\n)\ninsert into instruments (name, section_id) values\n('flute', (select id from section)),\n('clarinet', (select id from section)),\n('bassoon', (select id from section)),\n('piccolo', (select id from section));\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Querying referenced table with inner join\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\nIn addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas)." - } - ] - }, - { - "tag": "@example", - "name": "Switching schemas per query", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .schema('myschema')\n .from('mytable')\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```sql\ncreate schema myschema;\n\ncreate table myschema.mytable (\n id uuid primary key default gen_random_uuid(),\n data text\n);\n\ninsert into myschema.mytable (data) values ('mydata');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Switching schemas per query\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": \"4162e008-27b0-4c0f-82dc-ccaeee9a624d\",\n \"data\": \"mydata\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 771, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 772, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 771, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 773, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " - }, - { - "kind": "code", - "text": "`customName:columnName`" - } - ] - }, - "type": { - "type": "reference", - "target": 771, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 774, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 777, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows in the table or view.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2941, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 778, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 776, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2940, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [777, 776] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2939, - "character": 165 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 772, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "GET" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 807, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3458, - "character": 2 - } - ], - "signatures": [ - { - "id": 808, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": " after filters." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- " - }, - { - "kind": "code", - "text": "`update()`" - }, - { - "kind": "text", - "text": " should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update." - } - ] - }, - { - "tag": "@example", - "name": "Updating your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Update a record and return it", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Update a record and return it\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\nPostgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nworking with JSON data. Currently, it is only possible to update the entire JSON document." - } - ] - }, - { - "tag": "@example", - "name": "Updating JSON data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .update({\n address: {\n street: 'Melrose Place',\n postcode: 90210\n }\n })\n .eq('address->postcode', 90210)\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210 }');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Updating JSON data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Michael\",\n \"address\": {\n \"street\": \"Melrose Place\",\n \"postcode\": 90210\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3458, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 809, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 810, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to update with" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 811, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 812, - "name": "Update", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3461, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [812] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3460, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Update" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 809, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 813, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 814, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 815, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count updated rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3465, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [815] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3464, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "PATCH" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 792, - "name": "upsert", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3293, - "character": 2 - } - ], - "signatures": [ - { - "id": 793, - "name": "upsert", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": " allows you to perform the equivalent of\n" - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": " if a row with the corresponding " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates`" - }, - { - "kind": "text", - "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " - }, - { - "kind": "code", - "text": "`.select()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Upsert a single row using a unique key", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting a single row, overwriting based on the 'username' unique column\nconst { data, error } = await supabase\n .from('users')\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\n\n// Example response:\n// {\n// data: [\n// { id: 4, message: 'bar', username: 'supabot' }\n// ],\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@example", - "name": "Upsert with conflict resolution and exact row counting", - "content": [ - { - "kind": "code", - "text": "```ts\n// Upserting and returning exact count\nconst { data, error, count } = await supabase\n .from('users')\n .upsert(\n {\n id: 3,\n message: 'foo',\n username: 'supabot'\n },\n {\n onConflict: 'username',\n count: 'exact'\n }\n )\n\n// Example response:\n// {\n// data: [\n// {\n// id: 42,\n// handle: \"saoirse\",\n// display_name: \"Saoirse\"\n// }\n// ],\n// count: 1,\n// error: null\n// }\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Primary keys must be included in " - }, - { - "kind": "code", - "text": "`values`" - }, - { - "kind": "text", - "text": " to use upsert." - } - ] - }, - { - "tag": "@example", - "name": "Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert({ id: 1, name: 'piano' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Handling errors\n" - }, - { - "kind": "code", - "text": "`error.hint`" - }, - { - "kind": "text", - "text": " from Postgres often contains the actionable fix (e.g. " - }, - { - "kind": "code", - "text": "`\"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;\"`" - }, - { - "kind": "text", - "text": " for a " - }, - { - "kind": "code", - "text": "`42501`" - }, - { - "kind": "text", - "text": " permission-denied error). Log the full " - }, - { - "kind": "code", - "text": "`error`" - }, - { - "kind": "text", - "text": " object so it isn't hidden behind " - }, - { - "kind": "code", - "text": "`error.message`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()\nif (error) console.error(error)\n```" - } - ] - }, - { - "tag": "@example", - "name": "Bulk Upsert your data", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert([\n { id: 1, name: 'piano' },\n { id: 2, name: 'harp' },\n ])\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Bulk Upsert your data\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n },\n {\n \"id\": 2,\n \"name\": \"harp\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\nIn the following query, " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " implicitly uses the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": "\n(primary key) column to determine conflicts. If there is no existing\nrow with the same " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " inserts a new row, which\nwill fail in this case as there is already a row with " - }, - { - "kind": "code", - "text": "`handle`" - }, - { - "kind": "text", - "text": " " - }, - { - "kind": "code", - "text": "`\"saoirse\"`" - }, - { - "kind": "text", - "text": ".\nUsing the " - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " option, you can instruct " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": " to use\nanother column with a unique constraint to determine conflicts." - } - ] - }, - { - "tag": "@example", - "name": "Upserting into tables with constraints", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n users (\n id int8 generated by default as identity primary key,\n handle text not null unique,\n display_name text\n );\n\ninsert into\n users (id, handle, display_name)\nvalues\n (1, 'saoirse', null);\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Upserting into tables with constraints\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (handle)=(saoirse) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"users_handle_key\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3293, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 794, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 795, - "name": "values", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 796, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 797, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3296, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [797] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3295, - "character": 87 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 794, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "RejectExcessProperties" - }, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 798, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 799, - "name": "Insert", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3298, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [799] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3297, - "character": 85 - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Insert" - }, - "objectType": { - "type": "reference", - "target": 734, - "typeArguments": [ - { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - ], - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - { - "type": "reference", - "target": 794, - "name": "Row", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "RejectExcessProperties", - "package": "@supabase/postgrest-js" - } - } - ] - } - }, - { - "id": 800, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 801, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 804, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count upserted rows.\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3307, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 805, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 806, - "name": "defaultToNull", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make missing fields default to " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" - }, - { - "kind": "code", - "text": "`ignoreDuplicates: false`" - }, - { - "kind": "text", - "text": ". This also only applies when doing bulk upserts." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3308, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 803, - "name": "ignoreDuplicates", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", duplicate rows are ignored. If\n" - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", duplicate rows are merged with existing rows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 802, - "name": "onConflict", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" - }, - { - "kind": "code", - "text": "`onConflict`" - }, - { - "kind": "text", - "text": " columns are equal." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [804, 806, 803, 802] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 3304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 732, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 733, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 735, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 736, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "POST" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [730] - }, - { - "title": "Properties", - "children": [758, 755, 767, 756, 757, 754, 766] - }, - { - "title": "Methods", - "children": [817, 779, 769, 807, 792] - } - ], - "categories": [ - { - "title": "Database", - "children": [730, 817, 779, 769, 807, 792] - }, - { - "title": "Other", - "children": [758, 755, 767, 756, 757, 754, 766] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 823, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 824, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 825, - "name": "Relation$1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 826, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 827, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 734, - "name": "Relation$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestQueryBuilder.Relation$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 828, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 829, - "name": "Relationships", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2070, - "character": 2 - } - ], - "type": { - "type": "inferred", - "name": "R" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [829] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 2069, - "character": 216 - } - ] - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "R" - }, - "name": "R", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ] - }, - { - "id": 559, - "name": "PostgrestTransformBuilder", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 560, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "signatures": [ - { - "id": 561, - "name": "PostgrestTransformBuilder", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a builder configured for a specific PostgREST request." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'your-publishable-key' }) }\n)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 562, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 563, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 564, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 565, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 566, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 567, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 568, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 569, - "name": "builder", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 570, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 575, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 715, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 578, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 718, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 579, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 580, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 581, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 582, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 583, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 584, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 585, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 573, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "HeadersInit" - }, - "name": "HeadersInit", - "package": "typescript" - } - }, - { - "id": 586, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 719, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 571, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 711, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - { - "id": 589, - "name": "retry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 574, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 587, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 576, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 716, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 577, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 717, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 572, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 712, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 588, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 721, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 575, 578, 573, 586, 571, 589, 574, 587, 576, 577, 572, 588 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 710, - "character": 23 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 59, - "name": "PostgrestBuilder.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 58, - "name": "PostgrestBuilder.constructor" - } - }, - { - "id": 676, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 679, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": 88, - "name": "PostgrestBuilder.body" - } - }, - { - "id": 679, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 682, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 680, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 681, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 682, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 683, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 684, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 685, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 686, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 91, - "name": "PostgrestBuilder.fetch" - } - }, - { - "id": 674, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 677, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Headers" - }, - "name": "Headers", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 86, - "name": "PostgrestBuilder.headers" - } - }, - { - "id": 687, - "name": "isMaybeSingle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 683, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 99, - "name": "PostgrestBuilder.isMaybeSingle" - } - }, - { - "id": 672, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 675, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 84, - "name": "PostgrestBuilder.method" - } - }, - { - "id": 690, - "name": "retryEnabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 686, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 102, - "name": "PostgrestBuilder.retryEnabled" - } - }, - { - "id": 675, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 678, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 87, - "name": "PostgrestBuilder.schema" - } - }, - { - "id": 688, - "name": "shouldStripNulls", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 684, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 100, - "name": "PostgrestBuilder.shouldStripNulls" - } - }, - { - "id": 677, - "name": "shouldThrowOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 680, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 89, - "name": "PostgrestBuilder.shouldThrowOnError" - } - }, - { - "id": 678, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 681, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 90, - "name": "PostgrestBuilder.signal" - } - }, - { - "id": 673, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 676, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 85, - "name": "PostgrestBuilder.url" - } - }, - { - "id": 689, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 685, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 101, - "name": "PostgrestBuilder.urlLengthLimit" - } - }, - { - "id": 641, - "name": "abortSignal", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "signatures": [ - { - "id": 642, - "name": "abortSignal", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the AbortSignal for the fetch request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "You can use this to set a timeout for the request." - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\nYou can use an [" - }, - { - "kind": "code", - "text": "`AbortController`" - }, - { - "kind": "text", - "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`statusText`" - }, - { - "kind": "text", - "text": " don't mean anything for aborted requests as the request wasn't fulfilled." - } - ] - }, - { - "tag": "@example", - "name": "Aborting requests in-flight", - "content": [ - { - "kind": "code", - "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Aborting requests in-flight\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" - } - ] - }, - { - "tag": "@example", - "name": "Set a timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Set a timeout\n" - }, - { - "kind": "code", - "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1374, - "character": 2 - } - ], - "parameters": [ - { - "id": 643, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the fetch request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 650, - "name": "csv", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "signatures": [ - { - "id": 651, - "name": "csv", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a string in CSV format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." - } - ] - }, - { - "tag": "@example", - "name": "Return data as CSV", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Return data as CSV\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1497, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 654, - "name": "explain", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "signatures": [ - { - "id": 655, - "name": "explain", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " - }, - { - "kind": "code", - "text": "`format`" - }, - { - "kind": "text", - "text": " parameter." - } - ] - }, - { - "tag": "@example", - "name": "Get the execution plan with analyze and verbose", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the execution plan with analyze and verbose\n" - }, - { - "kind": "code", - "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1600, - "character": 2 - } - ], - "parameters": [ - { - "id": 656, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 657, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 658, - "name": "analyze", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query will be executed and the\nactual run time will be returned" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1608, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 661, - "name": "buffers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on buffer usage" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1611, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 663, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The format of the output, can be " - }, - { - "kind": "code", - "text": "`\"text\"`" - }, - { - "kind": "text", - "text": " (default)\nor " - }, - { - "kind": "code", - "text": "`\"json\"`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1613, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "text" - }, - { - "type": "literal", - "value": "json" - } - ] - } - }, - { - "id": 660, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on configuration\nparameters that affect query planning" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1610, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 659, - "name": "verbose", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the query identifier will be returned\nand " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will include the output columns of the query" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1609, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 662, - "name": "wal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", include information on WAL record generation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1612, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [658, 661, 663, 660, 659, 662] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1607, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - } - } - ] - }, - { - "id": 652, - "name": "geojson", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "signatures": [ - { - "id": 653, - "name": "geojson", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as an object in [GeoJSON](https://geojson.org) format." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1503, - "character": 2 - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 626, - "name": "limit", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "signatures": [ - { - "id": 627, - "name": "limit", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "On a referenced table", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "On a referenced table\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1239, - "character": 2 - } - ], - "parameters": [ - { - "id": 628, - "name": "count", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows to return" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 629, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 631, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1243, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 632, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1244, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [631, 632] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1242, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 669, - "name": "maxAffected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "signatures": [ - { - "id": 670, - "name": "maxAffected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1671, - "character": 2 - } - ], - "parameters": [ - { - "id": 671, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of rows that can be affected" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MaxAffectedEnabled" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "PostgrestVersion" - }, - "objectType": { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - } - } - ], - "name": "MaxAffectedEnabled", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "RPC" - } - ] - }, - "trueType": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on update or delete" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "InvalidMethodError" - }, - "typeArguments": [ - { - "type": "literal", - "value": "maxAffected method only available on postgrest 13+" - } - ], - "name": "InvalidMethodError", - "package": "@supabase/postgrest-js" - } - } - } - ] - }, - { - "id": 647, - "name": "maybeSingle", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "signatures": [ - { - "id": 648, - "name": "maybeSingle", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise\nthis returns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1457, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 649, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 479, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 595, - "name": "order", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - }, - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "signatures": [ - { - "id": 596, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 597, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 598, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 427, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 599, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 600, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 601, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 602, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1115, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 603, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [601, 602, 603] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1113, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 604, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 2 - } - ], - "parameters": [ - { - "id": 605, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 606, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 607, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 608, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1119, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 609, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 610, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1121, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [608, 609, 610] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1118, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 611, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 612, - "name": "ColumnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 613, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 442, - "name": "ColumnName", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - { - "id": 614, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 615, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 616, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1127, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 618, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1129, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 617, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1128, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [616, 618, 617] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1126, - "character": 77 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - }, - { - "id": 619, - "name": "order", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": " instead of " - }, - { - "kind": "code", - "text": "`options.foreignTable`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 2 - } - ], - "parameters": [ - { - "id": 620, - "name": "column", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 621, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 623, - "name": "ascending", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 625, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 624, - "name": "nullsFirst", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [623, 625, 624] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1134, - "character": 34 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 714, - "name": "overrideTypes", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "signatures": [ - { - "id": 715, - "name": "overrideTypes", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field in the response." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A PostgrestBuilder instance with the new type" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Complete Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Complete Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // MyType | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of successful response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // Array\n```" - } - ] - }, - { - "tag": "@example", - "name": "Partial Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Partial Override type of object response\n" - }, - { - "kind": "code", - "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" - } - ] - }, - { - "tag": "@example", - "name": "Merge vs replace existing types", - "content": [ - { - "kind": "code", - "text": "```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```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 716, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new type to cast the response data to" - } - ] - } - }, - { - "id": 717, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional type configuration (defaults to { merge: true })" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 718, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 719, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 920, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [719] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 919, - "character": 43 - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 720, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 721, - "name": "merge", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 922, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [721] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 921, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "IsValidResultOverride" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": false - }, - { - "type": "literal", - "value": false - } - ], - "name": "IsValidResultOverride", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ContainsNull" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "ContainsNull", - "package": "@supabase/postgrest-js" - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "NonNullable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "NonNullable", - "package": "typescript" - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - ] - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "MergePartialResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 133, - "name": "Options", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "MergePartialResult", - "package": "@supabase/postgrest-js" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 132, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - } - }, - { - "type": "literal", - "value": false - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - }, - "inheritedFrom": { - "type": "reference", - "target": 131, - "name": "PostgrestBuilder.overrideTypes" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 130, - "name": "PostgrestBuilder.overrideTypes" - } - }, - { - "id": 633, - "name": "range", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "signatures": [ - { - "id": 634, - "name": "range", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the query result by starting at an offset " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and ending at the offset " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": ".\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 " - }, - { - "kind": "code", - "text": "`from`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " values are 0-based and inclusive: " - }, - { - "kind": "code", - "text": "`range(1, 3)`" - }, - { - "kind": "text", - "text": " will include the second, third\nand fourth rows of the query." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1301, - "character": 2 - } - ], - "parameters": [ - { - "id": 635, - "name": "from", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting index from which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 636, - "name": "to", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last index to which to limit the result" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 637, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 638, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 639, - "name": "foreignTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deprecated, use " - }, - { - "kind": "code", - "text": "`options.referencedTable`" - }, - { - "kind": "text", - "text": "\ninstead" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1305, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 640, - "name": "referencedTable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this to limit rows of referenced\ntables instead of the parent table" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1306, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [639, 640] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1304, - "character": 6 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 699, - "name": "retry", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "signatures": [ - { - "id": 700, - "name": "retry", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 810, - "character": 2 - } - ], - "parameters": [ - { - "id": 701, - "name": "enabled", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to enable retries for this request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 112, - "name": "PostgrestBuilder.retry" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 111, - "name": "PostgrestBuilder.retry" - } - }, - { - "id": 666, - "name": "returns", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "signatures": [ - { - "id": 667, - "name": "returns", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the type of the returned " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use overrideTypes() method at the end of your call chain instead" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Deprecated: use overrideTypes method instead" - } - ] - }, - { - "tag": "@example", - "name": "Override type of successful response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of successful response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType[]\n```" - } - ] - }, - { - "tag": "@example", - "name": "Override type of object response", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Override type of object response\n" - }, - { - "kind": "code", - "text": "```js\nlet x: typeof data // MyType | null\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1662, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 668, - "name": "NewResult", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new result type to override with" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "CheckMatchingArrayTypes" - }, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 498, - "name": "NewResult", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "CheckMatchingArrayTypes", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - "overwrites": { - "type": "reference", - "target": 128, - "name": "PostgrestBuilder.returns" - } - } - ], - "overwrites": { - "type": "reference", - "target": 127, - "name": "PostgrestBuilder.returns" - } - }, - { - "id": 664, - "name": "rollback", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "signatures": [ - { - "id": 665, - "name": "rollback", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Rollback the query.\n\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will still be returned, but the query is not committed." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1622, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 590, - "name": "select", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "signatures": [ - { - "id": 591, - "name": "select", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a SELECT on the query result.\n\nBy default, " - }, - { - "kind": "code", - "text": "`.insert()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.update()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`.upsert()`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`.delete()`" - }, - { - "kind": "text", - "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `upsert()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`upsert()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1112, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 592, - "name": "Query", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "literal", - "value": "*" - } - }, - { - "id": 593, - "name": "NewResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GetResult" - }, - "typeArguments": [ - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "GetResult", - "package": "@supabase/postgrest-js" - } - } - ], - "parameters": [ - { - "id": 594, - "name": "columns", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The columns to retrieve, separated by commas" - } - ] - }, - "type": { - "type": "reference", - "target": 422, - "name": "Query", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "literal", - "value": "RPC" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - "trueType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 423, - "name": "NewResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 695, - "name": "setHeader", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "signatures": [ - { - "id": 696, - "name": "setHeader", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set an HTTP header for the request." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 789, - "character": 2 - } - ], - "parameters": [ - { - "id": 697, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 698, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 108, - "name": "PostgrestBuilder.setHeader" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 107, - "name": "PostgrestBuilder.setHeader" - } - }, - { - "id": 644, - "name": "single", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "signatures": [ - { - "id": 645, - "name": "single", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " - }, - { - "kind": "code", - "text": "`.limit(1)`" - }, - { - "kind": "text", - "text": "), otherwise this\nreturns an error." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1417, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 646, - "name": "ResultOne", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - ], - "type": { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 476, - "name": "ResultOne", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 693, - "name": "stripNulls", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "signatures": [ - { - "id": 694, - "name": "stripNulls", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strip null values from the response data. Properties with " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls", - "target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Using modifiers" - } - ] - }, - { - "tag": "@example", - "name": "With `select()`", - "content": [ - { - "kind": "code", - "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\n```" - } - ] - }, - { - "tag": "@exampleSql", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```sql\ncreate table\n characters (id int8 primary key, name text, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "With " - }, - { - "kind": "code", - "text": "`select()`" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "code", - "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\",\n \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 783, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 106, - "name": "PostgrestBuilder.stripNulls" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 105, - "name": "PostgrestBuilder.stripNulls" - } - }, - { - "id": 702, - "name": "then", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "signatures": [ - { - "id": 703, - "name": "then", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Attaches callbacks for the resolution and/or rejection of the Promise." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A Promise for the completion of which ever callback is executed." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 2 - } - ], - "typeParameters": [ - { - "id": 704, - "name": "TResult1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 705, - "name": "TResult2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "never" - } - } - ], - "parameters": [ - { - "id": 706, - "name": "onfulfilled", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is resolved." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 707, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "signatures": [ - { - "id": 708, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 153 - } - ], - "parameters": [ - { - "id": 709, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - }, - { - "id": 710, - "name": "onrejected", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback to execute when the Promise is rejected." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 711, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "signatures": [ - { - "id": 712, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 811, - "character": 332 - } - ], - "parameters": [ - { - "id": 713, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PromiseLike", - "package": "typescript" - } - ] - } - } - ] - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 116, - "name": "TResult1", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 117, - "name": "TResult2", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ] - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 115, - "name": "PostgrestBuilder.then" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 114, - "name": "PostgrestBuilder.then" - } - }, - { - "id": 691, - "name": "throwOnError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "signatures": [ - { - "id": 692, - "name": "throwOnError", - "variant": "signature", - "kind": 4096, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "https://github.com/supabase/supabase-js/issues/92", - "target": "https://github.com/supabase/supabase-js/issues/92" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Database" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 732, - "character": 2 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 559, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 563, - "name": "Schema", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 564, - "name": "Row", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Row", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 566, - "name": "RelationName", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.RelationName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 567, - "name": "Relationships", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Relationships", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 568, - "name": "Method", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Method", - "refersToTypeParameter": true - } - ], - "name": "PostgrestTransformBuilder", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 104, - "name": "PostgrestBuilder.throwOnError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 103, - "name": "PostgrestBuilder.throwOnError" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [560] - }, - { - "title": "Properties", - "children": [676, 679, 674, 687, 672, 690, 675, 688, 677, 678, 673, 689] - }, - { - "title": "Methods", - "children": [ - 641, 650, 654, 652, 626, 669, 647, 595, 714, 633, 699, 666, 664, 590, 695, 644, 693, - 702, 691 - ] - } - ], - "categories": [ - { - "title": "Database", - "children": [ - 560, 641, 650, 654, 652, 626, 669, 647, 714, 633, 666, 664, 590, 695, 644, 693, 691 - ] - }, - { - "title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.", - "children": [699] - }, - { - "title": "Other", - "children": [676, 679, 674, 687, 672, 690, 675, 688, 677, 678, 673, 689, 595, 702] - } - ], - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 1066, - "character": 14 - } - ], - "typeParameters": [ - { - "id": 722, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ClientServerOptions" - }, - "name": "ClientServerOptions", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 723, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 724, - "name": "Row", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 725, - "name": "Result$1", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 726, - "name": "RelationName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 727, - "name": "Relationships", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 728, - "name": "Method", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 57, - "typeArguments": [ - { - "type": "reference", - "target": 562, - "name": "ClientOptions", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 565, - "name": "Result$1", - "package": "@supabase/postgrest-js", - "qualifiedName": "PostgrestTransformBuilder.Result$1", - "refersToTypeParameter": true - } - ], - "name": "PostgrestBuilder", - "package": "@supabase/postgrest-js" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 141, - "name": "PostgrestFilterBuilder" - } - ] - }, - { - "id": 2822, - "name": "RealtimeChannel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "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": 2823, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 200, - "character": 4 - } - ], - "signatures": [ - { - "id": 2824, - "name": "RealtimeChannel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a channel that can broadcast messages, sync presence, and listen to Postgres changes.\n\nThe topic determines which realtime stream you are subscribing to. Config options let you\nenable acknowledgement for broadcasts, presence tracking, or private channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nconst channel = new RealtimeChannel('realtime:public:messages', { config: {} }, client)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 200, - "character": 4 - } - ], - "parameters": [ - { - "id": 2825, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2826, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 2827, - "name": "socket", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2831, - "name": "bindings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 160, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "Binding" - }, - "name": "Binding", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2833, - "name": "broadcastEndpointURL", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2829, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 158, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2835, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2813, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2834, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 163, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2830, - "name": "socket", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 159, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2832, - "name": "subTopic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2828, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Topic name can be any string." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 157, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2840, - "name": "joinedOnce", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 167, - "character": 8 - } - ], - "getSignature": { - "id": 2841, - "name": "joinedOnce", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 167, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - }, - { - "id": 2844, - "name": "joinPush", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 169, - "character": 8 - } - ], - "getSignature": { - "id": 2845, - "name": "joinPush", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 169, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/push.js", - "qualifiedName": "default" - }, - "name": "Push", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 2846, - "name": "rejoinTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 170, - "character": 8 - } - ], - "getSignature": { - "id": 2847, - "name": "rejoinTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 170, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 2836, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 165, - "character": 8 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 166, - "character": 8 - } - ], - "getSignature": { - "id": 2837, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 165, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - }, - "setSignature": { - "id": 2838, - "name": "state", - "variant": "signature", - "kind": 1048576, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 166, - "character": 8 - } - ], - "parameters": [ - { - "id": 2839, - "name": "state", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "ChannelState" - }, - "name": "ChannelState", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - }, - { - "id": 2842, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 168, - "character": 8 - } - ], - "getSignature": { - "id": 2843, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 168, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3133, - "name": "copyBindings", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 463, - "character": 4 - } - ], - "signatures": [ - { - "id": 3134, - "name": "copyBindings", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 463, - "character": 4 - } - ], - "parameters": [ - { - "id": 3135, - "name": "other", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3099, - "name": "httpSend", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 4 - } - ], - "signatures": [ - { - "id": 3100, - "name": "httpSend", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a broadcast message explicitly via REST API.\n\nThis method always uses the REST API endpoint regardless of WebSocket connection state.\nUseful when you want to guarantee REST delivery or when gradually migrating from implicit REST fallback.\n\nPayloads that are " - }, - { - "kind": "code", - "text": "`ArrayBuffer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`ArrayBufferView`" - }, - { - "kind": "text", - "text": " (e.g. " - }, - { - "kind": "code", - "text": "`Uint8Array`" - }, - { - "kind": "text", - "text": ") are sent as\n" - }, - { - "kind": "code", - "text": "`application/octet-stream`" - }, - { - "kind": "text", - "text": "; all other payloads are JSON-encoded." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Promise resolving to object with success status, and error details if failed" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 4 - } - ], - "parameters": [ - { - "id": 3101, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the broadcast event" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3102, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent (required)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3103, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options including timeout" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3105, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 374, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3105] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 373, - "character": 49 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 3106, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3107, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 376, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3107] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 375, - "character": 16 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 3108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3111, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 380, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3110, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 379, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3109, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 378, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3111, 3110, 3109] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 377, - "character": 8 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2880, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 4 - }, - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 4 - } - ], - "signatures": [ - { - "id": 2881, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 4 - } - ], - "parameters": [ - { - "id": 2882, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2883, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2884, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2885, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 258, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "sync" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2885] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 257, - "character": 58 - } - ] - } - } - }, - { - "id": 2886, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2887, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 259, - "character": 17 - } - ], - "signatures": [ - { - "id": 2888, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 259, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2889, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2890, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2891, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 260, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2892, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 261, - "character": 8 - } - ], - "parameters": [ - { - "id": 2893, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2894, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2895, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2896, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2897, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 263, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "join" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2897] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 262, - "character": 58 - } - ] - } - } - }, - { - "id": 2898, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2899, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 264, - "character": 17 - } - ], - "signatures": [ - { - "id": 2900, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 264, - "character": 17 - } - ], - "parameters": [ - { - "id": 2901, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3362, - "typeArguments": [ - { - "type": "reference", - "target": 2890, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2902, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2903, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2904, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 265, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2905, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 266, - "character": 8 - } - ], - "parameters": [ - { - "id": 2906, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2907, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2908, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2910, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 268, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "leave" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2910] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 267, - "character": 58 - } - ] - } - } - }, - { - "id": 2911, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2912, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 269, - "character": 17 - } - ], - "signatures": [ - { - "id": 2913, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 269, - "character": 17 - } - ], - "parameters": [ - { - "id": 2914, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3372, - "typeArguments": [ - { - "type": "reference", - "target": 2903, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2915, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2916, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2917, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 270, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2918, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 271, - "character": 8 - } - ], - "parameters": [ - { - "id": 2919, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2920, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "presence" - } - }, - { - "id": 2921, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2923, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 273, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "*" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2923] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 272, - "character": 58 - } - ] - } - } - }, - { - "id": 2924, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2925, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 274, - "character": 17 - } - ], - "signatures": [ - { - "id": 2926, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 274, - "character": 17 - } - ], - "parameters": [ - { - "id": 2927, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3362, - "typeArguments": [ - { - "type": "reference", - "target": 2916, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceJoinPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3372, - "typeArguments": [ - { - "type": "reference", - "target": 2916, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceLeavePayload", - "package": "@supabase/realtime-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2928, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2929, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2930, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 275, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2931, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 276, - "character": 8 - } - ], - "parameters": [ - { - "id": 2932, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2933, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2934, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "*" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2935, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2936, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 277, - "character": 156 - } - ], - "signatures": [ - { - "id": 2937, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 277, - "character": 156 - } - ], - "parameters": [ - { - "id": 2938, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3328, - "typeArguments": [ - { - "type": "reference", - "target": 2929, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2939, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2940, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2941, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 278, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2942, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 279, - "character": 8 - } - ], - "parameters": [ - { - "id": 2943, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2944, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2945, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "INSERT" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2946, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2947, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 280, - "character": 159 - } - ], - "signatures": [ - { - "id": 2948, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 280, - "character": 159 - } - ], - "parameters": [ - { - "id": 2949, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3333, - "typeArguments": [ - { - "type": "reference", - "target": 2940, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2950, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2951, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2952, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 281, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2953, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 282, - "character": 8 - } - ], - "parameters": [ - { - "id": 2954, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2955, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2956, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "UPDATE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2957, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2958, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 283, - "character": 159 - } - ], - "signatures": [ - { - "id": 2959, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 283, - "character": 159 - } - ], - "parameters": [ - { - "id": 2960, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3343, - "typeArguments": [ - { - "type": "reference", - "target": 2951, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2961, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2962, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2963, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 284, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2964, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 285, - "character": 8 - } - ], - "parameters": [ - { - "id": 2965, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2966, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2967, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "literal", - "value": "DELETE" - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2968, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2969, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 286, - "character": 159 - } - ], - "signatures": [ - { - "id": 2970, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 286, - "character": 159 - } - ], - "parameters": [ - { - "id": 2971, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3352, - "typeArguments": [ - { - "type": "reference", - "target": 2962, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2972, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2973, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 287, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2975, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 288, - "character": 8 - } - ], - "parameters": [ - { - "id": 2976, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 2977, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "postgres_changes" - } - }, - { - "id": 2978, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3321, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "*" - }, - { - "type": "literal", - "value": "INSERT" - }, - { - "type": "literal", - "value": "UPDATE" - } - ] - } - ], - "name": "RealtimePostgresChangesFilter", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2979, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2980, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 289, - "character": 152 - } - ], - "signatures": [ - { - "id": 2981, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 289, - "character": 152 - } - ], - "parameters": [ - { - "id": 2982, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3328, - "typeArguments": [ - { - "type": "reference", - "target": 2973, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresChangesPayload", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2983, - "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": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 4 - } - ], - "parameters": [ - { - "id": 2984, - "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": 2985, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom object specific to the Realtime feature detailing which payloads to receive." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2986, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2987, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 297, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2987] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 296, - "character": 59 - } - ] - } - } - }, - { - "id": 2988, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function to be invoked when event handler is triggered." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2989, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 17 - } - ], - "signatures": [ - { - "id": 2990, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 17 - } - ], - "parameters": [ - { - "id": 2991, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2992, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2994, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 300, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2995, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 301, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2996, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2998, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 303, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2997, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 302, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2998, 2997] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 301, - "character": 15 - } - ] - } - } - }, - { - "id": 2993, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 299, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2994, 2995, 2993] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 298, - "character": 27 - } - ], - "indexSignatures": [ - { - "id": 2999, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 305, - "character": 8 - } - ], - "parameters": [ - { - "id": 3000, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3001, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3002, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3003, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 307, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3004, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 308, - "character": 8 - } - ], - "parameters": [ - { - "id": 3005, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3006, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3007, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3008, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3009, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 310, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3009] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 309, - "character": 59 - } - ] - } - } - }, - { - "id": 3010, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3011, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 17 - } - ], - "signatures": [ - { - "id": 3012, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 17 - } - ], - "parameters": [ - { - "id": 3013, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3014, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3016, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 313, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3017, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 314, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3018, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3020, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 316, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3019, - "name": "replayed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 315, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3020, 3019] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 314, - "character": 15 - } - ] - } - } - }, - { - "id": 3021, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 318, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3002, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3015, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 312, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3016, 3017, 3021, 3015] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 311, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3022, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3023, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 3024, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3025, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3026, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3027, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 321, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3399, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3027] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 320, - "character": 94 - } - ] - } - } - }, - { - "id": 3028, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 17 - } - ], - "signatures": [ - { - "id": 3030, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 17 - } - ], - "parameters": [ - { - "id": 3031, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3032, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3034, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 324, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3399, - "name": "ALL", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - } - }, - { - "id": 3035, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 325, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3023, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3033, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 323, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3034, 3035, 3033] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 322, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3036, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3037, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 327, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3039, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 328, - "character": 8 - } - ], - "parameters": [ - { - "id": 3040, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3041, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3042, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3043, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3044, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 330, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3400, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3044] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 329, - "character": 59 - } - ] - } - } - }, - { - "id": 3045, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3046, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 17 - } - ], - "signatures": [ - { - "id": 3047, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 17 - } - ], - "parameters": [ - { - "id": 3048, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3051, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 333, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3400, - "name": "INSERT", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - } - }, - { - "id": 3052, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 334, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastInsertPayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3037, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastInsertPayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3050, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 332, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3051, 3052, 3050] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 331, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3053, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3054, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3055, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 336, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3056, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 337, - "character": 8 - } - ], - "parameters": [ - { - "id": 3057, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3058, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3059, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3060, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3061, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 339, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3401, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3061] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 338, - "character": 59 - } - ] - } - } - }, - { - "id": 3062, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3063, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 17 - } - ], - "signatures": [ - { - "id": 3064, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 17 - } - ], - "parameters": [ - { - "id": 3065, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3068, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 342, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3401, - "name": "UPDATE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - } - }, - { - "id": 3069, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastUpdatePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3054, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastUpdatePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3067, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 341, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3068, 3069, 3067] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 340, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3070, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3071, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3072, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 345, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3073, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 346, - "character": 8 - } - ], - "parameters": [ - { - "id": 3074, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3075, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "broadcast" - } - }, - { - "id": 3076, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3077, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3078, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 348, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3402, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3078] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 347, - "character": 59 - } - ] - } - } - }, - { - "id": 3079, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3080, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 17 - } - ], - "signatures": [ - { - "id": 3081, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 17 - } - ], - "parameters": [ - { - "id": 3082, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3083, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3085, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 351, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3402, - "name": "DELETE", - "package": "@supabase/realtime-js", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - } - }, - { - "id": 3086, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 352, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeBroadcastDeletePayload" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3071, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimeBroadcastDeletePayload", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3084, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 350, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": "broadcast" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3085, 3086, 3084] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 349, - "character": 27 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3087, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates an event handler that listens to changes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 3088, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3089, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 354, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3090, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 355, - "character": 8 - } - ], - "parameters": [ - { - "id": 3091, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "parameters": [ - { - "id": 3092, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "literal", - "value": "system" - } - }, - { - "id": 3093, - "name": "filter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - }, - { - "id": 3095, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3096, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 356, - "character": 70 - } - ], - "signatures": [ - { - "id": 3097, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 356, - "character": 70 - } - ], - "parameters": [ - { - "id": 3098, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2857, - "name": "presenceState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 4 - } - ], - "signatures": [ - { - "id": 2858, - "name": "presenceState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current presence state for this channel.\n\nThe shape is a map keyed by presence key (for example a user id) where each entry contains the\ntracked metadata for that user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 4 - } - ], - "typeParameters": [ - { - "id": 2859, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 232, - "character": 28 - } - ], - "indexSignatures": [ - { - "id": 2861, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 233, - "character": 8 - } - ], - "parameters": [ - { - "id": 2862, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 2863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - } - ], - "type": { - "type": "reference", - "target": 3382, - "typeArguments": [ - { - "type": "reference", - "target": 2859, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 3112, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 4 - } - ], - "signatures": [ - { - "id": 3113, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a message into the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- When using REST you don't need to subscribe to the channel\n- REST calls are only available from 2.37.0 onwards\n- If you create a channel only to send a REST broadcast, remove it from\n the client when the send completes" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via websocket", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\nchannel.subscribe((status) => {\n if (status === 'SUBSCRIBED') {\n channel.send({\n type: 'broadcast',\n event: 'cursor-pos',\n payload: { x: Math.random(), y: Math.random() },\n })\n }\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Send a message via websocket\n" - }, - { - "kind": "code", - "text": "```js\nok | timed out | error\n```" - } - ] - }, - { - "tag": "@example", - "name": "Send a message via REST", - "content": [ - { - "kind": "code", - "text": "```js\nconst channel = supabase.channel('room1')\n\ntry {\n await channel.httpSend('cursor-pos', { x: Math.random(), y: Math.random() })\n} finally {\n await supabase.removeChannel(channel)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 4 - } - ], - "parameters": [ - { - "id": 3114, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Arguments to send to channel" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3115, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3117, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event being sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 432, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3118, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payload to be sent" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 433, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3116, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of event to send" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 431, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "broadcast" - }, - { - "type": "literal", - "value": "presence" - }, - { - "type": "literal", - "value": "postgres_changes" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3117, 3118, 3116] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 430, - "character": 15 - } - ], - "indexSignatures": [ - { - "id": 3119, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 434, - "character": 8 - } - ], - "parameters": [ - { - "id": 3120, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 3121, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options to be used during the send process" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3122, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 435, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3123, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 436, - "character": 8 - } - ], - "parameters": [ - { - "id": 3124, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2848, - "name": "subscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 4 - } - ], - "signatures": [ - { - "id": 2849, - "name": "subscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Subscribe registers your client with the server.\n\nThe optional " - }, - { - "kind": "code", - "text": "`callback`" - }, - { - "kind": "text", - "text": " receives a " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " and, on failure, an " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " argument.\nLog the full " - }, - { - "kind": "code", - "text": "`err`" - }, - { - "kind": "text", - "text": " so its " - }, - { - "kind": "code", - "text": "`cause`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": ", and any structured fields aren't hidden\nbehind " - }, - { - "kind": "code", - "text": "`err.message`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Handling errors", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.channel('room1').subscribe((status, err) => {\n if (status === 'CHANNEL_ERROR' || status === 'TIMED_OUT') {\n // Log the full error: its `cause` often holds the underlying reason.\n console.error(status, err)\n }\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 4 - } - ], - "parameters": [ - { - "id": 2850, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 25 - } - ], - "signatures": [ - { - "id": 2852, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 222, - "character": 25 - } - ], - "parameters": [ - { - "id": 2853, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3407, - "name": "REALTIME_SUBSCRIBE_STATES", - "package": "@supabase/realtime-js" - } - }, - { - "id": 2854, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 2855, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3131, - "name": "teardown", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 462, - "character": 4 - } - ], - "signatures": [ - { - "id": 3132, - "name": "teardown", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Destroys and stops related timers." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 462, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 2864, - "name": "track", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 4 - } - ], - "signatures": [ - { - "id": 2865, - "name": "track", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends the supplied payload to the presence tracker so other subscribers can see that this\nclient is online. Use " - }, - { - "kind": "code", - "text": "`untrack`" - }, - { - "kind": "text", - "text": " to stop broadcasting presence for the same key." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 4 - } - ], - "parameters": [ - { - "id": 2866, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2867, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 241, - "character": 19 - } - ], - "indexSignatures": [ - { - "id": 2868, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 242, - "character": 8 - } - ], - "parameters": [ - { - "id": 2869, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 2870, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 243, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 2872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 244, - "character": 8 - } - ], - "parameters": [ - { - "id": 2873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3128, - "name": "unsubscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 456, - "character": 4 - } - ], - "signatures": [ - { - "id": 3129, - "name": "unsubscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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!\") )" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 456, - "character": 4 - } - ], - "parameters": [ - { - "id": 3130, - "name": "timeout", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2874, - "name": "untrack", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 4 - } - ], - "signatures": [ - { - "id": 2875, - "name": "untrack", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes the current presence state for this client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 4 - } - ], - "parameters": [ - { - "id": 2876, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2877, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 251, - "character": 19 - } - ], - "indexSignatures": [ - { - "id": 2878, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 252, - "character": 8 - } - ], - "parameters": [ - { - "id": 2879, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3150, - "name": "RealtimeChannelSendResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3125, - "name": "updateJoinPayload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 444, - "character": 4 - } - ], - "signatures": [ - { - "id": 3126, - "name": "updateJoinPayload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the payload that will be sent the next time the channel joins (reconnects).\nUseful for rotating access tokens or updating config without re-creating the channel." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 444, - "character": 4 - } - ], - "parameters": [ - { - "id": 3127, - "name": "payload", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2823] - }, - { - "title": "Properties", - "children": [2831, 2833, 2829, 2835, 2834, 2830, 2832, 2828] - }, - { - "title": "Accessors", - "children": [2840, 2844, 2846, 2836, 2842] - }, - { - "title": "Methods", - "children": [3133, 3099, 2880, 2857, 3112, 2848, 3131, 2864, 3128, 2874, 3125] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 2831, 2833, 2829, 2835, 2834, 2830, 2832, 2828, 2840, 2844, 2846, 2836, 2842, 3133, - 2880 - ] - }, - { - "title": "Realtime", - "children": [2823, 3099, 2857, 3112, 2848, 3131, 2864, 3128, 2874, 3125] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 155, - "character": 21 - } - ] - }, - { - "id": 3152, - "name": "RealtimeClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 3153, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 145, - "character": 4 - } - ], - "signatures": [ - { - "id": 3154, - "name": "RealtimeClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initializes the Socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Using supabase-js (recommended)", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst channel = supabase.channel('room1')\nchannel\n .on('broadcast', { event: 'cursor-pos' }, (payload) => console.log(payload))\n .subscribe()\n```" - } - ] - }, - { - "tag": "@example", - "name": "Standalone import for bundle-sensitive environments", - "content": [ - { - "kind": "code", - "text": "```ts\nimport RealtimeClient from '@supabase/realtime-js'\n\nconst client = new RealtimeClient('https://xyzcompany.supabase.co/realtime/v1', {\n params: { apikey: 'your-publishable-key' },\n})\nclient.connect()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 145, - "character": 4 - } - ], - "parameters": [ - { - "id": 3155, - "name": "endPoint", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The string WebSocket endpoint, ie, \"ws://example.com/socket\", \"wss://example.com\", \"/socket\" (inherited host & protocol)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3156, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3273, - "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": "Deprecated: headers cannot be set on websocket connections and this option will be removed in the future." - } - ], - "heartbeatIntervalMs": [ - { - "kind": "text", - "text": "The millisec interval to send a heartbeat message." - } - ], - "heartbeatCallback": [ - { - "kind": "text", - "text": "The optional function to handle heartbeat status and latency." - } - ], - "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." - } - ], - "vsn": [ - { - "kind": "text", - "text": "The protocol version to use when connecting. Supported versions are \"1.0.0\" and \"2.0.0\". Defaults to \"2.0.0\"." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3159, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3160, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 18 - } - ], - "signatures": [ - { - "id": 3161, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 60, - "character": 18 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3158, - "name": "accessTokenValue", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 59, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 3162, - "name": "apiKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 61, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 3157, - "name": "channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 58, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - }, - { - "id": 3174, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 72, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 3176, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 3177, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3178, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 3179, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 3180, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3181, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3164, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "headers cannot be set on websocket connections" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 64, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3165, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 64, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3166, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 65, - "character": 8 - } - ], - "parameters": [ - { - "id": 3167, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3163, - "name": "httpEndpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3173, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 71, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3168, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 67, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3169, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 67, - "character": 13 - } - ], - "indexSignatures": [ - { - "id": 3170, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 68, - "character": 8 - } - ], - "parameters": [ - { - "id": 3171, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3172, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 70, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3185, - "name": "serializer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 76, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/lib/serializer.ts", - "qualifiedName": "default" - }, - "name": "Serializer", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 3182, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 73, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3184, - "name": "workerRef", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 75, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Worker" - }, - "name": "Worker", - "package": "typescript" - } - }, - { - "id": 3183, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 74, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3206, - "name": "decode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 87, - "character": 8 - } - ], - "getSignature": { - "id": 3207, - "name": "decode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 87, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3204, - "name": "encode", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 86, - "character": 8 - } - ], - "getSignature": { - "id": 3205, - "name": "encode", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 86, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3186, - "name": "endPoint", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 77, - "character": 8 - } - ], - "getSignature": { - "id": 3187, - "name": "endPoint", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 77, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 3192, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 80, - "character": 8 - } - ], - "getSignature": { - "id": 3193, - "name": "heartbeatCallback", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 80, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3194, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 81, - "character": 8 - } - ], - "getSignature": { - "id": 3195, - "name": "heartbeatIntervalMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 81, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3196, - "name": "heartbeatTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 82, - "character": 8 - } - ], - "getSignature": { - "id": 3197, - "name": "heartbeatTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 82, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "HeartbeatTimer" - }, - "name": "HeartbeatTimer", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3198, - "name": "pendingHeartbeatRef", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 83, - "character": 8 - } - ], - "getSignature": { - "id": 3199, - "name": "pendingHeartbeatRef", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 83, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 3208, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 8 - } - ], - "getSignature": { - "id": 3209, - "name": "reconnectAfterMs", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3210, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 28 - } - ], - "signatures": [ - { - "id": 3211, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 88, - "character": 28 - } - ], - "parameters": [ - { - "id": 3212, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - } - }, - { - "id": 3200, - "name": "reconnectTimer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 84, - "character": 8 - } - ], - "getSignature": { - "id": 3201, - "name": "reconnectTimer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 84, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/timer.js", - "qualifiedName": "default" - }, - "name": "Timer", - "package": "@supabase/phoenix", - "qualifiedName": "default" - } - } - }, - { - "id": 3213, - "name": "sendBuffer", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 8 - } - ], - "getSignature": { - "id": 3214, - "name": "sendBuffer", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 3215, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 23 - } - ], - "signatures": [ - { - "id": 3216, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 89, - "character": 23 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - } - }, - { - "id": 3217, - "name": "stateChangeCallbacks", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 8 - } - ], - "getSignature": { - "id": 3218, - "name": "stateChangeCallbacks", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3219, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3221, - "name": "close", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 92, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3222, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 93, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3223, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 94, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - }, - { - "id": 3220, - "name": "open", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 91, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3221, 3222, 3223, 3220] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 90, - "character": 32 - } - ] - } - } - } - }, - { - "id": 3188, - "name": "timeout", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 78, - "character": 8 - } - ], - "getSignature": { - "id": 3189, - "name": "timeout", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 78, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 3190, - "name": "transport", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 79, - "character": 8 - } - ], - "getSignature": { - "id": 3191, - "name": "transport", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 79, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3481, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3202, - "name": "vsn", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 85, - "character": 8 - } - ], - "getSignature": { - "id": 3203, - "name": "vsn", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 85, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Vsn" - }, - "name": "Vsn", - "package": "@supabase/phoenix" - } - } - }, - { - "id": 3258, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 228, - "character": 4 - } - ], - "signatures": [ - { - "id": 3259, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates (or reuses) a " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RealtimeChannel", - "target": 2822 - }, - { - "kind": "text", - "text": " for the provided topic.\n\nTopics are automatically prefixed with " - }, - { - "kind": "code", - "text": "`realtime:`" - }, - { - "kind": "text", - "text": " to match the Realtime service.\nIf a channel with the same topic already exists it will be returned instead of creating\na duplicate connection." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 228, - "character": 4 - } - ], - "parameters": [ - { - "id": 3260, - "name": "topic", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3261, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 3230, - "name": "connect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 151, - "character": 4 - } - ], - "signatures": [ - { - "id": 3231, - "name": "connect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Connects the socket, unless already connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 151, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3250, - "name": "connectionState", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 200, - "character": 4 - } - ], - "signatures": [ - { - "id": 3251, - "name": "connectionState", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current state of the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 200, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/lib/constants.ts", - "qualifiedName": "ConnectionState" - }, - "name": "ConnectionState", - "package": "@supabase/realtime-js" - } - } - ] - }, - { - "id": 3234, - "name": "disconnect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 167, - "character": 4 - } - ], - "signatures": [ - { - "id": 3235, - "name": "disconnect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Disconnects the socket." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 167, - "character": 4 - } - ], - "parameters": [ - { - "id": 3236, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A numeric status code to send on disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3237, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom reason for the disconnect." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "timeout" - }, - { - "type": "literal", - "value": "ok" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3232, - "name": "endpointURL", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 158, - "character": 4 - } - ], - "signatures": [ - { - "id": 3233, - "name": "endpointURL", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the URL of the websocket." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "string The URL of the websocket." - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 158, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 3238, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 173, - "character": 4 - } - ], - "signatures": [ - { - "id": 3239, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all created channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 173, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 3252, - "name": "isConnected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 206, - "character": 4 - } - ], - "signatures": [ - { - "id": 3253, - "name": "isConnected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " is the connection is open." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3254, - "name": "isConnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 212, - "character": 4 - } - ], - "signatures": [ - { - "id": 3255, - "name": "isConnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently connecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 212, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3256, - "name": "isDisconnecting", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 218, - "character": 4 - } - ], - "signatures": [ - { - "id": 3257, - "name": "isDisconnecting", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the connection is currently disconnecting." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 218, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3245, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 194, - "character": 4 - } - ], - "signatures": [ - { - "id": 3246, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logs the message.\n\nFor customized logging, " - }, - { - "kind": "code", - "text": "`this.logger`" - }, - { - "kind": "text", - "text": " can be overridden in Client constructor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 194, - "character": 4 - } - ], - "parameters": [ - { - "id": 3247, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3248, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3249, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3270, - "name": "onHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 272, - "character": 4 - } - ], - "signatures": [ - { - "id": 3271, - "name": "onHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets a callback that receives lifecycle events for internal heartbeat messages.\nUseful for instrumenting connection health (e.g. sent/ok/timeout/disconnected)." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 272, - "character": 4 - } - ], - "parameters": [ - { - "id": 3272, - "name": "callback", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "HeartbeatCallback" - }, - "name": "HeartbeatCallback", - "package": "@supabase/phoenix" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3262, - "name": "push", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 236, - "character": 4 - } - ], - "signatures": [ - { - "id": 3263, - "name": "push", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 236, - "character": 4 - } - ], - "parameters": [ - { - "id": 3264, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3314, - "name": "RealtimeMessage", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3243, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 186, - "character": 4 - } - ], - "signatures": [ - { - "id": 3244, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down all channels" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 186, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3240, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 180, - "character": 4 - } - ], - "signatures": [ - { - "id": 3241, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes, removes and tears down a single channel" - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 180, - "character": 4 - } - ], - "parameters": [ - { - "id": 3242, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A RealtimeChannel instance" - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3268, - "name": "sendHeartbeat", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 265, - "character": 4 - } - ], - "signatures": [ - { - "id": 3269, - "name": "sendHeartbeat", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends a heartbeat message if the socket is connected." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 265, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3265, - "name": "setAuth", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 259, - "character": 4 - } - ], - "signatures": [ - { - "id": 3266, - "name": "setAuth", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "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.\n\nWhen a token is explicitly provided, it will be preserved across channel operations\n(including removeChannel and resubscribe). The " - }, - { - "kind": "code", - "text": "`accessToken`" - }, - { - "kind": "text", - "text": " callback will not be\ninvoked until " - }, - { - "kind": "code", - "text": "`setAuth()`" - }, - { - "kind": "text", - "text": " is called without arguments." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nSetting the authorization header\n// Use a manual token (preserved across resubscribes, ignores accessToken callback)\nclient.realtime.setAuth('my-custom-jwt')\n\n// Switch back to using the accessToken callback\nclient.realtime.setAuth()\n```" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 259, - "character": 4 - } - ], - "parameters": [ - { - "id": 3267, - "name": "token", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A JWT string to override the token set on the client." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [3153] - }, - { - "title": "Properties", - "children": [ - 3159, 3158, 3162, 3157, 3174, 3164, 3163, 3173, 3168, 3172, 3185, 3182, 3184, 3183 - ] - }, - { - "title": "Accessors", - "children": [ - 3206, 3204, 3186, 3192, 3194, 3196, 3198, 3208, 3200, 3213, 3217, 3188, 3190, 3202 - ] - }, - { - "title": "Methods", - "children": [ - 3258, 3230, 3250, 3234, 3232, 3238, 3252, 3254, 3256, 3245, 3270, 3262, 3243, 3240, - 3268, 3265 - ] - } - ], - "categories": [ - { - "title": "Other", - "children": [ - 3159, 3158, 3162, 3157, 3174, 3164, 3163, 3173, 3168, 3172, 3185, 3182, 3184, 3183, - 3206, 3204, 3186, 3192, 3194, 3196, 3198, 3208, 3200, 3213, 3217, 3188, 3190, 3202 - ] - }, - { - "title": "Realtime", - "children": [ - 3153, 3258, 3230, 3250, 3234, 3232, 3238, 3252, 3254, 3256, 3245, 3270, 3262, 3243, - 3240, 3268, 3265 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 57, - "character": 21 - } - ] - }, - { - "id": 2813, - "name": "RealtimePresence", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2814, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 60, - "character": 4 - } - ], - "signatures": [ - { - "id": 2815, - "name": "RealtimePresence", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Presence helper that keeps the local presence state in sync with the server." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example for a presence channel", - "content": [ - { - "kind": "code", - "text": "```ts\nconst presence = new RealtimePresence(channel)\n\nchannel.on('presence', ({ event, key }) => {\n console.log(`Presence ${event} on ${key}`)\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 60, - "character": 4 - } - ], - "parameters": [ - { - "id": 2816, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The realtime channel to bind to." - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2817, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional custom event names, e.g. " - }, - { - "kind": "code", - "text": "`{ events: { state: 'state', diff: 'diff' } }`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceOptions" - }, - "name": "RealtimePresenceOptions", - "package": "@supabase/realtime-js" - } - } - ], - "type": { - "type": "reference", - "target": 2813, - "name": "RealtimePresence", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2818, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 40, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 2819, - "name": "state", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 41, - "character": 8 - } - ], - "getSignature": { - "id": 2820, - "name": "state", - "variant": "signature", - "kind": 524288, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 41, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 3382, - "name": "RealtimePresenceState", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [2814] - }, - { - "title": "Properties", - "children": [2818] - }, - { - "title": "Accessors", - "children": [2819] - } - ], - "categories": [ - { - "title": "Other", - "children": [2818, 2819] - }, - { - "title": "Realtime", - "children": [2814] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 39, - "character": 21 - } - ] - }, - { - "id": 850, - "name": "StorageApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "API error returned from Storage service\nIncludes HTTP status code and service-specific error code" - } - ] - }, - "children": [ - { - "id": 851, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 40, - "character": 2 - } - ], - "signatures": [ - { - "id": 852, - "name": "StorageApiError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 40, - "character": 2 - } - ], - "parameters": [ - { - "id": 853, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 854, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 855, - "name": "statusCode", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 856, - "name": "namespace", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - } - } - ], - "type": { - "type": "reference", - "target": 850, - "name": "StorageApiError", - "package": "@supabase/storage-js" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.constructor" - } - }, - { - "id": 866, - "name": "__isStorageError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "StorageError.__isStorageError" - } - }, - { - "id": 867, - "name": "namespace", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "ErrorNamespace" - }, - "name": "ErrorNamespace", - "package": "@supabase/storage-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "StorageError.namespace" - } - }, - { - "id": 857, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 38, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.status" - } - }, - { - "id": 858, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 39, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.statusCode" - } - }, - { - "id": 859, - "name": "toJSON", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 2 - } - ], - "signatures": [ - { - "id": 860, - "name": "toJSON", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 861, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 863, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 862, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 42, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 864, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 865, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [863, 862, 864, 865] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 41, - "character": 12 - } - ] - } - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.toJSON" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "StorageError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [851] - }, - { - "title": "Properties", - "children": [866, 867, 857, 858] - }, - { - "title": "Methods", - "children": [859] - } - ], - "sources": [ - { - "fileName": "packages/core/storage-js/dist/index.d.cts", - "line": 37, - "character": 14 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError" - }, - "name": "StorageError", - "package": "@supabase/storage-js" - } - ] - }, - { - "id": 941, - "name": "SupabaseClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Client.\n\nAn isomorphic Javascript client for interacting with Postgres." - } - ] - }, - "children": [ - { - "id": 942, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 309, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L309" - } - ], - "signatures": [ - { - "id": 943, - "name": "SupabaseClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new client for use in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Initializing" - } - ] - }, - { - "tag": "@example", - "name": "Creating a client", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Create a single supabase client for interacting with your database\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n```" - } - ] - }, - { - "tag": "@example", - "name": "With a custom domain", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Use a custom domain as the supabase URL\nconst supabase = createClient('https://my-custom-domain.com', 'your-publishable-key')\n```" - } - ] - }, - { - "tag": "@example", - "name": "With additional parameters", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst options = {\n db: {\n schema: 'public',\n },\n auth: {\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: true\n },\n global: {\n headers: { 'x-my-custom-header': 'my-app-name' },\n },\n}\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", options)\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With custom schemas\nBy default the API server points to the " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": " schema. You can enable other database schemas within the Dashboard.\nGo to [Settings > API > Exposed schemas](/dashboard/project/_/settings/api) and add the schema which you want to expose to the API.\n\nNote: each client connection can only access a single schema, so the code above can access the " - }, - { - "kind": "code", - "text": "`other_schema`" - }, - { - "kind": "text", - "text": " schema but cannot access the " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": " schema." - } - ] - }, - { - "tag": "@example", - "name": "With custom schemas", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n // Provide a custom schema. Defaults to \"public\".\n db: { schema: 'other_schema' }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "Custom fetch implementation\n" - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests,\nbut an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option.\nThis is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible (for instance Cloudflare Workers)." - } - ] - }, - { - "tag": "@example", - "name": "Custom fetch implementation", - "content": [ - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n global: { fetch: fetch.bind(globalThis) }\n})\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "React Native options with AsyncStorage\nFor React Native we recommend using " - }, - { - "kind": "code", - "text": "`AsyncStorage`" - }, - { - "kind": "text", - "text": " as the storage implementation for Supabase Auth." - } - ] - }, - { - "tag": "@example", - "name": "React Native options with AsyncStorage", - "content": [ - { - "kind": "code", - "text": "```js\nimport 'react-native-url-polyfill/auto'\nimport { createClient } from '@supabase/supabase-js'\nimport AsyncStorage from \"@react-native-async-storage/async-storage\";\n\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", {\n auth: {\n storage: AsyncStorage,\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: false,\n },\n});\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "React Native options with Expo SecureStore\nIf you wish to encrypt the user's session information, you can use " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " and store the encryption key in Expo SecureStore.\nThe " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " library, a reputable JavaScript-only implementation of the AES encryption algorithm in CTR mode.\nA new 256-bit encryption key is generated using the " - }, - { - "kind": "code", - "text": "`react-native-get-random-values`" - }, - { - "kind": "text", - "text": " library.\nThis key is stored inside Expo's SecureStore, while the value is encrypted and placed inside AsyncStorage.\n\nPlease make sure that:\n- You keep the " - }, - { - "kind": "code", - "text": "`expo-secure-store`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`aes-js`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`react-native-get-random-values`" - }, - { - "kind": "text", - "text": " libraries up-to-date.\n- Choose the correct [" - }, - { - "kind": "code", - "text": "`SecureStoreOptions`" - }, - { - "kind": "text", - "text": "](https://docs.expo.dev/versions/latest/sdk/securestore/#securestoreoptions) for your app's needs.\n E.g. [" - }, - { - "kind": "code", - "text": "`SecureStore.WHEN_UNLOCKED`" - }, - { - "kind": "text", - "text": "](https://docs.expo.dev/versions/latest/sdk/securestore/#securestorewhen_unlocked) regulates when the data can be accessed.\n- Carefully consider optimizations or other modifications to the above example, as those can lead to introducing subtle security vulnerabilities." - } - ] - }, - { - "tag": "@example", - "name": "React Native options with Expo SecureStore", - "content": [ - { - "kind": "code", - "text": "```ts\nimport 'react-native-url-polyfill/auto'\nimport { createClient } from '@supabase/supabase-js'\nimport AsyncStorage from '@react-native-async-storage/async-storage';\nimport * as SecureStore from 'expo-secure-store';\nimport * as aesjs from 'aes-js';\nimport 'react-native-get-random-values';\n\n// As Expo's SecureStore does not support values larger than 2048\n// bytes, an AES-256 key is generated and stored in SecureStore, while\n// it is used to encrypt/decrypt values stored in AsyncStorage.\nclass LargeSecureStore {\n private async _encrypt(key: string, value: string) {\n const encryptionKey = crypto.getRandomValues(new Uint8Array(256 / 8));\n\n const cipher = new aesjs.ModeOfOperation.ctr(encryptionKey, new aesjs.Counter(1));\n const encryptedBytes = cipher.encrypt(aesjs.utils.utf8.toBytes(value));\n\n await SecureStore.setItemAsync(key, aesjs.utils.hex.fromBytes(encryptionKey));\n\n return aesjs.utils.hex.fromBytes(encryptedBytes);\n }\n\n private async _decrypt(key: string, value: string) {\n const encryptionKeyHex = await SecureStore.getItemAsync(key);\n if (!encryptionKeyHex) {\n return encryptionKeyHex;\n }\n\n const cipher = new aesjs.ModeOfOperation.ctr(aesjs.utils.hex.toBytes(encryptionKeyHex), new aesjs.Counter(1));\n const decryptedBytes = cipher.decrypt(aesjs.utils.hex.toBytes(value));\n\n return aesjs.utils.utf8.fromBytes(decryptedBytes);\n }\n\n async getItem(key: string) {\n const encrypted = await AsyncStorage.getItem(key);\n if (!encrypted) { return encrypted; }\n\n return await this._decrypt(key, encrypted);\n }\n\n async removeItem(key: string) {\n await AsyncStorage.removeItem(key);\n await SecureStore.deleteItemAsync(key);\n }\n\n async setItem(key: string, value: string) {\n const encrypted = await this._encrypt(key, value);\n\n await AsyncStorage.setItem(key, encrypted);\n }\n}\n\nconst supabase = createClient(\"https://xyzcompany.supabase.co\", \"your-publishable-key\", {\n auth: {\n storage: new LargeSecureStore(),\n autoRefreshToken: true,\n persistSession: true,\n detectSessionInUrl: false,\n },\n});\n```" - } - ] - }, - { - "tag": "@example", - "name": "With a database query", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n\nconst { data } = await supabase.from('profiles').select('*')\n```" - } - ] - }, - { - "tag": "@exampleDescription", - "content": [ - { - "kind": "text", - "text": "With OpenTelemetry tracing\nOpt in to W3C trace context propagation so the " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " from your\nclient-side spans is attached to Supabase requests and appears in API\nGateway and Edge Function logs. Requires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be\ninstalled in your application. See [Tracing with the JS SDK](https://supabase.com/docs/guides/telemetry/client-side-tracing)." - } - ] - }, - { - "tag": "@example", - "name": "With OpenTelemetry tracing", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n tracePropagation: true,\n})\n\nconst tracer = trace.getTracer('my-app')\n\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // Outgoing request carries the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 309, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L309" - } - ], - "typeParameters": [ - { - "id": 944, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 945, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 946, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 947, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [947] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 948, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "reference", - "target": 945, - "typeArguments": [ - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - } - }, - { - "id": 949, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 950, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 951, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 952, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [952] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ] - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 953, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 954, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 955, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 956, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [956] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [954] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "__InternalSupabase" - }, - "objectType": { - "type": "reference", - "target": 944, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - ], - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 957, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 958, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [958] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ] - } - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 959, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 960, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [960] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 945, - "typeArguments": [ - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ], - "parameters": [ - { - "id": 961, - "name": "supabaseUrl", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 962, - "name": "supabaseKey", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 963, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1072, - "typeArguments": [ - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClientOptions", - "package": "@supabase/supabase-js", - "highlightedProperties": { - "realtime": [ - { - "kind": "text", - "text": "Options passed along to realtime-js constructor." - } - ], - "storage": [ - { - "kind": "text", - "text": "Options passed along to the storage-js constructor." - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 941, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClient", - "package": "@supabase/supabase-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 982, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 983, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "signatures": [ - { - "id": 984, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 93, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L93" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 964, - "name": "auth", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Auth allows you to create and manage user sessions for access to data that is secured by access policies." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 78, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L78" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/SupabaseAuthClient.ts", - "qualifiedName": "SupabaseAuthClient" - }, - "name": "SupabaseAuthClient", - "package": "@supabase/supabase-js" - } - }, - { - "id": 968, - "name": "authUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 86, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L86" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 981, - "name": "changedAccessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 92, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L92" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 973, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 91, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L91" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - }, - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "signatures": [ - { - "id": 975, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 29329, - "character": 17 - } - ], - "parameters": [ - { - "id": 976, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInfo" - }, - "name": "RequestInfo", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 977, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 978, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "line": 289, - "character": 13 - } - ], - "parameters": [ - { - "id": 979, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Request" - }, - "name": "Request", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 980, - "name": "init", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "RequestInit" - }, - "name": "RequestInit", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Response" - }, - "name": "Response", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 970, - "name": "functionsUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 88, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L88" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 985, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 95, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L95" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 965, - "name": "realtime", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 79, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L79" - } - ], - "type": { - "type": "reference", - "target": 3152, - "name": "RealtimeClient", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - }, - { - "id": 967, - "name": "realtimeUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 85, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L85" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 971, - "name": "rest", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 89, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L89" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestClient" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 986, - "name": "settings", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 96, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L96" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/helpers.ts", - "qualifiedName": "ResolvedSupabaseClientOptions" - }, - "typeArguments": [ - { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - } - ], - "name": "ResolvedSupabaseClientOptions", - "package": "@supabase/supabase-js" - } - }, - { - "id": 966, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Storage allows you to manage user-generated content, such as photos or videos." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 83, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L83" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageClient" - }, - "name": "StorageClient", - "package": "@supabase/storage-js" - } - }, - { - "id": 972, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 90, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L90" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 969, - "name": "storageUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 87, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L87" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 988, - "name": "supabaseKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase Key which is supplied when you create a new project in your project dashboard." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 311, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L311" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 987, - "name": "supabaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique Supabase URL which is supplied when you create a new project in your project dashboard." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 310, - "character": 14, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L310" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 989, - "name": "functions", - "variant": "declaration", - "kind": 262144, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 403, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L403" - } - ], - "getSignature": { - "id": 990, - "name": "functions", - "variant": "signature", - "kind": 524288, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supabase Functions allows you to deploy and invoke edge functions." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 403, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L403" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../functions-js/src/FunctionsClient.ts", - "qualifiedName": "FunctionsClient" - }, - "name": "FunctionsClient", - "package": "@supabase/functions-js" - } - } - }, - { - "id": 1016, - "name": "channel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L515" - } - ], - "signatures": [ - { - "id": 1017, - "name": "channel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 515, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L515" - } - ], - "parameters": [ - { - "id": 1018, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Realtime channel." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1019, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The options to pass to the Realtime channel." - } - ] - }, - "type": { - "type": "reference", - "target": 3136, - "name": "RealtimeChannelOptions", - "package": "@supabase/realtime-js" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 991, - "name": "from", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a query on a table or a view." - } - ], - "blockTags": [ - { - "tag": "@param", - "name": "relation", - "content": [ - { - "kind": "text", - "text": "The table or view name to query" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L411" - }, - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L415" - }, - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 423, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L423" - } - ], - "signatures": [ - { - "id": 992, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 411, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L411" - } - ], - "typeParameters": [ - { - "id": 993, - "name": "TableName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 994, - "name": "Table", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericTable" - }, - "name": "GenericTable", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 995, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 993, - "name": "TableName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 994, - "name": "Table", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 993, - "name": "TableName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 996, - "name": "from", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 415, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L415" - } - ], - "typeParameters": [ - { - "id": 997, - "name": "ViewName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 998, - "name": "View", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericView" - }, - "name": "GenericView", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 999, - "name": "relation", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 997, - "name": "ViewName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 729, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 998, - "name": "View", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 997, - "name": "ViewName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestQueryBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 1020, - "name": "getChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 529, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L529" - } - ], - "signatures": [ - { - "id": 1021, - "name": "getChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns all Realtime channels." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Get all channels", - "content": [ - { - "kind": "code", - "text": "```js\nconst channels = supabase.getChannels()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 529, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L529" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - } - ] - }, - { - "id": 1025, - "name": "removeAllChannels", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L566" - } - ], - "signatures": [ - { - "id": 1026, - "name": "removeAllChannels", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes and removes all Realtime channels from Realtime client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Removing channels is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed." - } - ] - }, - { - "tag": "@example", - "name": "Remove all channels", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.removeAllChannels()\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 566, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L566" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1022, - "name": "removeChannel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L549" - } - ], - "signatures": [ - { - "id": 1023, - "name": "removeChannel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unsubscribes and removes Realtime channel from Realtime client." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Removing a channel is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed." - } - ] - }, - { - "tag": "@example", - "name": "Removes a channel", - "content": [ - { - "kind": "code", - "text": "```js\nsupabase.removeChannel(myChannel)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 549, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L549" - } - ], - "parameters": [ - { - "id": 1024, - "name": "channel", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Realtime channel." - } - ] - }, - "type": { - "type": "reference", - "target": 2822, - "name": "RealtimeChannel", - "package": "@supabase/realtime-js", - "qualifiedName": "default" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3391, - "name": "RealtimeRemoveChannelResponse", - "package": "@supabase/realtime-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1004, - "name": "rpc", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L470" - } - ], - "signatures": [ - { - "id": 1005, - "name": "rpc", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Perform a function call." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 470, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L470" - } - ], - "typeParameters": [ - { - "id": 1006, - "name": "FnName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1007, - "name": "Args", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "default": { - "type": "intrinsic", - "name": "never" - } - }, - { - "id": 1008, - "name": "FilterBuilder", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/rpc.ts", - "qualifiedName": "RpcFunctionNotFound" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "RpcFunctionNotFound", - "package": "@supabase/supabase-js" - }, - "default": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/rpc.ts", - "qualifiedName": "GetRpcFunctionFilterBuilderByArgs" - }, - "typeArguments": [ - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1007, - "name": "Args", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "GetRpcFunctionFilterBuilderByArgs", - "package": "@supabase/supabase-js" - } - } - ], - "parameters": [ - { - "id": 1009, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function name to call" - } - ] - }, - "type": { - "type": "reference", - "target": 1006, - "name": "FnName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "id": 1010, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The arguments to pass to the function call" - } - ] - }, - "type": { - "type": "reference", - "target": 1007, - "name": "Args", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "defaultValue": "..." - }, - { - "id": 1011, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Named parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1012, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1015, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" - }, - { - "kind": "code", - "text": "`\"exact\"`" - }, - { - "kind": "text", - "text": ": Exact but slow count algorithm. Performs a " - }, - { - "kind": "code", - "text": "`COUNT(*)`" - }, - { - "kind": "text", - "text": " under the\nhood.\n\n" - }, - { - "kind": "code", - "text": "`\"planned\"`" - }, - { - "kind": "text", - "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" - }, - { - "kind": "code", - "text": "`\"estimated\"`" - }, - { - "kind": "text", - "text": ": Uses exact count for low numbers and planned count for high\nnumbers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 481, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L481" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "exact" - }, - { - "type": "literal", - "value": "planned" - }, - { - "type": "literal", - "value": "estimated" - } - ] - } - }, - { - "id": 1014, - "name": "get", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", the function will be called with\nread-only access mode." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 480, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L480" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1013, - "name": "head", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " will not be returned.\nUseful if you only need the count." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 479, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L479" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1015, 1014, 1013] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 478, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L478" - } - ] - } - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reference", - "target": 141, - "typeArguments": [ - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 949, - "name": "Schema", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Schema", - "refersToTypeParameter": true - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Row" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Result" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "RelationName" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "Relationships" - }, - "objectType": { - "type": "reference", - "target": 1008, - "name": "FilterBuilder", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "RPC" - } - ], - "name": "PostgrestFilterBuilder", - "package": "@supabase/postgrest-js" - } - } - ] - }, - { - "id": 1000, - "name": "schema", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L435" - } - ], - "signatures": [ - { - "id": 1001, - "name": "schema", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 435, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L435" - } - ], - "typeParameters": [ - { - "id": 1002, - "name": "DynamicSchema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "parameters": [ - { - "id": 1003, - "name": "schema", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema to query" - } - ] - }, - "type": { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestClient" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 950, - "name": "ClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.ClientOptions", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 1002, - "name": "DynamicSchema", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "any" - }, - "objectType": { - "type": "intrinsic", - "name": "any" - } - }, - "falseType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "PostgrestClient", - "package": "@supabase/postgrest-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [942] - }, - { - "title": "Properties", - "children": [ - 982, 964, 968, 981, 973, 970, 985, 965, 967, 971, 986, 966, 972, 969, 988, 987 - ] - }, - { - "title": "Accessors", - "children": [989] - }, - { - "title": "Methods", - "children": [1016, 991, 1020, 1025, 1022, 1004, 1000] - } - ], - "categories": [ - { - "title": "Initializing", - "children": [942] - }, - { - "title": "Other", - "children": [ - 982, 964, 968, 981, 973, 970, 985, 965, 967, 971, 986, 966, 972, 969, 988, 987, 989, - 991, 1004, 1000 - ] - }, - { - "title": "Realtime", - "children": [1016, 1020, 1025, 1022] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 43, - "character": 21, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L43" - } - ], - "typeParameters": [ - { - "id": 1055, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 1056, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - { - "type": "reflection", - "declaration": { - "id": 1057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1058, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1058] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 50, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L50" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1059, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "trueType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - } - } - } - }, - { - "id": 1060, - "name": "Schema", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/rest/types/common/common.ts", - "qualifiedName": "GenericSchema" - }, - "name": "GenericSchema", - "package": "@supabase/supabase-js" - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": 948, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaName", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 1061, - "name": "ClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1062, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1063, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 26, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1063] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 64, - "character": 24, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L64" - } - ] - } - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ] - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1064, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1065, - "name": "__InternalSupabase", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 25, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1067, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 47, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1067] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 45, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1065] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 67, - "character": 23, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L67" - } - ] - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "__InternalSupabase" - }, - "objectType": { - "type": "reference", - "target": 944, - "name": "Database", - "package": "@supabase/supabase-js", - "qualifiedName": "default.Database", - "refersToTypeParameter": true - } - }, - "falseType": { - "type": "reflection", - "declaration": { - "id": 1068, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1069, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 10, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ], - "type": { - "type": "literal", - "value": "12" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1069] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 70, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L70" - } - ] - } - } - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1070, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1071, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 42, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1071] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/SupabaseClient.ts", - "line": 71, - "character": 40, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/SupabaseClient.ts#L71" - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 945, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "qualifiedName": "default.SchemaNameOrClientOptions", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - ] - }, - { - "id": 3419, - "name": "WebSocketFactory", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Utilities for creating WebSocket instances across runtimes." - } - ] - }, - "children": [ - { - "id": 3421, - "name": "getWebSocketConstructor", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 65, - "character": 11 - } - ], - "signatures": [ - { - "id": 3422, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the best available WebSocket constructor for the current runtime." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example with error handling", - "content": [ - { - "kind": "code", - "text": "```ts\ntry {\n const WS = WebSocketFactory.getWebSocketConstructor()\n const socket = new WS('wss://example.com/socket')\n} catch (error) {\n console.error('WebSocket not available in this environment.', error)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 65, - "character": 11 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3423, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26772, - "character": 23 - } - ], - "signatures": [ - { - "id": 3424, - "name": "getWebSocketConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "line": 26774, - "character": 4 - } - ], - "parameters": [ - { - "id": 3425, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3426, - "name": "protocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "WebSocket" - }, - "name": "WebSocket", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 3427, - "name": "isWebSocketSupported", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 79, - "character": 11 - } - ], - "signatures": [ - { - "id": 3428, - "name": "isWebSocketSupported", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detects whether the runtime can establish WebSocket connections." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Realtime" - } - ] - }, - { - "tag": "@example", - "name": "Example in a Node.js script", - "content": [ - { - "kind": "code", - "text": "```ts\nif (!WebSocketFactory.isWebSocketSupported()) {\n console.error('WebSockets are required for this script.')\n process.exitCode = 1\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 79, - "character": 11 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [3421, 3427] - } - ], - "categories": [ - { - "title": "Realtime", - "children": [3421, 3427] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 44, - "character": 21 - } - ] - }, - { - "id": 1750, - "name": "AdminUserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1752, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's application specific metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.app_metadata`" - }, - { - "kind": "text", - "text": " column.\n\nOnly a service role can modify.\n\nThe " - }, - { - "kind": "code", - "text": "`app_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 432, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1755, - "name": "ban_duration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 455, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1763, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 385, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.current_password" - } - }, - { - "id": 1760, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 389, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.email" - } - }, - { - "id": 1753, - "name": "email_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's email as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 438, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1758, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " for the user.\n\nAllows you to overwrite the default " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " set for the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 477, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1759, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 403, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.nonce" - } - }, - { - "id": 1761, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.password" - } - }, - { - "id": 1757, - "name": "password_hash", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`password_hash`" - }, - { - "kind": "text", - "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 471, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1762, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 393, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.phone" - } - }, - { - "id": 1754, - "name": "phone_confirm", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets the user's phone as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 444, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1756, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " - }, - { - "kind": "code", - "text": "`authenticated`" - }, - { - "kind": "text", - "text": " by default. You should only modify the " - }, - { - "kind": "code", - "text": "`role`" - }, - { - "kind": "text", - "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " is not recommended as it grants the user admin privileges." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 463, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1751, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\n\nThe " - }, - { - "kind": "code", - "text": "`user_metadata`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 423, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1752, 1755, 1763, 1760, 1753, 1758, 1759, 1761, 1757, 1762, 1754, 1756, 1751 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 412, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1743, - "name": "UserAttributes", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "data" - } - ], - "name": "Omit", - "package": "typescript" - } - ] - }, - { - "id": 1707, - "name": "AMREntry", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An authentication method reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time.\n\nNote: Custom access token hooks can return AMR claims as either:\n- An array of AMREntry objects (detailed format with timestamps)\n- An array of strings (RFC-8176 compliant format)" - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 2079 - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "children": [ - { - "id": 1708, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication method name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 282, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1705, - "name": "AMRMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 1709, - "name": "timestamp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 287, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1708, 1709] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 280, - "character": 17 - } - ] - }, - { - "id": 2392, - "name": "AuthOAuthServerApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth 2.1 authorization server user-facing methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThese methods are used to implement the consent page." - } - ] - }, - "children": [ - { - "id": 2396, - "name": "approveAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 4 - } - ], - "signatures": [ - { - "id": 2397, - "name": "approveAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Approves an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter approval, the user's consent is stored and an authorization code is generated.\nThe response contains a complete redirect URL with the authorization code and state." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with authorization code" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 4 - } - ], - "parameters": [ - { - "id": 2398, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to approve" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2399, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2400, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2401, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2265, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2401] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2264, - "character": 60 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2383, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2402, - "name": "denyAuthorization", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 4 - } - ], - "signatures": [ - { - "id": 2403, - "name": "denyAuthorization", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Denies an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter denial, the response contains a redirect URL with an OAuth error\n(access_denied) to inform the OAuth client that the user rejected the request." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Redirect URL to send the user back to the OAuth client with error information" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 4 - } - ], - "parameters": [ - { - "id": 2404, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID to deny" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2405, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional parameters" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2406, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2407, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2283, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2407] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2282, - "character": 57 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2383, - "name": "AuthOAuthConsentResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2393, - "name": "getAuthorizationDetails", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2248, - "character": 4 - } - ], - "signatures": [ - { - "id": 2394, - "name": "getAuthorizationDetails", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves details about an OAuth authorization request.\nUsed to display consent information to the user.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis method returns one of two response types:\n- " - }, - { - "kind": "code", - "text": "`OAuthAuthorizationDetails`" - }, - { - "kind": "text", - "text": ": User needs to consent - show consent page with client info\n- " - }, - { - "kind": "code", - "text": "`OAuthRedirect`" - }, - { - "kind": "text", - "text": ": User already consented - redirect immediately to the OAuth client\n\nUse type narrowing to distinguish between the responses:\n" - }, - { - "kind": "code", - "text": "```typescript\nif ('authorization_id' in data) {\n // Show consent page\n} else {\n // Redirect to data.redirect_url\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Authorization details or redirect URL depending on consent status" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2248, - "character": 4 - } - ], - "parameters": [ - { - "id": 2395, - "name": "authorizationId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID from the authorization request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2382, - "name": "AuthOAuthAuthorizationDetailsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2408, - "name": "listGrants", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2294, - "character": 4 - } - ], - "signatures": [ - { - "id": 2409, - "name": "listGrants", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth grants that the authenticated user has authorized.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Response with array of OAuth grants with client information and granted scopes" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2294, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2389, - "name": "AuthOAuthGrantsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2410, - "name": "revokeGrant", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 4 - } - ], - "signatures": [ - { - "id": 2411, - "name": "revokeGrant", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revokes a user's OAuth grant for a specific client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\nand invalidates associated refresh tokens." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Empty response on successful revocation" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Server" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 4 - } - ], - "parameters": [ - { - "id": 2412, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Revocation options" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2414, - "name": "clientId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client identifier (UUID) to revoke access for" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2310, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2414] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2309, - "character": 25 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2390, - "name": "AuthOAuthRevokeGrantResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2396, 2402, 2393, 2408, 2410] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2396, 2402, 2393, 2408, 2410] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2223, - "character": 17 - } - ] - }, - { - "id": 2492, - "name": "AuthPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lower-level two-step API and management methods for passkeys.\nAccess via " - }, - { - "kind": "code", - "text": "`supabase.auth.passkey`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "children": [ - { - "id": 2509, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2464, - "character": 4 - } - ], - "signatures": [ - { - "id": 2510, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a passkey for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2464, - "character": 4 - } - ], - "parameters": [ - { - "id": 2511, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2472, - "name": "PasskeyDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2484, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2504, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2450, - "character": 4 - } - ], - "signatures": [ - { - "id": 2505, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for the currently signed-in user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2450, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2482, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2498, - "name": "startAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2435, - "character": 4 - } - ], - "signatures": [ - { - "id": 2499, - "name": "startAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey authentication ceremony. Fetches an authentication\nchallenge and credential request options from the server. Used as the\nfirst step of a two-step sign-in flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.get()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2435, - "character": 4 - } - ], - "parameters": [ - { - "id": 2500, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2459, - "name": "StartPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2477, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2493, - "name": "startRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2417, - "character": 4 - } - ], - "signatures": [ - { - "id": 2494, - "name": "startRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the passkey registration ceremony. Fetches a registration challenge\nand credential creation options from the server. Used as the first step of\na two-step registration flow when the caller wants to handle\n" - }, - { - "kind": "code", - "text": "`navigator.credentials.create()`" - }, - { - "kind": "text", - "text": " themselves." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2417, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2475, - "name": "AuthPasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2506, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2457, - "character": 4 - } - ], - "signatures": [ - { - "id": 2507, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a passkey's friendly name." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2457, - "character": 4 - } - ], - "parameters": [ - { - "id": 2508, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2468, - "name": "PasskeyUpdateParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2483, - "name": "AuthPasskeyUpdateResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2501, - "name": "verifyAuthentication", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2443, - "character": 4 - } - ], - "signatures": [ - { - "id": 2502, - "name": "verifyAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey authentication credential against a previously issued\nchallenge. Used as the second step of a two-step sign-in flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2443, - "character": 4 - } - ], - "parameters": [ - { - "id": 2503, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2464, - "name": "VerifyPasskeyAuthenticationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2495, - "name": "verifyRegistration", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2425, - "character": 4 - } - ], - "signatures": [ - { - "id": 2496, - "name": "verifyRegistration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a passkey registration credential against a previously issued\nchallenge. Used as the second step of a two-step registration flow." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Passkey" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2425, - "character": 4 - } - ], - "parameters": [ - { - "id": 2497, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2455, - "name": "VerifyPasskeyRegistrationParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2509, 2504, 2498, 2493, 2506, 2501, 2495] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2509, 2504, 2498, 2493, 2506, 2501, 2495] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2407, - "character": 17 - } - ] - }, - { - "id": 42, - "name": "AuthSession", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 45, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 247, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A timestamp of when the token will expire. Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 259, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 47, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 255, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 44, - "name": "provider_refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 243, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 43, - "name": "provider_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 238, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 46, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A one-time used refresh token that never expires." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 251, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 49, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 260, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 50, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When using a separate user storage, accessing properties of this object will throw an error." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 264, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [45, 48, 47, 44, 43, 46, 49, 50] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 234, - "character": 17 - } - ] - }, - { - "id": 15, - "name": "AuthUser", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 26, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 360, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 17, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 351, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1734, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 19, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 353, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 41, - "name": "banned_until", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 375, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 20, - "name": "confirmation_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 354, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 30, - "name": "confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 364, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 29, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 363, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 40, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 374, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 27, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 361, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 22, - "name": "email_change_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 356, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 31, - "name": "email_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 365, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 39, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 373, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "webauthn" - }, - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - } - ] - }, - { - "type": "literal", - "value": "unverified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - ] - } - } - }, - { - "id": 16, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 350, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "identities", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 370, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1710, - "name": "UserIdentity", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 25, - "name": "invited_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 359, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 37, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 371, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 38, - "name": "is_sso_user", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 372, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 33, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 367, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 23, - "name": "new_email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 357, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 24, - "name": "new_phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 358, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 28, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 362, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 32, - "name": "phone_confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 366, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 21, - "name": "recovery_sent_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 355, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 34, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 368, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 35, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 369, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 18, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 352, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1739, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 26, 17, 19, 41, 20, 30, 29, 40, 27, 22, 31, 39, 16, 36, 25, 37, 38, 33, 23, 24, 28, - 32, 21, 34, 35, 18 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 349, - "character": 17 - } - ] - }, - { - "id": 1961, - "name": "GenerateLinkOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1962, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 776, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1963, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL which will be appended to the email link generated." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 778, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1962, 1963] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 770, - "character": 17 - } - ] - }, - { - "id": 2343, - "name": "GoTrueAdminCustomProvidersApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all custom OIDC/OAuth provider administration methods." - } - ] - }, - "children": [ - { - "id": 2347, - "name": "createProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2071, - "character": 4 - } - ], - "signatures": [ - { - "id": 2348, - "name": "createProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new custom OIDC/OAuth provider.\n\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\nfrom the issuer's well-known endpoint (or the provided " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": ") at creation time.\nThis may return a validation error (" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\nin the document does not match the expected issuer.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2071, - "character": 4 - } - ], - "parameters": [ - { - "id": 2349, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2288, - "name": "CreateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2357, - "name": "deleteProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 4 - } - ], - "signatures": [ - { - "id": 2358, - "name": "deleteProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a custom provider.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 4 - } - ], - "parameters": [ - { - "id": 2359, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2360, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2361, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2104, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2362, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2105, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2361, 2362] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2103, - "character": 48 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2350, - "name": "getProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2080, - "character": 4 - } - ], - "signatures": [ - { - "id": 2351, - "name": "getProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific custom provider by identifier.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2080, - "character": 4 - } - ], - "parameters": [ - { - "id": 2352, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2344, - "name": "listProviders", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2056, - "character": 4 - } - ], - "signatures": [ - { - "id": 2345, - "name": "listProviders", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all custom providers with optional type filter.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2056, - "character": 4 - } - ], - "parameters": [ - { - "id": 2346, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2328, - "name": "ListCustomProvidersParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2332, - "name": "CustomProviderListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2353, - "name": "updateProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2094, - "character": 4 - } - ], - "signatures": [ - { - "id": 2354, - "name": "updateProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing custom provider.\n\nWhen " - }, - { - "kind": "code", - "text": "`issuer`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`discovery_url`" - }, - { - "kind": "text", - "text": " is changed on an OIDC provider, the server re-fetches and\nvalidates the discovery document before persisting. This may return a validation error\n(" - }, - { - "kind": "code", - "text": "`error_code: \"validation_failed\"`" - }, - { - "kind": "text", - "text": ") if the discovery document is unreachable, invalid, or\nthe issuer does not match.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2094, - "character": 4 - } - ], - "parameters": [ - { - "id": 2355, - "name": "identifier", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2356, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2309, - "name": "UpdateCustomProviderParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2331, - "name": "CustomProviderResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2347, 2357, 2350, 2344, 2353] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2347, 2357, 2350, 2344, 2353] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2047, - "character": 17 - } - ] - }, - { - "id": 2096, - "name": "GoTrueAdminMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication administration API." - } - ], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "children": [ - { - "id": 2100, - "name": "deleteFactor", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1511, - "character": 4 - } - ], - "signatures": [ - { - "id": 2101, - "name": "deleteFactor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#unenroll", - "target": 2071 - } - ] - }, - { - "tag": "@expermental", - "content": [] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "Delete a factor for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Delete a factor for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1511, - "character": 4 - } - ], - "parameters": [ - { - "id": 2102, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2086, - "name": "AuthMFAAdminDeleteFactorParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2083, - "name": "AuthMFAAdminDeleteFactorResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2097, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1481, - "character": 4 - } - ], - "signatures": [ - { - "id": 2098, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all factors associated to a user." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth Admin" - } - ] - }, - { - "tag": "@example", - "name": "List all factors for a user", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "List all factors for a user\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n factors: Factor[\n {\n id: '',\n friendly_name: 'Auth App Factor',\n factor_type: 'totp',\n status: 'verified',\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z'\n }\n ]\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1481, - "character": 4 - } - ], - "parameters": [ - { - "id": 2099, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2093, - "name": "AuthMFAAdminListFactorsParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2090, - "name": "AuthMFAAdminListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2100, 2097] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2100, 2097] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1449, - "character": 17 - } - ] - }, - { - "id": 2228, - "name": "GoTrueAdminOAuthApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "children": [ - { - "id": 2232, - "name": "createClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1810, - "character": 4 - } - ], - "signatures": [ - { - "id": 2233, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1810, - "character": 4 - } - ], - "parameters": [ - { - "id": 2234, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2198, - "name": "CreateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2242, - "name": "deleteClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 4 - } - ], - "signatures": [ - { - "id": 2243, - "name": "deleteClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 4 - } - ], - "parameters": [ - { - "id": 2244, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2245, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2246, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1841, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2247, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1842, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2246, 2247] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1840, - "character": 44 - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2235, - "name": "getClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1820, - "character": 4 - } - ], - "signatures": [ - { - "id": 2236, - "name": "getClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets details of a specific OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1820, - "character": 4 - } - ], - "parameters": [ - { - "id": 2237, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2229, - "name": "listClients", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1800, - "character": 4 - } - ], - "signatures": [ - { - "id": 2230, - "name": "listClients", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all OAuth clients with optional pagination.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1800, - "character": 4 - } - ], - "parameters": [ - { - "id": 2231, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 2117, - "name": "PageParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2216, - "name": "OAuthClientListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2248, - "name": "regenerateClientSecret", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1853, - "character": 4 - } - ], - "signatures": [ - { - "id": 2249, - "name": "regenerateClientSecret", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Regenerates the secret for an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1853, - "character": 4 - } - ], - "parameters": [ - { - "id": 2250, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2238, - "name": "updateClient", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1830, - "character": 4 - } - ], - "signatures": [ - { - "id": 2239, - "name": "updateClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates an existing OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "OAuth Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1830, - "character": 4 - } - ], - "parameters": [ - { - "id": 2240, - "name": "clientId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2241, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2207, - "name": "UpdateOAuthClientParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2215, - "name": "OAuthClientResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2232, 2242, 2235, 2229, 2248, 2238] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2232, 2242, 2235, 2229, 2248, 2238] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1790, - "character": 17 - } - ] - }, - { - "id": 2512, - "name": "GoTrueAdminPasskeyApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2516, - "name": "deletePasskey", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2484, - "character": 4 - } - ], - "signatures": [ - { - "id": 2517, - "name": "deletePasskey", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a specific passkey for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2484, - "character": 4 - } - ], - "parameters": [ - { - "id": 2518, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2488, - "name": "AuthPasskeyAdminDeleteParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2484, - "name": "AuthPasskeyDeleteResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2513, - "name": "listPasskeys", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2475, - "character": 4 - } - ], - "signatures": [ - { - "id": 2514, - "name": "listPasskeys", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all passkeys registered for a specific user.\n\nThis function should only be called on a server. Never expose your " - }, - { - "kind": "code", - "text": "`service_role`" - }, - { - "kind": "text", - "text": " key in the browser." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Passkey Admin" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2475, - "character": 4 - } - ], - "parameters": [ - { - "id": 2515, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2485, - "name": "AuthPasskeyAdminListParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2482, - "name": "AuthPasskeyListResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [2516, 2513] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2516, 2513] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2466, - "character": 17 - } - ] - }, - { - "id": 2025, - "name": "GoTrueMFAApi", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Contains the full multi-factor authentication API." - } - ] - }, - "children": [ - { - "id": 2082, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1412, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "WebAuthnApi" - }, - "name": "WebAuthnApi", - "package": "@supabase/auth-js" - } - }, - { - "id": 2035, - "name": "challenge", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1154, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1155, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1156, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1157, - "character": 4 - } - ], - "signatures": [ - { - "id": 2036, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- A phone factor sends a code to the user upon challenge. The channel defaults to " - }, - { - "kind": "code", - "text": "`sms`" - }, - { - "kind": "text", - "text": " unless otherwise specified." - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Create a challenge for a phone factor (WhatsApp)", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n channel: 'whatsapp',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create a challenge for a phone factor (WhatsApp)\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n expires_at: 1700000000\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1154, - "character": 4 - } - ], - "parameters": [ - { - "id": 2037, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2039, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2040, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2039, 2040] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2041, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2042, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 2043, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2042, 2043] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2044, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1155, - "character": 4 - } - ], - "parameters": [ - { - "id": 2045, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1992, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2046, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2047, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2048, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2047, 2048] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2050, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 2051, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2050, 2051] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2052, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1156, - "character": 4 - } - ], - "parameters": [ - { - "id": 2053, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1993, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2054, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2055, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 2056, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2055, 2056] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2057, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2058, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2059, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2058, 2059] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 51 - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2060, - "name": "challenge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1157, - "character": 4 - } - ], - "parameters": [ - { - "id": 2061, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1994, - "name": "MFAChallengeParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2013, - "name": "AuthMFAChallengeResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2074, - "name": "challengeAndVerify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1346, - "character": 4 - } - ], - "signatures": [ - { - "id": 2075, - "name": "challengeAndVerify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Intended for use with only TOTP factors.\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking " - }, - { - "kind": "code", - "text": "`challengeAndVerify()`" - }, - { - "kind": "text", - "text": ".\n- Executes [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge) and [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify) in a single step." - } - ] - }, - { - "tag": "@example", - "name": "Create and verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Create and verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1346, - "character": 4 - } - ], - "parameters": [ - { - "id": 2076, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2026, - "name": "enroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1081, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1082, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1083, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1084, - "character": 4 - } - ], - "signatures": [ - { - "id": 2027, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Use " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " as the " - }, - { - "kind": "code", - "text": "`factorType`" - }, - { - "kind": "text", - "text": " and use the returned " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " to create a challenge.\n- To create a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.challenge()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challenge).\n- To verify a challenge, see [" - }, - { - "kind": "code", - "text": "`mfa.verify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-verify).\n- To create and verify a TOTP challenge in a single step, see [" - }, - { - "kind": "code", - "text": "`mfa.challengeAndVerify()`" - }, - { - "kind": "text", - "text": "](/docs/reference/javascript/auth-mfa-challengeandverify).\n- To generate a QR code for the " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " secret in Next.js, you can do the following:\n" - }, - { - "kind": "code", - "text": "```html\n{data.totp.uri}\n```" - }, - { - "kind": "text", - "text": "\n- The " - }, - { - "kind": "code", - "text": "`challenge`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`verify`" - }, - { - "kind": "text", - "text": " steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge." - } - ] - }, - { - "tag": "@example", - "name": "Enroll a time-based, one-time password (TOTP) factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'totp',\n friendlyName: 'your_friendly_name'\n})\n\n// Use the id to create a challenge.\n// The challenge can be verified by entering the code generated from the authenticator app.\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a time-based, one-time password (TOTP) factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'totp'\n totp: {\n qr_code: '',\n secret: '',\n uri: '',\n }\n friendly_name?: 'Important app'\n },\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Enroll a Phone Factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'phone',\n friendlyName: 'your_friendly_name',\n phone: '+12345678',\n})\n\n// Use the id to create a challenge and send an SMS with a code to the user.\nconst { id, type, friendly_name, phone } = data\n\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Enroll a Phone Factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n friendly_name?: 'Important app',\n phone: '+5787123456'\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1081, - "character": 4 - } - ], - "parameters": [ - { - "id": 2028, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2124, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2029, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1082, - "character": 4 - } - ], - "parameters": [ - { - "id": 2030, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2125, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2031, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1083, - "character": 4 - } - ], - "parameters": [ - { - "id": 2032, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2033, - "name": "enroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1084, - "character": 4 - } - ], - "parameters": [ - { - "id": 2034, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1977, - "name": "MFAEnrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2004, - "name": "AuthMFAEnrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2079, - "name": "getAuthenticatorAssuranceLevel", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1411, - "character": 4 - } - ], - "signatures": [ - { - "id": 2080, - "name": "getAuthenticatorAssuranceLevel", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " (or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\nand rarely uses the network. When a JWT is provided (useful in server-side\nenvironments like Edge Functions where no session is stored), this method\nwill make a network request to validate the user and fetch their MFA factors." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\n- In Supabase, having an AAL of " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": " refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\n- If the user has a verified factor, the " - }, - { - "kind": "code", - "text": "`nextLevel`" - }, - { - "kind": "text", - "text": " field will return " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": ", else, it will return " - }, - { - "kind": "code", - "text": "`aal1`" - }, - { - "kind": "text", - "text": ".\n- An optional " - }, - { - "kind": "code", - "text": "`jwt`" - }, - { - "kind": "text", - "text": " parameter can be passed to check the AAL level of a specific JWT instead of the current session." - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details of a session", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Get the AAL details of a session\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n currentLevel: 'aal1',\n nextLevel: 'aal2',\n currentAuthenticationMethods: [\n {\n method: 'password',\n timestamp: 1700000000\n }\n ]\n }\n error: null\n}\n```" - } - ] - }, - { - "tag": "@example", - "name": "Get the AAL details for a specific JWT", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1411, - "character": 4 - } - ], - "parameters": [ - { - "id": 2081, - "name": "jwt", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2020, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2077, - "name": "listFactors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1358, - "character": 4 - } - ], - "signatures": [ - { - "id": 2078, - "name": "listFactors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the list of MFA factors enabled for this user." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 2026 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", - "target": 2079 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient#getUser", - "target": 1377 - }, - { - "kind": "text", - "text": "\n" - } - ] - }, - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1358, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2014, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "totp" - }, - { - "type": "literal", - "value": "phone" - }, - { - "type": "literal", - "value": "webauthn" - } - ] - } - } - ], - "name": "AuthMFAListFactorsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2071, - "name": "unenroll", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1265, - "character": 4 - } - ], - "signatures": [ - { - "id": 2072, - "name": "unenroll", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unenroll removes a MFA factor.\nA user has to have an " - }, - { - "kind": "code", - "text": "`aal2`" - }, - { - "kind": "text", - "text": " authenticator level in order to unenroll a " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " factor." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@example", - "name": "Unenroll a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.unenroll({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Unenroll a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n id: ''\n },\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1265, - "character": 4 - } - ], - "parameters": [ - { - "id": 2073, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1978, - "name": "MFAUnenrollParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2005, - "name": "AuthMFAUnenrollResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2062, - "name": "verify", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1237, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1238, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1239, - "character": 4 - }, - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1240, - "character": 4 - } - ], - "signatures": [ - { - "id": 2063, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." - } - ], - "blockTags": [ - { - "tag": "@category", - "content": [ - { - "kind": "text", - "text": "Auth" - } - ] - }, - { - "tag": "@subcategory", - "content": [ - { - "kind": "text", - "text": "Auth MFA" - } - ] - }, - { - "tag": "@remarks", - "content": [ - { - "kind": "text", - "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first." - } - ] - }, - { - "tag": "@example", - "name": "Verify a challenge for a factor", - "content": [ - { - "kind": "code", - "text": "```js\nconst { data, error } = await supabase.auth.mfa.verify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\n code: '123456'\n})\n```" - } - ] - }, - { - "tag": "@exampleResponse", - "content": [ - { - "kind": "text", - "text": "Verify a challenge for a factor\n" - }, - { - "kind": "code", - "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1237, - "character": 4 - } - ], - "parameters": [ - { - "id": 2064, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1981, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2065, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1238, - "character": 4 - } - ], - "parameters": [ - { - "id": 2066, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1982, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2067, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1239, - "character": 4 - } - ], - "parameters": [ - { - "id": 2068, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1987, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 2069, - "name": "verify", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1240, - "character": 4 - } - ], - "parameters": [ - { - "id": 2070, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1989, - "name": "MFAVerifyParams", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2003, - "name": "AuthMFAVerifyResponse", - "package": "@supabase/auth-js" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [2082] - }, - { - "title": "Methods", - "children": [2035, 2074, 2026, 2079, 2077, 2071, 2062] - } - ], - "categories": [ - { - "title": "Auth", - "children": [2035, 2074, 2026, 2079, 2077, 2071, 2062] - }, - { - "title": "Other", - "children": [2082] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 999, - "character": 17 - } - ] - }, - { - "id": 2166, - "name": "JWK", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2170, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1661, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2169, - "name": "key_ops", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1660, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2171, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1662, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2167, - "name": "kty", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1659, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2168, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ] - }, - { - "type": "literal", - "value": "RSA" - }, - { - "type": "literal", - "value": "EC" - }, - { - "type": "literal", - "value": "oct" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2170, 2169, 2171, 2167] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1658, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2172, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1663, - "character": 4 - } - ], - "parameters": [ - { - "id": 2173, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 2146, - "name": "JwtPayload", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWT Payload containing claims for Supabase authentication tokens.\n\nRequired claims (iss, aud, exp, iat, sub, role, aal, session_id) are inherited from RequiredClaims.\nAll other claims are optional as they can be customized via Custom Access Token Hooks." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://supabase.com/docs/guides/auth/jwt-fields" - } - ] - } - ] - }, - "children": [ - { - "id": 2162, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1629, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aal" - } - }, - { - "id": 2154, - "name": "amr", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Authentication Method References.\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1654, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1707, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - } - ] - } - }, - { - "id": 2152, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1646, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1734, - "name": "UserAppMetadata", - "package": "@supabase/auth-js" - } - }, - { - "id": 2158, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1625, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.aud" - } - }, - { - "id": 2147, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1641, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2159, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1626, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.exp" - } - }, - { - "id": 2160, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1627, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iat" - } - }, - { - "id": 2149, - "name": "is_anonymous", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1643, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2156, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1623, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.iss" - } - }, - { - "id": 2150, - "name": "jti", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1644, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2151, - "name": "nbf", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1645, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2148, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1642, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2155, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1655, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2161, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1628, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.role" - } - }, - { - "id": 2163, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.session_id" - } - }, - { - "id": 2157, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1624, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "RequiredClaims.sub" - } - }, - { - "id": 2153, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1647, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1739, - "name": "UserMetadata", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2162, 2154, 2152, 2158, 2147, 2159, 2160, 2149, 2156, 2150, 2151, 2148, 2155, 2161, - 2163, 2157, 2153 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1640, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 2164, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1656, - "character": 4 - } - ], - "parameters": [ - { - "id": 2165, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2136, - "name": "RequiredClaims", - "package": "@supabase/auth-js" - } - ] - }, - { - "id": 1764, - "name": "Subscription", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1766, - "name": "callback", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The function to call every time there is an event. eg: (eventName) => {}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1767, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 14 - } - ], - "signatures": [ - { - "id": 1768, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 489, - "character": 14 - } - ], - "parameters": [ - { - "id": 1769, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1589, - "name": "AuthChangeEvent", - "package": "@supabase/auth-js" - } - }, - { - "id": 1770, - "name": "session", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 1765, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier for this subscription, set by the client.\nThis is an internal identifier used for managing callbacks and should not be\nrelied upon by application code. Use the unsubscribe() method to remove listeners." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 485, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1771, - "name": "unsubscribe", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Call this to remove the listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1772, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 17 - } - ], - "signatures": [ - { - "id": 1773, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 493, - "character": 17 - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1766, 1765, 1771] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 479, - "character": 17 - } - ] - }, - { - "id": 1112, - "name": "TracePropagationOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for trace context propagation.\n\nEnables distributed tracing across Supabase services using W3C Trace Context\nand OpenTelemetry standards. When enabled, the SDK automatically attaches\ntrace context headers (" - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": ") to outgoing\nrequests to Supabase domains. The resulting " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " appears in API\nGateway and Edge Function logs, so logs forwarded through Log Drains can\nbe correlated back to the originating client-side span.\n\nRequires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be installed in the consuming application.\nIf it is not installed, or there is no active context at request time,\npropagation silently no-ops." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Enable with defaults", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true },\n})\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://www.w3.org/TR/trace-context/" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://opentelemetry.io/docs/concepts/context-propagation/" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://supabase.com/docs/guides/telemetry/client-side-tracing" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "children": [ - { - "id": 1113, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable trace propagation. Disabled by default.\n\nWhen enabled, automatically detects and propagates active trace context\nfrom the OpenTelemetry API to outgoing Supabase requests. Trace context\nis only propagated to Supabase domains (" - }, - { - "kind": "code", - "text": "`*.supabase.co`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`*.supabase.in`" - }, - { - "kind": "text", - "text": ",\n" - }, - { - "kind": "code", - "text": "`localhost`" - }, - { - "kind": "text", - "text": ") for security — third-party hosts never receive trace headers." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 71, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L71" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1114, - "name": "respectSamplingDecision", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Respect upstream sampling decisions.\n\nWhen true (the default), trace context is not propagated if the upstream\ntrace indicates non-sampling (sampled flag = " - }, - { - "kind": "code", - "text": "`0`" - }, - { - "kind": "text", - "text": " in the " - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": "\nheader). This avoids overhead when traces are being recorded but dropped.\n\nSet to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " to always propagate, regardless of the sampling decision\n— useful when you want every Supabase request tagged with a " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": "\nfor log correlation, even if the trace itself will not be exported." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\ntrue\n```" - } - ] - }, - { - "tag": "@example", - "name": "Always propagate, ignore sampling", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 93, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L93" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1113, 1114] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 53, - "character": 17, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L53" - } - ] - }, - { - "id": 1734, - "name": "UserAppMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1735, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The first provider that the user used to sign up with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 339, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1736, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all providers that the user has linked to their account." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 343, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1735, 1736] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 335, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 1737, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 344, - "character": 4 - } - ], - "parameters": [ - { - "id": 1738, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1743, - "name": "UserAttributes", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1744, - "name": "current_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 385, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1749, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 410, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1745, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 389, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1748, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 403, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1747, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1746, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 393, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1744, 1749, 1745, 1748, 1747, 1746] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 377, - "character": 17 - } - ] - }, - { - "id": 1710, - "name": "UserIdentity", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1719, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 297, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1711, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 290, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1713, - "name": "identity_data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 292, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1714, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 292, - "character": 20 - } - ], - "indexSignatures": [ - { - "id": 1715, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 293, - "character": 8 - } - ], - "parameters": [ - { - "id": 1716, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 1717, - "name": "identity_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 295, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1720, - "name": "last_sign_in_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 298, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1718, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 296, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1721, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 299, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1712, - "name": "user_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 291, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1719, 1711, 1713, 1717, 1720, 1718, 1721, 1712] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 289, - "character": 17 - } - ] - }, - { - "id": 1739, - "name": "UserMetadata", - "variant": "declaration", - "kind": 256, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 346, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 1740, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 347, - "character": 4 - } - ], - "parameters": [ - { - "id": 1741, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1895, - "name": "VerifyEmailOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1896, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 671, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1899, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 676, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1900, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1902, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 683, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1901, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 678, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1902, 1901] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 676, - "character": 14 - } - ] - } - } - }, - { - "id": 1897, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 673, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1898, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 675, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1896, 1899, 1897, 1898] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 669, - "character": 17 - } - ] - }, - { - "id": 1887, - "name": "VerifyMobileOtpParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1891, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 658, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1892, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1894, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 666, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1893, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 660, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1894, 1893] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 658, - "character": 14 - } - ] - } - } - }, - { - "id": 1888, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 653, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1889, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The otp sent to the user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 655, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1890, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 657, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1906, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1891, 1888, 1889, 1890] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 651, - "character": 17 - } - ] - }, - { - "id": 1903, - "name": "VerifyTokenHashParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1904, - "name": "token_hash", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token hash used in an email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 688, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1905, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's verification type." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 690, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1904, 1905] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 686, - "character": 17 - } - ] - }, - { - "id": 3431, - "name": "WebSocketLike", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3474, - "name": "binaryType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3475, - "name": "bufferedAmount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3435, - "name": "CLOSED", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 5, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3434, - "name": "CLOSING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 4, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3432, - "name": "CONNECTING", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 2, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3477, - "name": "dispatchEvent", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3478, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 20 - } - ], - "signatures": [ - { - "id": 3479, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 32, - "character": 20 - } - ], - "parameters": [ - { - "id": 3480, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - }, - { - "id": 3476, - "name": "extensions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3456, - "name": "onclose", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3457, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 14 - } - ], - "signatures": [ - { - "id": 3458, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 19, - "character": 14 - } - ], - "parameters": [ - { - "id": 3459, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3460, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "CloseEvent" - }, - "name": "CloseEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3461, - "name": "onerror", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 14 - } - ], - "signatures": [ - { - "id": 3463, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 20, - "character": 14 - } - ], - "parameters": [ - { - "id": 3464, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3465, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3451, - "name": "onmessage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3452, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 16 - } - ], - "signatures": [ - { - "id": 3453, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 18, - "character": 16 - } - ], - "parameters": [ - { - "id": 3454, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3455, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "MessageEvent" - }, - "name": "MessageEvent", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3446, - "name": "onopen", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reflection", - "declaration": { - "id": 3447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 13 - } - ], - "signatures": [ - { - "id": 3448, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 17, - "character": 13 - } - ], - "parameters": [ - { - "id": 3449, - "name": "this", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3450, - "name": "ev", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 3433, - "name": "OPEN", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 3, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3438, - "name": "protocol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 8, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3436, - "name": "readyState", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 6, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3437, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 7, - "character": 13 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3466, - "name": "addEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 24, - "character": 4 - } - ], - "signatures": [ - { - "id": 3467, - "name": "addEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registers an event listener on the socket (compatible with browser WebSocket API)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 3468, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3469, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3439, - "name": "close", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 12, - "character": 4 - } - ], - "signatures": [ - { - "id": 3440, - "name": "close", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Closes the socket, optionally providing a close code and reason." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 12, - "character": 4 - } - ], - "parameters": [ - { - "id": 3441, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3442, - "name": "reason", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3470, - "name": "removeEventListener", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 28, - "character": 4 - } - ], - "signatures": [ - { - "id": 3471, - "name": "removeEventListener", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes a previously registered event listener." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 28, - "character": 4 - } - ], - "parameters": [ - { - "id": 3472, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3473, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventListener" - }, - "name": "EventListener", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 3443, - "name": "send", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 16, - "character": 4 - } - ], - "signatures": [ - { - "id": 3444, - "name": "send", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sends data through the socket using the underlying implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 16, - "character": 4 - } - ], - "parameters": [ - { - "id": 3445, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferView" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "ArrayBufferView", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3474, 3475, 3435, 3434, 3432, 3477, 3476, 3456, 3461, 3451, 3446, 3433, 3438, 3436, - 3437 - ] - }, - { - "title": "Methods", - "children": [3466, 3439, 3470, 3443] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/lib/websocket-factory.d.ts", - "line": 1, - "character": 17 - } - ] - }, - { - "id": 3481, - "name": "WebSocketLikeConstructor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal WebSocket constructor interface that RealtimeClient can work with.\nSupply a compatible implementation (native WebSocket, " - }, - { - "kind": "code", - "text": "`ws`" - }, - { - "kind": "text", - "text": ", etc) when running outside the browser." - } - ] - }, - "children": [ - { - "id": 3482, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 22, - "character": 17 - } - ], - "signatures": [ - { - "id": 3483, - "name": "WebSocketLikeConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 23, - "character": 4 - } - ], - "parameters": [ - { - "id": 3484, - "name": "address", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - ] - } - }, - { - "id": 3485, - "name": "subprotocols", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": 3431, - "name": "WebSocketLike", - "package": "@supabase/realtime-js" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [3482] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 22, - "character": 17 - } - ], - "indexSignatures": [ - { - "id": 3486, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 24, - "character": 4 - } - ], - "parameters": [ - { - "id": 3487, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - }, - { - "id": 1705, - "name": "AMRMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 267, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMRMethods" - }, - "name": "AMRMethods", - "package": "@supabase/auth-js", - "preferValues": true - } - } - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1706, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 267, - "character": 64 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1589, - "name": "AuthChangeEvent", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "INITIAL_SESSION" - }, - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "reference", - "target": 1588, - "name": "AuthChangeEventMFA", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1588, - "name": "AuthChangeEventMFA", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 14, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "MFA_CHALLENGE_VERIFIED" - } - }, - { - "id": 2018, - "name": "AuthenticatorAssuranceLevels", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 973, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "aal1" - }, - { - "type": "literal", - "value": "aal2" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2019, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 973, - "character": 71 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1810, - "name": "AuthFlowType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 562, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "implicit" - }, - { - "type": "literal", - "value": "pkce" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1811, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 562, - "character": 59 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2086, - "name": "AuthMFAAdminDeleteFactorParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1424, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2087, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2088, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the MFA factor to delete." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1426, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2089, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user whose factor is being deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1428, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2088, 2089] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1424, - "character": 45 - } - ] - } - } - }, - { - "id": 2083, - "name": "AuthMFAAdminDeleteFactorResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1417, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2084, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2085, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully deleted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1419, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2085] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1417, - "character": 61 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2093, - "name": "AuthMFAAdminListFactorsParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1440, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2094, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2095, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1442, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2095] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1440, - "character": 44 - } - ] - } - } - }, - { - "id": 2090, - "name": "AuthMFAAdminListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@expermental", - "content": [] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1433, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2091, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2092, - "name": "factors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All factors attached to the user." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1435, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2092] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1433, - "character": 60 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2009, - "name": "AuthMFAChallengePhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 922, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponseFields" - }, - "name": "AuthMFAChallengePhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2013, - "name": "AuthMFAChallengeResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 965, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2008, - "name": "AuthMFAChallengeTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2009, - "name": "AuthMFAChallengePhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2010, - "name": "AuthMFAChallengeWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2008, - "name": "AuthMFAChallengeTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 920, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponseFields" - }, - "name": "AuthMFAChallengeTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2010, - "name": "AuthMFAChallengeWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn MFA challenge.\nContains credential creation or request options from the server." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Credential Creation", - "target": "https://w3c.github.io/webauthn/#sctn-credential-creation" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 941, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" - }, - "name": "AuthMFAChallengeWebauthnResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2011, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable version of WebAuthn challenge response.\nUsed for server communication with base64url-encoded binary fields." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 959, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAChallengeResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseFieldsJSON" - }, - "name": "AuthMFAChallengeWebauthnResponseFieldsJSON", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2012, - "name": "AuthMFAChallengeWebauthnServerResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Server response type for WebAuthn MFA challenge.\nContains JSON-formatted WebAuthn options ready for browser API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 964, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2011, - "name": "AuthMFAChallengeWebauthnResponseDataJSON", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1609, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponseFields" - }, - "name": "AuthMFAEnrollPhoneResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2004, - "name": "AuthMFAEnrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 906, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2128, - "name": "AuthMFAEnrollPhoneResponse", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2127, - "name": "AuthMFAEnrollTOTPResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1604, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponseFields" - }, - "name": "AuthMFAEnrollTOTPResponseFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2129, - "name": "AuthMFAEnrollWebauthnResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for WebAuthn factor enrollment.\nReturns the enrolled factor ID and metadata." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1616, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponseBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "AuthMFAEnrollResponseBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnFields" - }, - "name": "AuthMFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2020, - "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 974, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2021, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2024, - "name": "currentAuthenticationMethods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario.\n\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 993, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1707, - "name": "AMREntry", - "package": "@supabase/auth-js" - } - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2022, - "name": "currentLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Current AAL level of the session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 976, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2023, - "name": "nextLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#challenge", - "target": 2035 - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 983, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2024, 2022, 2023] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 974, - "character": 74 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2014, - "name": "AuthMFAListFactorsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "response of ListFactors, which should contain all the types of factors that are available, this ensures we always include all" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 967, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 2017, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - }, - "default": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2015, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2016, - "name": "all", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All available factors (verified and unverified)." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 969, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2016] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 967, - "character": 106 - } - ] - } - }, - { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "reference", - "target": 2017, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1723, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "verified" - } - ], - "name": "Factor", - "package": "@supabase/auth-js" - } - } - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2005, - "name": "AuthMFAUnenrollResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 907, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2006, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2007, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor that was successfully unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 909, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2007] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 907, - "character": 52 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2003, - "name": "AuthMFAVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for MFA verification operations.\nReturns session tokens on successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 905, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 1996, - "name": "AuthMFAVerifyResponseData", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1996, - "name": "AuthMFAVerifyResponseData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data returned after successful MFA verification.\nContains new session tokens and updated user information." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 889, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1997, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1998, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New access token (JWT) after successful verification." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 891, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2000, - "name": "expires_in", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of seconds in which the access token will expire." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 895, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2001, - "name": "refresh_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Refresh token you can use to obtain new access tokens when expired." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 897, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1999, - "name": "token_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of token, always " - }, - { - "kind": "code", - "text": "`bearer`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 893, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "bearer" - } - }, - { - "id": 2002, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updated user profile." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 899, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1998, 2000, 2001, 1999, 2002] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 889, - "character": 40 - } - ] - } - } - }, - { - "id": 2382, - "name": "AuthOAuthAuthorizationDetailsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for getting OAuth authorization details.\nReturns either full authorization details (if consent needed) or redirect URL (if already consented).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```typescript\nconst { data, error } = await supabase.auth.oauth.getAuthorizationDetails(authorizationId)\n\nif (error) {\n console.error('Error:', error)\n} else if ('authorization_id' in data) {\n // User needs to provide consent - show consent page\n console.log('Client:', data.client.name)\n console.log('Scopes:', data.scope)\n console.log('Redirect URI:', data.redirect_uri)\n} else {\n // User already consented - redirect immediately\n window.location.href = data.redirect_url\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2189, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2369, - "name": "OAuthAuthorizationDetails", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2379, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2383, - "name": "AuthOAuthConsentResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth consent decision (approve/deny).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2194, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2379, - "name": "OAuthRedirect", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2389, - "name": "AuthOAuthGrantsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing user's OAuth grants.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2211, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 2384, - "name": "OAuthGrant", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2390, - "name": "AuthOAuthRevokeGrantResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for revoking an OAuth grant.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2216, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2216, - "character": 57 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1671, - "name": "AuthOtpResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "AuthOtpResponse is returned when OTP is used.\n\n" - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "AuthResponse" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 194, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1672, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1675, - "name": "messageId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 197, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1674, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 196, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1673, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 195, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1675, 1674, 1673] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 194, - "character": 59 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 2488, - "name": "AuthPasskeyAdminDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2399, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2489, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2491, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2401, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2490, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2400, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2491, 2490] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2399, - "character": 43 - } - ] - } - } - }, - { - "id": 2485, - "name": "AuthPasskeyAdminListParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2396, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2486, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2487, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2397, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2487] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2396, - "character": 41 - } - ] - } - } - }, - { - "id": 2477, - "name": "AuthPasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2388, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2429, - "name": "PasskeyAuthenticationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2478, - "name": "AuthPasskeyAuthenticationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2389, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 2479, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2480, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2390, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2481, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2391, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2480, 2481] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2389, - "character": 68 - } - ] - } - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2484, - "name": "AuthPasskeyDeleteResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2395, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "literal", - "value": null - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2482, - "name": "AuthPasskeyListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2393, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 2438, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2475, - "name": "AuthPasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2386, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2415, - "name": "PasskeyRegistrationOptionsResponse", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2476, - "name": "AuthPasskeyRegistrationVerifyResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2387, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2424, - "name": "PasskeyMetadata", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.errors.ts", - "qualifiedName": "WebAuthnError" - }, - "name": "WebAuthnError", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - ] - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2483, - "name": "AuthPasskeyUpdateResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2394, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2438, - "name": "PasskeyListItem", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 1662, - "name": "AuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 180, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1663, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1665, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 182, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1664, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 181, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1665, 1664] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 180, - "character": 56 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1666, - "name": "AuthResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 184, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1667, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1669, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 186, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1668, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 185, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1670, - "name": "weak_password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 187, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1636, - "name": "WeakPassword", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1669, 1668, 1670] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 184, - "character": 64 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1676, - "name": "AuthTokenResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 199, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1677, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1679, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 201, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1678, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 200, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1679, 1678] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 199, - "character": 61 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1680, - "name": "AuthTokenResponsePassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 203, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1681, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1683, - "name": "session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 205, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - }, - { - "id": 1682, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 204, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - }, - { - "id": 1684, - "name": "weakPassword", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 206, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1636, - "name": "WeakPassword", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1683, 1682, 1684] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 203, - "character": 69 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 2109, - "name": "CallRefreshTokenResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1531, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 42, - "name": "Session", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2288, - "name": "CreateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new custom provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1938, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2289, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2295, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1950, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2298, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1956, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2299, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1958, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2305, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1970, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2293, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1946, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2294, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1948, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2303, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1966, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2301, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1962, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2300, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1960, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2291, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1942, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2302, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1964, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2308, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1976, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2292, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1944, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2297, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1954, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2290, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1940, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2296, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1952, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2304, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1968, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2306, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1972, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2307, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1974, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2295, 2298, 2299, 2305, 2293, 2294, 2303, 2301, 2300, 2291, 2302, 2308, 2292, - 2297, 2290, 2296, 2304, 2306, 2307 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1938, - "character": 41 - } - ] - } - } - }, - { - "id": 2198, - "name": "CreateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for creating a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1730, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2199, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2200, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1732, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2201, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1734, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2203, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1738, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2202, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1736, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2204, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types (optional, defaults to code)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1740, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2178, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2205, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1742, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2206, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method (defaults to server default if not specified)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1744, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2200, 2201, 2203, 2202, 2204, 2205, 2206] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1730, - "character": 38 - } - ] - } - } - }, - { - "id": 2264, - "name": "CustomOAuthProvider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom OAuth/OIDC provider object returned from the admin API." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1889, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2265, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2271, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1901, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2274, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1907, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2275, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1909, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2281, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1921, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2270, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1899, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2286, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1931, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2285, - "name": "discovery_document", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document (OIDC providers only)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1929, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2252, - "name": "OIDCDiscoveryDocument", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2279, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1917, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2277, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1913, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2276, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1911, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2266, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1891, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2268, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider identifier (e.g. " - }, - { - "kind": "code", - "text": "`custom:mycompany`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1895, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2278, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1915, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2284, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1927, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2269, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1897, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2273, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1905, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2267, - "name": "provider_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1893, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2272, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1903, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2280, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1919, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2282, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1923, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2287, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the provider was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1933, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2283, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1925, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2271, 2274, 2275, 2281, 2270, 2286, 2285, 2279, 2277, 2276, 2266, 2268, 2278, - 2284, 2269, 2273, 2267, 2272, 2280, 2282, 2287, 2283 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1889, - "character": 34 - } - ] - } - } - }, - { - "id": 2332, - "name": "CustomProviderListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2033, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2333, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2334, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2034, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2335, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2336, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2035, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2264, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2336] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2034, - "character": 10 - } - ] - } - } - }, - { - "id": 2337, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2037, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2334, 2337] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2033, - "character": 41 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2339, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2039, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2340, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2341, - "name": "providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2040, - "character": 8 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2341] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2039, - "character": 10 - } - ] - } - } - }, - { - "id": 2342, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2042, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2339, 2342] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2038, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2331, - "name": "CustomProviderResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for custom provider operations." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2029, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2264, - "name": "CustomOAuthProvider", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2251, - "name": "CustomProviderType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of custom identity provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1858, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "oauth2" - }, - { - "type": "literal", - "value": "oidc" - } - ] - } - }, - { - "id": 1122, - "name": "DatabaseWithoutInternals", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Strips internal Supabase metadata from Database types.\nUseful for libraries defining generic constraints on Database types." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Stripping internal Supabase metadata", - "content": [ - { - "kind": "code", - "text": "```typescript\ntype CleanDB = DatabaseWithoutInternals\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 320, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L320" - } - ], - "typeParameters": [ - { - "id": 1123, - "name": "DB", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1123, - "name": "DB", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1908, - "name": "EmailOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 693, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - }, - { - "type": "literal", - "value": "email" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 693, - "character": 113 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1867, - "name": "EthereumWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 624, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "EIP1193Provider" - }, - "name": "EIP1193Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1868, - "name": "EthereumWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 625, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1869, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1870, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 626, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1873, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 631, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1874, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1876, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 635, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1877, - "name": "signInWithEthereum", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 636, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "EthereumSignInInput" - }, - "name": "EthereumSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1875, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 633, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1876, 1877, 1875] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 631, - "character": 14 - } - ] - } - } - }, - { - "id": 1872, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1871, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.ethereum`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 628, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1867, - "name": "EthereumWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1870, 1873, 1872, 1871] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 625, - "character": 38 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1878, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1879, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 639, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "ethereum" - } - }, - { - "id": 1880, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Ethereum compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 641, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1882, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 644, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1883, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1884, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 646, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1884] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 644, - "character": 14 - } - ] - } - } - }, - { - "id": 1881, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ethereum curve (secp256k1) signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 643, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/ethereum.ts", - "qualifiedName": "Hex" - }, - "name": "Hex", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1879, 1880, 1882, 1881] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 638, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1632, - "name": "ExperimentalFeatureFlags", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 126, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1633, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1634, - "name": "passkey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enables passkey support:\n - " - }, - { - "kind": "code", - "text": "`auth.signInWithPasskey()`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`auth.registerPasskey()`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.passkey.*`" - }, - { - "kind": "text", - "text": "\n - " - }, - { - "kind": "code", - "text": "`auth.admin.passkey.*`" - }, - { - "kind": "text", - "text": "\n\nDefaults to " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ". Calling any passkey method while this flag is\ndisabled throws a descriptive error at call time." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 136, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1634] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 126, - "character": 39 - } - ] - } - } - }, - { - "id": 1723, - "name": "Factor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A MFA factor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#enroll", - "target": 2026 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAApi#listFactors", - "target": 2077 - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueMFAAdminApi#listFactors" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 318, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1732, - "name": "Type", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 1722, - "name": "FactorType", - "package": "@supabase/auth-js" - }, - "default": { - "type": "reference", - "target": 1722, - "name": "FactorType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1733, - "name": "Status", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorVerificationStatus" - }, - "name": "FactorVerificationStatus", - "package": "@supabase/auth-js" - }, - "default": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorVerificationStatuses" - }, - "name": "FactorVerificationStatuses", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1724, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1729, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 331, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1727, - "name": "factor_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 326, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1732, - "name": "Type", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1726, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Friendly name of the factor, useful to disambiguate between multiple factors." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 322, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1725, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 320, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1731, - "name": "last_challenged_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 333, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1728, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification status of the factor, default is " - }, - { - "kind": "code", - "text": "`unverified`" - }, - { - "kind": "text", - "text": " after " - }, - { - "kind": "code", - "text": "`.enroll()`" - }, - { - "kind": "text", - "text": ", then " - }, - { - "kind": "code", - "text": "`verified`" - }, - { - "kind": "text", - "text": " after the user verifies it with " - }, - { - "kind": "code", - "text": "`.verify()`" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 330, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1733, - "name": "Status", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1730, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 332, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1729, 1727, 1726, 1725, 1731, 1728, 1730] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 318, - "character": 146 - } - ] - } - } - }, - { - "id": 1722, - "name": "FactorType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of factor. " - }, - { - "kind": "code", - "text": "`totp`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`phone`" - }, - { - "kind": "text", - "text": " supported with this version" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 305, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorTypes" - }, - "name": "FactorTypes", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 868, - "name": "FunctionInvokeOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 93, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 869, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 876, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The body of the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 111, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "File" - }, - "name": "File", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Blob" - }, - "name": "Blob", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBuffer" - }, - "name": "ArrayBuffer", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "FormData" - }, - "name": "FormData", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "ReadableStream" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "ReadableStream", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 870, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Object representing the headers to send with the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 97, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 97, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 98, - "character": 8 - } - ], - "parameters": [ - { - "id": 873, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 874, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP verb of the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 103, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - } - ] - } - }, - { - "id": 875, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Region to invoke the function in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 925, - "name": "FunctionRegion", - "package": "@supabase/functions-js" - } - }, - { - "id": 877, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The AbortSignal to use for the request." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 115, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 878, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timeout for the request in milliseconds.\nIf the function takes longer than this, the request will be aborted." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [876, 870, 874, 875, 877, 878] - } - ], - "sources": [ - { - "fileName": "packages/core/functions-js/dist/module/types.d.ts", - "line": 93, - "character": 36 - } - ] - } - } - }, - { - "id": 1955, - "name": "GenerateEmailChangeLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 760, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1956, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1958, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 763, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1959, - "name": "newEmail", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 767, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1960, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 768, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1957, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 761, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1958, 1959, 1960, 1957] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 760, - "character": 44 - } - ] - } - } - }, - { - "id": 1945, - "name": "GenerateInviteOrMagiclinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 748, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1946, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1948, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 751, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1949, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 752, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1947, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 749, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1948, 1949, 1947] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 748, - "character": 46 - } - ] - } - } - }, - { - "id": 1964, - "name": "GenerateLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 780, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1939, - "name": "GenerateSignupLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1945, - "name": "GenerateInviteOrMagiclinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1950, - "name": "GenerateRecoveryLinkParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1955, - "name": "GenerateEmailChangeLinkParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1969, - "name": "GenerateLinkProperties", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The properties related to the email link generated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 786, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1970, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1971, - "name": "action_link", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 791, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1972, - "name": "email_otp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 796, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1973, - "name": "hashed_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The hashed token appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 800, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1974, - "name": "redirect_to", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL appended to the action link." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 802, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1975, - "name": "verification_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The verification type that the email link is associated to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 804, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1976, - "name": "GenerateLinkType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1971, 1972, 1973, 1974, 1975] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 786, - "character": 37 - } - ] - } - } - }, - { - "id": 1965, - "name": "GenerateLinkResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 781, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1966, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1967, - "name": "properties", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 782, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1969, - "name": "GenerateLinkProperties", - "package": "@supabase/auth-js" - } - }, - { - "id": 1968, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 783, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1967, 1968] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 781, - "character": 64 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1976, - "name": "GenerateLinkType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 806, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] - } - }, - { - "id": 1950, - "name": "GenerateRecoveryLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 754, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1951, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1953, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 757, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1954, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 758, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": "redirectTo" - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1952, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 755, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "recovery" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1953, 1954, 1952] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 754, - "character": 41 - } - ] - } - } - }, - { - "id": 1939, - "name": "GenerateSignupLinkParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 742, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1940, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1942, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 744, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1944, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 746, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1961, - "name": "GenerateLinkOptions", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "data" - }, - { - "type": "literal", - "value": "redirectTo" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 1943, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 745, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1941, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 743, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "signup" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1942, 1944, 1943, 1941] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 742, - "character": 39 - } - ] - } - } - }, - { - "id": 1599, - "name": "GoTrueClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 32, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1600, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1615, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 61, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1621, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 74, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1622, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 74, - "character": 23 - } - ], - "signatures": [ - { - "id": 1623, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1624, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1625, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - ] - } - }, - { - "id": 1607, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if you want to automatically detect OAuth grants in the URL and sign in the user.\nSet to \"false\" to disable automatic detection.\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\nThe function receives the current URL and parsed parameters, and should return true if the URL\nshould be processed as a Supabase auth callback, or false to ignore it.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1608, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 36 - } - ], - "signatures": [ - { - "id": 1609, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1610, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1611, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1612, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 58, - "character": 55 - } - ], - "indexSignatures": [ - { - "id": 1613, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 59, - "character": 8 - } - ], - "parameters": [ - { - "id": 1614, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1631, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 124, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1632, - "name": "ExperimentalFeatureFlags", - "package": "@supabase/auth-js" - } - }, - { - "id": 1619, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 72, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/fetch.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/auth-js" - } - }, - { - "id": 1620, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 73, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1810, - "name": "AuthFlowType", - "package": "@supabase/auth-js" - } - }, - { - "id": 1627, - "name": "hasCustomAuthorizationHeader", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to \"true\" if there is a custom authorization header set globally." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 93, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1602, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1603, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 34, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 1604, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 35, - "character": 8 - } - ], - "parameters": [ - { - "id": 1605, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1626, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe client coordinates refreshes itself (single-flight via\n" - }, - { - "kind": "code", - "text": "`refreshingDeferred`" - }, - { - "kind": "text", - "text": " + commit guard) and relies on the GoTrue server to\nresolve cross-tab refresh races. Passing a custom lock opts into a\nlegacy path that wraps every auth operation in your supplied lock — this\npath is preserved for backwards compatibility (typically React Native\n" - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": " or Node multi-process setups)." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\nconstructor options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 88, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1590, - "name": "LockFunc", - "package": "@supabase/auth-js" - } - }, - { - "id": 1629, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option. Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is\npassed — the default lockless path doesn't use this timeout." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1616, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 62, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1630, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in constructor. Useful for SSR\ncontexts where initialization timing must be controlled to prevent race\nconditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 117, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1617, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 63, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - }, - { - "id": 1606, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 37, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1628, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 98, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1601, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 33, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1618, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " - }, - { - "kind": "code", - "text": "`storage`" - }, - { - "kind": "text", - "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " - }, - { - "kind": "code", - "text": "`userStorage`" - }, - { - "kind": "text", - "text": " will only contain the user object under the key " - }, - { - "kind": "code", - "text": "`storageKey + '-user'`" - }, - { - "kind": "text", - "text": ".\n\nWhen this option is set and cookie storage is used, " - }, - { - "kind": "code", - "text": "`getSession()`" - }, - { - "kind": "text", - "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " - }, - { - "kind": "code", - "text": "`getUser()`" - }, - { - "kind": "text", - "text": " to fetch a user object in those scenarios." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 71, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2103, - "name": "SupportedStorage", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1615, 1621, 1607, 1631, 1619, 1620, 1627, 1602, 1626, 1629, 1616, 1630, 1617, - 1606, 1628, 1601, 1618 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 32, - "character": 34 - } - ] - } - } - }, - { - "id": 2106, - "name": "InitializeResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1528, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2107, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2108, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1529, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2108] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1528, - "character": 31 - } - ] - } - } - }, - { - "id": 2130, - "name": "JwtHeader", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1617, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2132, - "name": "alg", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1618, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "RS256" - }, - { - "type": "literal", - "value": "ES256" - }, - { - "type": "literal", - "value": "HS256" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2133, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1618, - "character": 49 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2134, - "name": "kid", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1619, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2135, - "name": "typ", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1620, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2132, 2134, 2135] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1617, - "character": 24 - } - ] - } - } - }, - { - "id": 2328, - "name": "ListCustomProvidersParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for listing custom providers." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2022, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2329, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2330, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by provider type" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2024, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2251, - "name": "CustomProviderType", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2330] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2022, - "character": 40 - } - ] - } - } - }, - { - "id": 1590, - "name": "LockFunc", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": " async function, such that no other client instances will be able to\nhold it at the same time." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1591, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 23 - } - ], - "signatures": [ - { - "id": 1592, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameters": [ - { - "id": 1598, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1593, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1594, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1595, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to execute when the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 31, - "character": 69 - } - ], - "signatures": [ - { - "id": 1597, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1598, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1995, - "name": "MFAChallengeAndVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 884, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyTOTPParams" - }, - "name": "MFAChallengeAndVerifyTOTPParams", - "package": "@supabase/auth-js" - } - }, - { - "id": 1994, - "name": "MFAChallengeParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 880, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1991, - "name": "MFAChallengeTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1992, - "name": "MFAChallengePhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1993, - "name": "MFAChallengeWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1992, - "name": "MFAChallengePhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 864, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParamFields" - }, - "name": "MFAChallengePhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1991, - "name": "MFAChallengeTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 859, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - } - }, - { - "id": 1993, - "name": "MFAChallengeWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for initiating a WebAuthn MFA challenge.\nIncludes Relying Party information needed for WebAuthn ceremonies." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Relying Party Operations", - "target": "https://w3c.github.io/webauthn/#sctn-rp-operations" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 879, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParamsBase" - }, - "name": "MFAChallengeParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParamFields" - }, - "name": "MFAChallengeWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1977, - "name": "MFAEnrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 807, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2124, - "name": "MFAEnrollTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2125, - "name": "MFAEnrollPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 2126, - "name": "MFAEnrollWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2125, - "name": "MFAEnrollPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1572, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "phone" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParamFields" - }, - "name": "MFAEnrollPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2124, - "name": "MFAEnrollTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1567, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "totp" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParamFields" - }, - "name": "MFAEnrollTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2126, - "name": "MFAEnrollWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for enrolling a WebAuthn factor.\nCreates an unverified WebAuthn factor that must be verified with a credential." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Registering a New Credential", - "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1579, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParamsBase" - }, - "typeArguments": [ - { - "type": "literal", - "value": "webauthn" - } - ], - "name": "MFAEnrollParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnFields" - }, - "name": "MFAEnrollWebauthnFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1990, - "name": "MFATOTPChannel", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 858, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFATOTPChannels" - }, - "name": "MFATOTPChannels", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1978, - "name": "MFAUnenrollParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 808, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1979, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1980, - "name": "factorId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the factor being unenrolled." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 810, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1980] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 808, - "character": 32 - } - ] - } - } - }, - { - "id": 1989, - "name": "MFAVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 852, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1981, - "name": "MFAVerifyTOTPParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1982, - "name": "MFAVerifyPhoneParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1987, - "name": "MFAVerifyWebauthnParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1982, - "name": "MFAVerifyPhoneParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 824, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParamFields" - }, - "name": "MFAVerifyPhoneParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1981, - "name": "MFAVerifyTOTPParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 822, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParamFields" - }, - "name": "MFAVerifyTOTPParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1983, - "name": "MFAVerifyWebauthnParamFields", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "WebAuthn-specific fields for MFA verification.\nSupports both credential creation (registration) and request (authentication) flows." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 842, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1986, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1984, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1985, - "name": "webauthn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 843, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFieldsBase" - }, - "name": "MFAVerifyWebauthnParamFieldsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnCredentialParamFields" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1986, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnCredentialParamFields", - "package": "@supabase/auth-js" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1985] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 842, - "character": 98 - } - ] - } - } - }, - { - "id": 1987, - "name": "MFAVerifyWebauthnParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for WebAuthn MFA verification.\nUsed to verify WebAuthn credentials after challenge." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "inline-tag", - "tag": "@link", - "text": "W3C WebAuthn Spec - Verifying an Authentication Assertion", - "target": "https://w3c.github.io/webauthn/#sctn-verifying-assertion" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 851, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1988, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - }, - "default": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "create" - }, - { - "type": "literal", - "value": "request" - } - ] - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParamsBase" - }, - "name": "MFAVerifyParamsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1983, - "typeArguments": [ - { - "type": "reference", - "target": 1988, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "MFAVerifyWebauthnParamFields", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1906, - "name": "MobileOtpType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 692, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1907, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 692, - "character": 63 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2363, - "name": "OAuthAuthorizationClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client details in an authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2112, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2364, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2365, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2114, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2368, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2120, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2366, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2116, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2367, - "name": "uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's website" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2118, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2365, 2368, 2366, 2367] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2112, - "character": 39 - } - ] - } - } - }, - { - "id": 2369, - "name": "OAuthAuthorizationDetails", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth authorization details when user needs to provide consent.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response includes all information needed to display a consent page:\nclient details, user info, requested scopes, and where the user will be redirected.\n\nNote: " - }, - { - "kind": "code", - "text": "`redirect_uri`" - }, - { - "kind": "text", - "text": " is the base URI (e.g., \"https://app.com/callback\") without\nquery parameters. After consent, you'll receive a complete " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " with\nthe authorization code and state parameters appended." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2133, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2370, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2371, - "name": "authorization_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The authorization ID used to approve or deny the request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2135, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2373, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client requesting authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2139, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2363, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 2372, - "name": "redirect_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The OAuth client's registered redirect URI (base URI without query parameters)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2137, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2378, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Space-separated list of requested scopes (e.g., \"openid profile email\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2148, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2374, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User object associated with the authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2141, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2375, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2377, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User email" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2145, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2376, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User ID (UUID)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2143, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2377, 2376] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2141, - "character": 10 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2371, 2373, 2372, 2378, 2374] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2133, - "character": 40 - } - ] - } - } - }, - { - "id": 2182, - "name": "OAuthClient", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client object returned from the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1696, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2183, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2184, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier for the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1698, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2185, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1700, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2186, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client secret (only returned on registration and regeneration)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1702, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2187, - "name": "client_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1704, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2179, - "name": "OAuthClientType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2190, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1710, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2196, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was created" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1722, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2193, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1716, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2191, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1712, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2192, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1714, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2189, - "name": "registration_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Registration type of the client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1708, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2180, - "name": "OAuthClientRegistrationType", - "package": "@supabase/auth-js" - } - }, - { - "id": 2194, - "name": "response_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1718, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2178, - "name": "OAuthClientResponseType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2195, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scope of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1720, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2188, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1706, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - }, - { - "id": 2197, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the client was last updated" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1724, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2184, 2185, 2186, 2187, 2190, 2196, 2193, 2191, 2192, 2189, 2194, 2195, 2188, - 2197 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1696, - "character": 26 - } - ] - } - } - }, - { - "id": 2176, - "name": "OAuthClientGrantType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client grant types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1671, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "authorization_code" - }, - { - "type": "literal", - "value": "refresh_token" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 2177, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1671, - "character": 86 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2216, - "name": "OAuthClientListResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for listing OAuth clients.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1774, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2217, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2218, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1775, - "character": 4 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2219, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2221, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1777, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2220, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1776, - "character": 8 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2182, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2221, 2220] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1775, - "character": 10 - } - ] - } - }, - { - "type": "reference", - "target": 2110, - "name": "Pagination", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2222, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1779, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2218, 2222] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1774, - "character": 38 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2223, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2224, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1781, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2225, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2226, - "name": "clients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1782, - "character": 8 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2226] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1781, - "character": 10 - } - ] - } - } - }, - { - "id": 2227, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1784, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2224, 2227] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1780, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2180, - "name": "OAuthClientRegistrationType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client registration type.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1686, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "dynamic" - }, - { - "type": "literal", - "value": "manual" - } - ] - } - }, - { - "id": 2215, - "name": "OAuthClientResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response type for OAuth client operations.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1769, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reference", - "target": 2182, - "name": "OAuthClient", - "package": "@supabase/auth-js" - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2178, - "name": "OAuthClientResponseType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client response types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1676, - "character": 12 - } - ], - "type": { - "type": "literal", - "value": "code" - } - }, - { - "id": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client token endpoint authentication method.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1691, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "none" - }, - { - "type": "literal", - "value": "client_secret_basic" - }, - { - "type": "literal", - "value": "client_secret_post" - } - ] - } - }, - { - "id": 2179, - "name": "OAuthClientType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client type indicating whether the client can keep credentials confidential.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1681, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "public" - }, - { - "type": "literal", - "value": "confidential" - } - ] - } - }, - { - "id": 2384, - "name": "OAuthGrant", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An OAuth grant representing a user's authorization of an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2199, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2385, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2386, - "name": "client", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client information" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2201, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2363, - "name": "OAuthAuthorizationClient", - "package": "@supabase/auth-js" - } - }, - { - "id": 2388, - "name": "granted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the grant was created (ISO 8601 date-time)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2205, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2387, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of scopes granted to this client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2203, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2386, 2388, 2387] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2199, - "character": 25 - } - ] - } - } - }, - { - "id": 2379, - "name": "OAuthRedirect", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth redirect response when user has already consented or after consent decision.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response is returned in three scenarios:\n1. User already consented to these scopes (auto-approved)\n2. User just approved the authorization request\n3. User just denied the authorization request\n\nThe " - }, - { - "kind": "code", - "text": "`redirect_url`" - }, - { - "kind": "text", - "text": " is a complete URL ready for redirecting the user back to the\nOAuth client, including authorization code (on success) or error (on denial) in\nquery parameters, along with the state parameter if one was provided." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2163, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2380, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2381, - "name": "redirect_url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Complete redirect URL with authorization code and state parameters (e.g., \"https://app.com/callback?code=xxx&state=yyy\")" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2165, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2381] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2163, - "character": 28 - } - ] - } - } - }, - { - "id": 1685, - "name": "OAuthResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 208, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1686, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1687, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 209, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1688, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1689, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 210, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1690, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 211, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1689, 1690] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 209, - "character": 10 - } - ] - } - } - }, - { - "id": 1691, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 213, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1687, 1691] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 208, - "character": 28 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1692, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1693, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 215, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1694, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1695, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 216, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - }, - { - "id": 1696, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 217, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1695, 1696] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 215, - "character": 10 - } - ] - } - } - }, - { - "id": 1697, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 219, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1693, 1697] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 214, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2252, - "name": "OIDCDiscoveryDocument", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery document fields.\nPopulated when the server successfully fetches and validates the\nprovider's OpenID Connect discovery document." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1864, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2253, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2255, - "name": "authorization_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the authorization endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1868, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2254, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The issuer identifier" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1866, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2257, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the JSON Web Key Set" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1872, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2259, - "name": "revocation_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the revocation endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1876, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2263, - "name": "supported_id_token_signing_algs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported ID token signing algorithms" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1884, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2261, - "name": "supported_response_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported response types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1880, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2260, - "name": "supported_scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported scopes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1878, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2262, - "name": "supported_subject_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of supported subject types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1882, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2256, - "name": "token_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the token endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1870, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2258, - "name": "userinfo_endpoint", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the userinfo endpoint" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1874, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2255, 2254, 2257, 2259, 2263, 2261, 2260, 2262, 2256, 2258] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1864, - "character": 36 - } - ] - } - } - }, - { - "id": 2117, - "name": "PageParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1538, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2119, - "name": "page", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The page number" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1540, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2120, - "name": "perPage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items returned per page" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1542, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2119, 2120] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1538, - "character": 25 - } - ] - } - } - }, - { - "id": 2110, - "name": "Pagination", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1532, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2111, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2113, - "name": "lastPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1535, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2112, - "name": "nextPage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1534, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 2114, - "name": "total", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1536, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2113, 2112, 2114] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1532, - "character": 25 - } - ], - "indexSignatures": [ - { - "id": 2115, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1533, - "character": 4 - } - ], - "parameters": [ - { - "id": 2116, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 2429, - "name": "PasskeyAuthenticationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/authentication/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2331, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2430, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2431, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2332, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2433, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2334, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2432, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2333, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialRequestOptions" - }, - "name": "ServerCredentialRequestOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2431, 2433, 2432] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2331, - "character": 51 - } - ] - } - } - }, - { - "id": 2434, - "name": "PasskeyAuthenticationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/authentication/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2337, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2435, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2436, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2338, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2437, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2339, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.dom.ts", - "qualifiedName": "AuthenticationResponseJSON" - }, - "name": "AuthenticationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2436, 2437] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2337, - "character": 48 - } - ] - } - } - }, - { - "id": 2472, - "name": "PasskeyDeleteParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2382, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2473, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2474, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to delete" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2384, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2474] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2382, - "character": 34 - } - ] - } - } - }, - { - "id": 2438, - "name": "PasskeyListItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Item in the passkeys list (GET /passkeys/ and admin list)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2342, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2439, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2442, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2345, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2441, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2344, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2440, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2343, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2443, - "name": "last_used_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2346, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2442, 2441, 2440, 2443] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2342, - "character": 30 - } - ] - } - } - }, - { - "id": 2424, - "name": "PasskeyMetadata", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2325, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2425, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2428, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2328, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2427, - "name": "friendly_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2327, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2426, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2326, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2428, 2427, 2426] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2325, - "character": 30 - } - ] - } - } - }, - { - "id": 2415, - "name": "PasskeyRegistrationOptionsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response from POST /passkeys/registration/options" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2314, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2416, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2417, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2315, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2419, - "name": "expires_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2317, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2418, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2316, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialCreationOptions" - }, - "name": "ServerCredentialCreationOptions", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2417, 2419, 2418] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2314, - "character": 49 - } - ] - } - } - }, - { - "id": 2420, - "name": "PasskeyRegistrationVerifyParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request body for POST /passkeys/registration/verify" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2320, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2421, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2422, - "name": "challenge_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2321, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2423, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2322, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.dom.ts", - "qualifiedName": "RegistrationResponseJSON" - }, - "name": "RegistrationResponseJSON", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2422, 2423] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2320, - "character": 46 - } - ] - } - } - }, - { - "id": 2468, - "name": "PasskeyUpdateParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2376, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2469, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2471, - "name": "friendlyName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New friendly name (max 120 chars)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2380, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2470, - "name": "passkeyId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the passkey to update" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2378, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2471, 2470] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2376, - "character": 34 - } - ] - } - } - }, - { - "id": 55, - "name": "PostgrestMaybeSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 641, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 56, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 56, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 51, - "name": "PostgrestResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 642, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 52, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": 53, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 52, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - } - ], - "name": "PostgrestSingleResponse", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 53, - "name": "PostgrestSingleResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/postgrest-js/dist/index.d.cts", - "line": 640, - "character": 5 - } - ], - "typeParameters": [ - { - "id": 54, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseSuccess" - }, - "typeArguments": [ - { - "type": "reference", - "target": 54, - "name": "T", - "package": "@supabase/postgrest-js", - "refersToTypeParameter": true - } - ], - "name": "PostgrestResponseSuccess", - "package": "@supabase/postgrest-js" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponseFailure" - }, - "name": "PostgrestResponseFailure", - "package": "@supabase/postgrest-js" - } - ] - } - }, - { - "id": 1640, - "name": "Prettify", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resolve mapped types and show the derived keys and their types when hovering in\nVS Code, instead of just showing the names those mapped types are defined with." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 148, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1641, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1641, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - } - }, - { - "id": 1587, - "name": "Provider", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue. Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 9, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "figma" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "linkedin_oidc" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "slack_oidc" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "x" - }, - { - "type": "literal", - "value": "workos" - }, - { - "type": "literal", - "value": "zoom" - }, - { - "type": "literal", - "value": "fly" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - } - ], - "elementSummaries": [ - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [], - [ - { - "kind": "text", - "text": "Uses OAuth 1.0a" - } - ], - [ - { - "kind": "text", - "text": "Uses OAuth 2.0" - } - ], - [], - [], - [], - [] - ] - } - }, - { - "id": 1117, - "name": "QueryData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ], - "typeParameters": [ - { - "id": 1120, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1120, - "name": "T", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1118, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1119, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 51, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ], - "type": { - "type": "inferred", - "name": "U" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1119] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 308, - "character": 49, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L308" - } - ] - } - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "U" - }, - "name": "U", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "literal", - "value": null - } - ], - "name": "Exclude", - "package": "typescript" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 1121, - "name": "QueryError", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 309, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L309" - } - ], - "type": { - "type": "reference", - "target": 830, - "name": "PostgrestError", - "package": "@supabase/postgrest-js" - } - }, - { - "id": 1115, - "name": "QueryResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper types for query results." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 307, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L307" - } - ], - "typeParameters": [ - { - "id": 1116, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1116, - "name": "T", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PromiseLike" - }, - "typeArguments": [ - { - "type": "inferred", - "name": "U" - } - ], - "name": "PromiseLike", - "package": "typescript" - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "U" - }, - "name": "U", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - }, - { - "id": 3136, - "name": "RealtimeChannelOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 11, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3137, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3138, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 12, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3140, - "name": "broadcast", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "self option enables client to receive message it broadcast\nack option instructs server to acknowledge that broadcast message was received\nreplay option instructs server to replay broadcast messages" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 18, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3143, - "name": "ack", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 20, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3144, - "name": "replay", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 21, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "ReplayOption" - }, - "name": "ReplayOption", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3142, - "name": "self", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 19, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3143, 3144, 3142] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 18, - "character": 20 - } - ] - } - } - }, - { - "id": 3145, - "name": "presence", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "key option is used to track presence payload across clients" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 26, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3146, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3148, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 28, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3147, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 27, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3148, 3147] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 26, - "character": 19 - } - ] - } - } - }, - { - "id": 3149, - "name": "private", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "defines if the channel is private or not and if RLS policies will be used to check data" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3140, 3145, 3149] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 12, - "character": 12 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3138] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 11, - "character": 37 - } - ] - } - } - }, - { - "id": 3150, - "name": "RealtimeChannelSendResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 115, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 3151, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 115, - "character": 83 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 3273, - "name": "RealtimeClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 26, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3274, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3309, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 47, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 47, - "character": 18 - } - ], - "signatures": [ - { - "id": 3311, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 3291, - "name": "decode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 34, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Decode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Decode", - "package": "@supabase/phoenix" - } - }, - { - "id": 3312, - "name": "disconnectOnEmptyChannelsAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 48, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3290, - "name": "encode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 33, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/@supabase+phoenix@0.4.2/node_modules/@supabase/phoenix/assets/js/phoenix/types.js", - "qualifiedName": "Encode" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Encode", - "package": "@supabase/phoenix" - } - }, - { - "id": 3306, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 44, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3296, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 36, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3297, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 36, - "character": 14 - } - ], - "indexSignatures": [ - { - "id": 3298, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 37, - "character": 8 - } - ], - "parameters": [ - { - "id": 3299, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 3278, - "name": "heartbeatCallback", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 30, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3279, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 30, - "character": 24 - } - ], - "signatures": [ - { - "id": 3280, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3281, - "name": "status", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "HeartbeatStatus" - }, - "name": "HeartbeatStatus", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3282, - "name": "latency", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3277, - "name": "heartbeatIntervalMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 29, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3304, - "name": "log_level", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 42, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3284, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 32, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3285, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 32, - "character": 13 - } - ], - "signatures": [ - { - "id": 3286, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3287, - "name": "kind", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3288, - "name": "msg", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3289, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3305, - "name": "logLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 43, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3300, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 39, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3301, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 39, - "character": 13 - } - ], - "indexSignatures": [ - { - "id": 3302, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 40, - "character": 8 - } - ], - "parameters": [ - { - "id": 3303, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - }, - { - "id": 3292, - "name": "reconnectAfterMs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 35, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3293, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 35, - "character": 23 - } - ], - "signatures": [ - { - "id": 3294, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3295, - "name": "tries", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - } - } - }, - { - "id": 3313, - "name": "sessionStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage compatible object used by the underlying socket for longpoll fallback history.\nProvide a custom implementation in environments where reading " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": "\nthrows (sandboxed iframes, in-app webviews, \"block third-party storage\" privacy modes).\nDefaults to " - }, - { - "kind": "code", - "text": "`globalThis.sessionStorage`" - }, - { - "kind": "text", - "text": " when accessible, otherwise an in-memory store." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 55, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - } - }, - { - "id": 3276, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 28, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3275, - "name": "transport", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 27, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3481, - "name": "WebSocketLikeConstructor", - "package": "@supabase/realtime-js" - } - }, - { - "id": 3283, - "name": "vsn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 31, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3307, - "name": "worker", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 45, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3308, - "name": "workerUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 46, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3309, 3291, 3312, 3290, 3306, 3296, 3278, 3277, 3304, 3284, 3305, 3300, 3292, - 3313, 3276, 3275, 3283, 3307, 3308 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 26, - "character": 36 - } - ] - } - } - }, - { - "id": 3314, - "name": "RealtimeMessage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 8, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3315, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3317, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 10, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3320, - "name": "join_ref", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 13, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3318, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 11, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3319, - "name": "ref", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 12, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3316, - "name": "topic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 9, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3317, 3320, 3318, 3319, 3316] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 8, - "character": 30 - } - ] - } - } - }, - { - "id": 3321, - "name": "RealtimePostgresChangesFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 97, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3327, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3398, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3322, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3323, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of database change to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 101, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3327, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3326, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Receive database changes when filter is matched." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 113, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3324, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database schema to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3325, - "name": "table", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The database table to listen to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3323, 3326, 3324, 3325] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 97, - "character": 99 - } - ] - } - } - }, - { - "id": 3328, - "name": "RealtimePostgresChangesPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 94, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3329, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3330, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 94, - "character": 53 - } - ], - "indexSignatures": [ - { - "id": 3331, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 95, - "character": 4 - } - ], - "parameters": [ - { - "id": 3332, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3333, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresInsertPayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3343, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresUpdatePayload", - "package": "@supabase/realtime-js" - }, - { - "type": "reference", - "target": 3352, - "typeArguments": [ - { - "type": "reference", - "target": 3329, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "RealtimePostgresDeletePayload", - "package": "@supabase/realtime-js" - } - ] - } - }, - { - "id": 3352, - "name": "RealtimePostgresDeletePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 87, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3358, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3359, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 87, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3360, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 88, - "character": 4 - } - ], - "parameters": [ - { - "id": 3361, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3353, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3354, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 90, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3402, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3355, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 91, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3356, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 91, - "character": 9 - } - ] - } - } - }, - { - "id": 3357, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 92, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3358, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3354, 3355, 3357] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 89, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3333, - "name": "RealtimePostgresInsertPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 73, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3339, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3340, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 73, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3341, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 74, - "character": 4 - } - ], - "parameters": [ - { - "id": 3342, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3334, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3335, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 76, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3400, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3336, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 77, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3339, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3337, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 78, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 78, - "character": 9 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3335, 3336, 3337] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 75, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3343, - "name": "RealtimePostgresUpdatePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 80, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3348, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3349, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 80, - "character": 52 - } - ], - "indexSignatures": [ - { - "id": 3350, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 81, - "character": 4 - } - ], - "parameters": [ - { - "id": 3351, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayloadBase" - }, - "name": "RealtimePostgresChangesPayloadBase", - "package": "@supabase/realtime-js" - }, - { - "type": "reflection", - "declaration": { - "id": 3344, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3345, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 83, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3401, - "name": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3346, - "name": "new", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 84, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 3348, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - }, - { - "id": 3347, - "name": "old", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 85, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3348, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3345, 3346, 3347] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 82, - "character": 42 - } - ] - } - } - ] - } - }, - { - "id": 3362, - "name": "RealtimePresenceJoinPayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 12, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3368, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3369, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 12, - "character": 50 - } - ], - "indexSignatures": [ - { - "id": 3370, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 13, - "character": 4 - } - ], - "parameters": [ - { - "id": 3371, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3363, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3366, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 17, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3368, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3364, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 15, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3405, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3365, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 16, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3367, - "name": "newPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3368, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3366, 3364, 3365, 3367] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 14, - "character": 5 - } - ] - } - } - }, - { - "id": 3372, - "name": "RealtimePresenceLeavePayload", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 20, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3378, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 20, - "character": 51 - } - ], - "indexSignatures": [ - { - "id": 3380, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 21, - "character": 4 - } - ], - "parameters": [ - { - "id": 3381, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3373, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3376, - "name": "currentPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 25, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3378, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - }, - { - "id": 3374, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 23, - "character": 4 - } - ], - "type": { - "type": "templateLiteral", - "head": "", - "tail": [ - [ - { - "type": "reference", - "target": 3406, - "name": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE", - "package": "@supabase/realtime-js" - }, - "" - ] - ] - } - }, - { - "id": 3375, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 24, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3377, - "name": "leftPresences", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 26, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3378, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3376, 3374, 3375, 3377] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 22, - "character": 5 - } - ] - } - } - }, - { - "id": 3382, - "name": "RealtimePresenceState", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 7, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 3386, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3387, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 7, - "character": 44 - } - ], - "indexSignatures": [ - { - "id": 3388, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 8, - "character": 4 - } - ], - "parameters": [ - { - "id": 3389, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - }, - "default": { - "type": "reflection", - "declaration": { - "id": 3390, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 9, - "character": 4 - } - ] - } - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3383, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 9, - "character": 10 - } - ], - "indexSignatures": [ - { - "id": 3384, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimePresence.d.ts", - "line": 10, - "character": 4 - } - ], - "parameters": [ - { - "id": 3385, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "Presence" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3386, - "name": "T", - "package": "@supabase/realtime-js", - "refersToTypeParameter": true - } - ], - "name": "Presence", - "package": "@supabase/realtime-js" - } - } - } - ] - } - } - }, - { - "id": 3391, - "name": "RealtimeRemoveChannelResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ok" - }, - { - "type": "literal", - "value": "timed out" - }, - { - "type": "literal", - "value": "error" - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 3392, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeClient.d.ts", - "line": 15, - "character": 85 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 2450, - "name": "RegisterPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2354, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2451, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2452, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2355, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2453, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2454, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2356, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2454] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2355, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2452] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2354, - "character": 41 - } - ] - } - } - }, - { - "id": 1645, - "name": "RequestResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "a shared result type that encapsulates errors instead of throwing them, allows you to optionally specify the ErrorType" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 160, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1652, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 1653, - "name": "ErrorType", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "default": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1646, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1647, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 161, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1652, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1648, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 162, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1647, 1648] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 160, - "character": 68 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1649, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1650, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 164, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 1651, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 165, - "character": 4 - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "extendsType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "trueType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - }, - "falseType": { - "type": "reference", - "target": 1653, - "name": "ErrorType", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1650, 1651] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 163, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1654, - "name": "RequestResultSafeDestructure", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "similar to RequestResult except it allows you to destructure the possible shape of the success response\n " - }, - { - "kind": "inline-tag", - "tag": "@see", - "text": "RequestResult" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 171, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1661, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1655, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1656, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 172, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - { - "id": 1657, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 173, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1656, 1657] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 171, - "character": 46 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1658, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1659, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 175, - "character": 4 - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "object" - }, - "trueType": { - "type": "mapped", - "parameter": "K", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1661, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "literal", - "value": null - } - }, - "falseType": { - "type": "literal", - "value": null - } - } - }, - { - "id": 1660, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 178, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1659, 1660] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 174, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2136, - "name": "RequiredClaims", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1622, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2137, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2144, - "name": "aal", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1629, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2018, - "name": "AuthenticatorAssuranceLevels", - "package": "@supabase/auth-js" - } - }, - { - "id": 2140, - "name": "aud", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1625, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2141, - "name": "exp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1626, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2142, - "name": "iat", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1627, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2138, - "name": "iss", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1623, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2143, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1628, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2145, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1630, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2139, - "name": "sub", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1624, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2144, 2140, 2141, 2142, 2138, 2143, 2145, 2139] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1622, - "character": 29 - } - ] - } - }, - "extendedBy": [ - { - "type": "reference", - "target": 2146, - "name": "JwtPayload" - } - ] - }, - { - "id": 1910, - "name": "ResendParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 694, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1911, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1913, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 696, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1914, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 697, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1915, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1917, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 701, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1916, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 699, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1917, 1916] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 697, - "character": 14 - } - ] - } - } - }, - { - "id": 1912, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 695, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1908, - "name": "EmailOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1913, 1914, 1912] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 694, - "character": 27 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1918, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1921, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 706, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1922, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1923, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 708, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1923] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 706, - "character": 14 - } - ] - } - } - }, - { - "id": 1920, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 705, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1919, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 704, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Extract" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1906, - "name": "MobileOtpType", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - ], - "name": "Extract", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1921, 1920, 1919] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 703, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1774, - "name": "SignInAnonymouslyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 495, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1775, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1776, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 496, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1777, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1779, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 504, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1778, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 502, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1779, 1778] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 496, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1776] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 495, - "character": 43 - } - ] - } - } - }, - { - "id": 1824, - "name": "SignInWithIdTokenCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 579, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1825, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1829, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 585, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1830, - "name": "nonce", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the ID token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim, then the hash of this value is compared to the value in the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 587, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1831, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 588, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1832, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1833, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 590, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1833] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 588, - "character": 14 - } - ] - } - } - }, - { - "id": 1826, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provider name or OIDC " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " value identifying which provider should be used to verify the provided token. Supported names: " - }, - { - "kind": "code", - "text": "`google`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`apple`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`azure`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`facebook`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`kakao`" - }, - { - "kind": "text", - "text": ". Use the " - }, - { - "kind": "code", - "text": "`custom:`" - }, - { - "kind": "text", - "text": " prefix for custom OIDC providers (e.g. " - }, - { - "kind": "code", - "text": "`custom:my-oidc-provider`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 581, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "kakao" - }, - { - "type": "templateLiteral", - "head": "custom:", - "tail": [ - [ - { - "type": "intrinsic", - "name": "string" - }, - "" - ] - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1827, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 581, - "character": 99 - } - ] - } - } - ] - } - ] - } - }, - { - "id": 1828, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC ID token issued by the specified provider. The " - }, - { - "kind": "code", - "text": "`iss`" - }, - { - "kind": "text", - "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " - }, - { - "kind": "code", - "text": "`at_hash`" - }, - { - "kind": "text", - "text": " which require that you provide an " - }, - { - "kind": "code", - "text": "`access_token`" - }, - { - "kind": "text", - "text": " value to be accepted properly. If the token contains a " - }, - { - "kind": "code", - "text": "`nonce`" - }, - { - "kind": "text", - "text": " claim you must supply the nonce used to obtain the ID token." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 583, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1829, 1830, 1831, 1826, 1828] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 579, - "character": 43 - } - ] - } - } - }, - { - "id": 1812, - "name": "SignInWithOAuthCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 563, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1813, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1815, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 566, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1816, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1819, - "name": "queryParams", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object of query params" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 572, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1820, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 572, - "character": 22 - } - ], - "indexSignatures": [ - { - "id": 1821, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 573, - "character": 12 - } - ], - "parameters": [ - { - "id": 1822, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 1817, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they are confirmed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 568, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1818, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A space-separated list of scopes granted to the OAuth application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 570, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1823, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 576, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1819, 1817, 1818, 1823] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 566, - "character": 14 - } - ] - } - } - }, - { - "id": 1814, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "One of the providers supported by GoTrue." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 565, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1587, - "name": "Provider", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1815, 1814] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 563, - "character": 41 - } - ] - } - } - }, - { - "id": 2444, - "name": "SignInWithPasskeyCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2348, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2446, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2349, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2447, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2448, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2350, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2449, - "name": "signal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2351, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2448, 2449] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2349, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2446] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2348, - "character": 43 - } - ] - } - } - }, - { - "id": 1788, - "name": "SignInWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 522, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1789, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1790, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 523, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1791, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1792, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 524, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1792] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 523, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1790] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 522, - "character": 70 - } - ] - } - } - ] - } - }, - { - "id": 1793, - "name": "SignInWithPasswordlessCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 527, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1795, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email address." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 529, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1796, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 530, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1797, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1801, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 542, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1800, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 540, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1798, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The redirect url embedded in the email link" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 532, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1799, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 534, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1801, 1800, 1798, 1799] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 530, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1795, 1796] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 527, - "character": 48 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1802, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1804, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 547, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1805, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1808, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 557, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1809, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Messaging channel to use (e.g. whatsapp or sms)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 559, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 1807, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom data object to store the user's metadata. This maps to the " - }, - { - "kind": "code", - "text": "`auth.users.raw_user_meta_data`" - }, - { - "kind": "text", - "text": " column.\n\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " should be a JSON object that includes user-specific info, such as their first and last name." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 555, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1806, - "name": "shouldCreateUser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to false, this method will not create a new user. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 549, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1808, 1809, 1807, 1806] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 547, - "character": 14 - } - ] - } - } - }, - { - "id": 1803, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's phone number." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 546, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1804, 1803] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 544, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1924, - "name": "SignInWithSSO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 711, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1925, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1927, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 714, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1928, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1930, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 718, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1929, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 716, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1931, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 724, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1930, 1929, 1931] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 714, - "character": 14 - } - ] - } - } - }, - { - "id": 1926, - "name": "providerId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UUID of the SSO provider to invoke single-sign on to." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 713, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1927, 1926] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 711, - "character": 28 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1932, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1933, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Domain name of the organization for which to invoke single-sign on." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 728, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1934, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 729, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1935, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1937, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 733, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1936, - "name": "redirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A URL to send the user to after they have signed-in." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 731, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1938, - "name": "skipBrowserRedirect", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 739, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1937, 1936, 1938] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 729, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1933, 1934] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 726, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 2121, - "name": "SignOut", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1544, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2122, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2123, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1555, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2123] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1544, - "character": 22 - } - ] - } - } - }, - { - "id": 2175, - "name": "SignOutScope", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1666, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": 2174, - "name": "SIGN_OUT_SCOPES", - "package": "@supabase/auth-js" - } - } - } - }, - { - "id": 1780, - "name": "SignUpWithPasswordCredentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 507, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasswordCredentialsBase" - }, - "name": "PasswordCredentialsBase", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 1781, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1782, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 508, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1783, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1786, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 511, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1787, - "name": "channel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 512, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "whatsapp" - } - ] - } - }, - { - "id": 1785, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 510, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1784, - "name": "emailRedirectTo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 509, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1786, 1787, 1785, 1784] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 508, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1782] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 507, - "character": 70 - } - ] - } - } - ] - } - }, - { - "id": 1834, - "name": "SolanaWallet", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 593, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1835, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1840, - "name": "publicKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 595, - "character": 4 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1841, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1842, - "name": "toBase58", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 596, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1843, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 596, - "character": 18 - } - ], - "signatures": [ - { - "id": 1844, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1842] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 595, - "character": 16 - } - ] - } - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1836, - "name": "signIn", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 594, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1837, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 594, - "character": 13 - } - ], - "signatures": [ - { - "id": 1838, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1839, - "name": "inputs", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInOutput" - }, - "name": "SolanaSignInOutput", - "package": "@supabase/auth-js" - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 1845, - "name": "signMessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 598, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1846, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 598, - "character": 18 - } - ], - "signatures": [ - { - "id": 1847, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1848, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - }, - { - "id": 1849, - "name": "encoding", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "utf8" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "undefined" - } - ] - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1840, 1836, 1845] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 593, - "character": 27 - } - ] - } - } - }, - { - "id": 1850, - "name": "SolanaWeb3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 600, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 1851, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1852, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 601, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1855, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 606, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1856, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1858, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 610, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1859, - "name": "signInWithSolana", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 611, - "character": 8 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/web3/solana.ts", - "qualifiedName": "SolanaSignInInput" - }, - "name": "SolanaSignInInput", - "package": "@supabase/auth-js" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "version" - }, - { - "type": "literal", - "value": "chain" - }, - { - "type": "literal", - "value": "domain" - }, - { - "type": "literal", - "value": "uri" - }, - { - "type": "literal", - "value": "statement" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 1857, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 608, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1858, 1859, 1857] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 606, - "character": 14 - } - ] - } - } - }, - { - "id": 1854, - "name": "statement", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 605, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1853, - "name": "wallet", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wallet interface to use. If not specified will default to " - }, - { - "kind": "code", - "text": "`window.solana`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 603, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 1834, - "name": "SolanaWallet", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1852, 1855, 1854, 1853] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 600, - "character": 36 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 1860, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1861, - "name": "chain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 614, - "character": 4 - } - ], - "type": { - "type": "literal", - "value": "solana" - } - }, - { - "id": 1862, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sign in with Solana compatible message. Must include " - }, - { - "kind": "code", - "text": "`Issued At`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`URI`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`Version`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 616, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1864, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 619, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1865, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1866, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Verification token received when the user completes the captcha on the site." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 621, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1866] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 619, - "character": 14 - } - ] - } - } - }, - { - "id": 1863, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Ed25519 signature of the message." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 618, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Uint8Array" - }, - "name": "Uint8Array", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1861, 1862, 1864, 1863] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 613, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 1698, - "name": "SSOResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 221, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1645, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1699, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1700, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " - }, - { - "kind": "code", - "text": "`window.location.href`" - }, - { - "kind": "text", - "text": " to take\nthe user to the authentication flow." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 229, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1700] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 221, - "character": 40 - } - ] - } - } - ], - "name": "RequestResult", - "package": "@supabase/auth-js" - } - }, - { - "id": 2459, - "name": "StartPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2365, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2460, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2461, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2366, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2462, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2463, - "name": "captchaToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2367, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2463] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2366, - "character": 14 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2461] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2365, - "character": 47 - } - ] - } - } - }, - { - "id": 1642, - "name": "StrictOmit", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A stricter version of TypeScript's Omit that only allows omitting keys that actually exist.\nThis prevents typos and ensures type safety at compile time.\nUnlike regular Omit, this will error if you try to omit a non-existent key." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 156, - "character": 12 - } - ], - "typeParameters": [ - { - "id": 1643, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 1644, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1643, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1643, - "name": "T", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1644, - "name": "K", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1072, - "name": "SupabaseClientOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 96, - "character": 12, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L96" - } - ], - "typeParameters": [ - { - "id": 1111, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1073, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1107, - "name": "accessToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional function for using a third-party authentication system with\nSupabase. The function should return an access token or ID token (JWT) by\nobtaining it from the third-party auth SDK. Note that this\nfunction may be called concurrently and many times. Use memoization and\nlocking techniques if this is not supported by the SDKs.\n\nWhen set, the " - }, - { - "kind": "code", - "text": "`auth`" - }, - { - "kind": "text", - "text": " namespace of the Supabase client cannot be used.\nCreate another client if you wish to use Supabase Auth and third-party\nauthentications concurrently in the same application." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 252, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L252" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1108, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 252, - "character": 16, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L252" - } - ], - "signatures": [ - { - "id": 1109, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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" - } - } - ] - } - } - }, - { - "id": 1079, - "name": "auth", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 129, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L129" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1080, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1081, - "name": "autoRefreshToken", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Automatically refreshes the token for logged-in users. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 133, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L133" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1095, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If debug messages for authentication client are emitted. Can be used to inspect the behavior of the library." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 183, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L183" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "debug" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1084, - "name": "detectSessionInUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true.\n\nCan be set to a function to provide custom logic for determining if a URL contains\na Supabase auth callback. The function receives the current URL and parsed parameters,\nand should return true if the URL should be processed as a Supabase auth callback.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that\nalso return access_token in the URL fragment, which would otherwise be incorrectly\nintercepted by Supabase Auth." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With custom detection logic", - "content": [ - { - "kind": "code", - "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reflection", - "declaration": { - "id": 1085, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 36, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "signatures": [ - { - "id": 1086, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1087, - "name": "url", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "URL" - }, - "name": "URL", - "package": "typescript" - } - }, - { - "id": 1088, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1089, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 55, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "indexSignatures": [ - { - "id": 1090, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 163, - "character": 57, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L163" - } - ], - "parameters": [ - { - "id": 1091, - "name": "parameter", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - } - ] - } - }, - { - "id": 1098, - "name": "experimental", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Opt-in flags for experimental features. These APIs may change without\nnotice and are disabled by default." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 206, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L206" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "experimental" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1094, - "name": "flowType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth flow to use - defaults to implicit flow. PKCE is recommended for mobile and server-side applications." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 179, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L179" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "flowType" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1096, - "name": "lock", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Provide your own locking mechanism based on the environment. By default\nthe auth client coordinates refreshes itself and the server resolves\ncross-tab races. Passing a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " opts into a legacy path that\nwraps every auth operation in your supplied lock." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Custom locks still work in v2.x for backwards compatibility.\nThe legacy lock path will be removed in v3 — drop this option from your\n" - }, - { - "kind": "code", - "text": "`createClient`" - }, - { - "kind": "text", - "text": " options before upgrading." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 194, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L194" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lock" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1099, - "name": "lockAcquireTimeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time in milliseconds to wait for acquiring the custom lock\nsupplied via " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": ". Only consulted when a custom " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " is passed." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n5000\n```" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Only used by the legacy lock path. Will be removed in v3\nalong with the " - }, - { - "kind": "code", - "text": "`lock`" - }, - { - "kind": "text", - "text": " option." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 216, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L216" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "lockAcquireTimeout" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1083, - "name": "persistSession", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to persist a logged-in session to storage. Defaults to true." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 141, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L141" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1100, - "name": "skipAutoInitialize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, skips automatic initialization in the auth client constructor.\nUseful for SSR contexts where initialization timing must be controlled to\nprevent race conditions with HTTP response generation." - } - ], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 224, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L224" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "skipAutoInitialize" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1092, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A storage provider. Used to store the logged-in session." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 167, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L167" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "storage" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1082, - "name": "storageKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional key name used for storing tokens in local storage." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 137, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L137" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1097, - "name": "throwOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 199, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L199" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "throwOnError" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - }, - { - "id": 1093, - "name": "userStorage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A storage provider to store the user profile separately from the session.\nUseful when you need to store the session information in cookies,\nwithout bloating the data with the redundant user object." - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 175, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L175" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "userStorage" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseAuthClientOptions" - }, - "name": "SupabaseAuthClientOptions", - "package": "@supabase/supabase-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1081, 1095, 1084, 1098, 1094, 1096, 1099, 1083, 1100, 1092, 1082, 1097, - 1093 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 129, - "character": 9, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L129" - } - ] - } - } - }, - { - "id": 1074, - "name": "db", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to " - }, - { - "kind": "code", - "text": "`public`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 100, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L100" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1075, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1076, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 101, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L101" - } - ], - "type": { - "type": "reference", - "target": 1111, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "id": 1077, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout in milliseconds for PostgREST requests.\nWhen set, requests will automatically abort after this duration to prevent indefinite hangs." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With timeout", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n db: { timeout: 30000 } // 30 second timeout\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 113, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L113" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1078, - "name": "urlLengthLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum URL length in characters before warnings/errors are triggered.\nDefaults to 8000 characters. Used to provide helpful hints when URLs\nexceed server limits." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "With custom URL length limit", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n db: { urlLengthLimit: 10000 } // Custom limit\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 126, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L126" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1076, 1077, 1078] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 100, - "character": 7, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L100" - } - ] - } - } - }, - { - "id": 1103, - "name": "global", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 231, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L231" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1105, - "name": "fetch", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 235, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L235" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "Fetch" - }, - "name": "Fetch", - "package": "@supabase/supabase-js" - } - }, - { - "id": 1106, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional headers for initializing the client." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 239, - "character": 4, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L239" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1105, 1106] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 231, - "character": 11, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L231" - } - ] - } - } - }, - { - "id": 1101, - "name": "realtime", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options passed to the realtime-js instance" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 229, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L229" - } - ], - "type": { - "type": "reference", - "target": 3273, - "name": "RealtimeClientOptions", - "package": "@supabase/realtime-js" - } - }, - { - "id": 1102, - "name": "storage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 230, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L230" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageClientOptions" - }, - "name": "StorageClientOptions", - "package": "@supabase/storage-js" - } - }, - { - "id": 1110, - "name": "tracePropagation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Enable OpenTelemetry / W3C trace context propagation to Supabase services.\n\nDisabled by default. Pass " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " for the common case (auto-detect an\nactive OpenTelemetry context and inject " - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": " /\n" - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": " headers) or an object for fine-grained control.\n\nRequires " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " to be installed in your application; if\nnot present, the SDK silently no-ops. Trace headers are only attached\nto requests targeting Supabase domains, so third-party hosts called\nthrough a custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " are never tagged.\n\nThe resulting " - }, - { - "kind": "code", - "text": "`trace_id`" - }, - { - "kind": "text", - "text": " appears in Supabase logs (API Gateway, Edge\nFunctions), letting you correlate client-side spans with server-side\nlog entries — including logs forwarded via Log Drains." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Shorthand — opt in with defaults", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient(url, key, { tracePropagation: true })\n```" - } - ] - }, - { - "tag": "@example", - "name": "With an active OpenTelemetry span", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient(url, key, { tracePropagation: true })\nconst tracer = trace.getTracer('my-app')\n\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // Request carries the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - } - ] - }, - { - "tag": "@example", - "name": "Advanced — always propagate, even for non-sampled traces", - "content": [ - { - "kind": "code", - "text": "```ts\nconst supabase = createClient(url, key, {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://supabase.com/docs/guides/telemetry/client-side-tracing" - }, - { - "kind": "text", - "text": "\n" - }, - { - "kind": "text", - "text": " - " - }, - { - "kind": "text", - "text": "https://www.w3.org/TR/trace-context/" - }, - { - "kind": "text", - "text": "\n" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 301, - "character": 2, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L301" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1112, - "name": "TracePropagationOptions", - "package": "@supabase/supabase-js" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1107, 1079, 1074, 1103, 1101, 1102, 1110] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/lib/types.ts", - "line": 96, - "character": 48, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/lib/types.ts#L96" - } - ] - } - } - }, - { - "id": 2103, - "name": "SupportedStorage", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1518, - "character": 12 - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PromisifyMethods" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Storage" - }, - "name": "Storage", - "package": "typescript" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "PromisifyMethods", - "package": "@supabase/auth-js" - }, - { - "type": "reflection", - "declaration": { - "id": 2104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2105, - "name": "isServer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1526, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2105] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1518, - "character": 103 - } - ] - } - } - ] - } - }, - { - "id": 2309, - "name": "UpdateCustomProviderParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing custom provider.\nAll fields are optional. Only provided fields will be updated.\n" - }, - { - "kind": "code", - "text": "`provider_type`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " are immutable and cannot be changed." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1983, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2310, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2314, - "name": "acceptable_client_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional client IDs accepted during token validation" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1991, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2317, - "name": "attribute_mapping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of provider attributes to Supabase user attributes" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1997, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2318, - "name": "authorization_params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters sent with the authorization request" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1999, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2324, - "name": "authorization_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 authorization URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2011, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2312, - "name": "client_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client ID" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1987, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2313, - "name": "client_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth client secret (write-only, not returned in responses)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1989, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2322, - "name": "discovery_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC discovery URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2007, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2320, - "name": "email_optional", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email is optional for this provider" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2003, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2319, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the provider is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2001, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2321, - "name": "issuer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OIDC issuer URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2005, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2327, - "name": "jwks_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "JWKS URI for token verification" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2017, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2311, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1985, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2316, - "name": "pkce_enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether PKCE is enabled" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1995, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2315, - "name": "scopes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth scopes requested during authorization" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1993, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2323, - "name": "skip_nonce_check", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to skip nonce check (OIDC)" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2009, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2325, - "name": "token_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 token URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2013, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2326, - "name": "userinfo_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OAuth2 userinfo URL" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2015, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2314, 2317, 2318, 2324, 2312, 2313, 2322, 2320, 2319, 2321, 2327, 2311, 2316, - 2315, 2323, 2325, 2326 - ] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1983, - "character": 41 - } - ] - } - } - }, - { - "id": 2207, - "name": "UpdateOAuthClientParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters for updating an existing OAuth client.\nAll fields are optional. Only provided fields will be updated.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1751, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2208, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2209, - "name": "client_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable name of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1753, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2210, - "name": "client_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1755, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2213, - "name": "grant_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed grant types" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1761, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2176, - "name": "OAuthClientGrantType", - "package": "@supabase/auth-js" - } - } - }, - { - "id": 2211, - "name": "logo_uri", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URI of the OAuth client's logo" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1757, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2212, - "name": "redirect_uris", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of allowed redirect URIs" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1759, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2214, - "name": "token_endpoint_auth_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Token endpoint authentication method" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1763, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 2181, - "name": "OAuthClientTokenEndpointAuthMethod", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2209, 2210, 2213, 2211, 2212, 2214] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1751, - "character": 38 - } - ] - } - } - }, - { - "id": 1701, - "name": "UserResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 231, - "character": 12 - } - ], - "type": { - "type": "reference", - "target": 1654, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 1702, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1703, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 232, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": 15, - "name": "User", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1703] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 231, - "character": 56 - } - ] - } - } - ], - "name": "RequestResultSafeDestructure", - "package": "@supabase/auth-js" - } - }, - { - "id": 1886, - "name": "VerifyOtpParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 650, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1887, - "name": "VerifyMobileOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1895, - "name": "VerifyEmailOtpParams", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1903, - "name": "VerifyTokenHashParams", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 2464, - "name": "VerifyPasskeyAuthenticationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2370, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2465, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2466, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startAuthentication" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2372, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2467, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.get()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2374, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2466, 2467] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2370, - "character": 48 - } - ] - } - } - }, - { - "id": 2455, - "name": "VerifyPasskeyRegistrationParams", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2359, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2456, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2457, - "name": "challengeId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Challenge ID from startRegistration" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2361, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2458, - "name": "credential", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Serialized credential from navigator.credentials.create()" - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2363, - "character": 4 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/webauthn.ts", - "qualifiedName": "ServerCredentialResponse" - }, - "name": "ServerCredentialResponse", - "package": "@supabase/auth-js" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [2457, 2458] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 2359, - "character": 46 - } - ] - } - } - }, - { - "id": 1636, - "name": "WeakPassword", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 140, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1637, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1639, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 142, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1638, - "name": "reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 141, - "character": 4 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1635, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1639, 1638] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 140, - "character": 27 - } - ] - } - } - }, - { - "id": 1635, - "name": "WeakPasswordReasons", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 139, - "character": 12 - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "name": "WeakPasswordReasons", - "package": "@supabase/auth-js", - "preferValues": true - } - } - } - }, - { - "id": 1885, - "name": "Web3Credentials", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 649, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1850, - "name": "SolanaWeb3Credentials", - "package": "@supabase/auth-js" - }, - { - "type": "reference", - "target": 1868, - "name": "EthereumWeb3Credentials", - "package": "@supabase/auth-js" - } - ] - } - }, - { - "id": 1561, - "name": "AuthAdminApi", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/AuthAdminApi.d.ts", - "line": 2, - "character": 14 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1124, - "name": "GoTrueAdminApi", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1562, - "name": "AuthClient", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/AuthClient.d.ts", - "line": 2, - "character": 14 - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1221, - "name": "GoTrueClient", - "package": "@supabase/auth-js", - "qualifiedName": "default" - } - } - }, - { - "id": 1576, - "name": "lockInternals", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Debug flag for " - }, - { - "kind": "code", - "text": "`navigatorLock`" - }, - { - "kind": "text", - "text": " / " - }, - { - "kind": "code", - "text": "`processLock`" - }, - { - "kind": "text", - "text": ". The auth\nclient ignores both, so this has no client-side effect." - } - ] - } - ], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 14, - "character": 21 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1577, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1578, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": ["@experimental"] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [1578] - } - ], - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 14, - "character": 32 - } - ] - } - } - }, - { - "id": 3412, - "name": "REALTIME_CHANNEL_STATES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 134, - "character": 21 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3414, - "name": "closed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 135, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "closed" - } - }, - { - "id": 3415, - "name": "errored", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 136, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "errored" - } - }, - { - "id": 3416, - "name": "joined", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 137, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "joined" - } - }, - { - "id": 3417, - "name": "joining", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 138, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "joining" - } - }, - { - "id": 3418, - "name": "leaving", - "variant": "declaration", - "kind": 1024, - "flags": { - "isReadonly": true - }, - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 139, - "character": 13 - } - ], - "type": { - "type": "literal", - "value": "leaving" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [3414, 3415, 3416, 3417, 3418] - } - ], - "sources": [ - { - "fileName": "packages/core/realtime-js/dist/module/RealtimeChannel.d.ts", - "line": 134, - "character": 46 - } - ] - } - } - }, - { - "id": 2174, - "name": "SIGN_OUT_SCOPES", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 1665, - "character": 21 - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "global" - }, - { - "type": "literal", - "value": "local" - }, - { - "type": "literal", - "value": "others" - } - ] - } - } - }, - { - "id": 2, - "name": "createClient", - "variant": "declaration", - "kind": 64, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Supabase Client." - } - ], - "blockTags": [ - { - "tag": "@example", - "name": "Creating a Supabase client", - "content": [ - { - "kind": "code", - "text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('profiles').select('*')\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 47, - "character": 13, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L47" - } - ], - "signatures": [ - { - "id": 3, - "name": "createClient", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 47, - "character": 28, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L47" - } - ], - "typeParameters": [ - { - "id": 4, - "name": "Database", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 5, - "name": "SchemaNameOrClientOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 6, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 7, - "name": "PostgrestVersion", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 51, - "character": 8, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L51" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [7] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 51, - "character": 6, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L51" - } - ] - } - } - ] - }, - "default": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - }, - { - "id": 8, - "name": "SchemaName", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "default": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - }, - "trueType": { - "type": "reference", - "target": 5, - "typeArguments": [ - { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "literal", - "value": "public" - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - "trueType": { - "type": "literal", - "value": "public" - }, - "falseType": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Exclude" - }, - "typeArguments": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - }, - { - "type": "literal", - "value": "__InternalSupabase" - } - ], - "name": "Exclude", - "package": "typescript" - } - ] - } - } - } - } - ], - "parameters": [ - { - "id": 9, - "name": "supabaseUrl", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 10, - "name": "supabaseKey", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 11, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1072, - "typeArguments": [ - { - "type": "reference", - "target": 8, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClientOptions", - "package": "@supabase/supabase-js" - } - } - ], - "type": { - "type": "reference", - "target": 941, - "typeArguments": [ - { - "type": "reference", - "target": 4, - "name": "Database", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 5, - "name": "SchemaNameOrClientOptions", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 8, - "name": "SchemaName", - "package": "@supabase/supabase-js", - "refersToTypeParameter": true - } - ], - "name": "SupabaseClient", - "package": "@supabase/supabase-js", - "qualifiedName": "default" - } - } - ] - }, - { - "id": 2522, - "name": "isAuthApiError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 47, - "character": 24 - } - ], - "signatures": [ - { - "id": 2523, - "name": "isAuthApiError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 47, - "character": 24 - } - ], - "parameters": [ - { - "id": 2524, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2561, - "name": "AuthApiError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2519, - "name": "isAuthError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 32, - "character": 24 - } - ], - "signatures": [ - { - "id": 2520, - "name": "isAuthError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 32, - "character": 24 - } - ], - "parameters": [ - { - "id": 2521, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2543, - "name": "AuthError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2528, - "name": "isAuthImplicitGrantRedirectError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 154, - "character": 24 - } - ], - "signatures": [ - { - "id": 2529, - "name": "isAuthImplicitGrantRedirectError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 154, - "character": 24 - } - ], - "parameters": [ - { - "id": 2530, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2666, - "name": "AuthImplicitGrantRedirectError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2531, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 200, - "character": 24 - } - ], - "signatures": [ - { - "id": 2532, - "name": "isAuthPKCECodeVerifierMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 200, - "character": 24 - } - ], - "parameters": [ - { - "id": 2533, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2724, - "name": "AuthPKCECodeVerifierMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2537, - "name": "isAuthRefreshDiscardedError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 238, - "character": 24 - } - ], - "signatures": [ - { - "id": 2538, - "name": "isAuthRefreshDiscardedError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 238, - "character": 24 - } - ], - "parameters": [ - { - "id": 2539, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2758, - "name": "AuthRefreshDiscardedError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2534, - "name": "isAuthRetryableFetchError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 214, - "character": 24 - } - ], - "signatures": [ - { - "id": 2535, - "name": "isAuthRetryableFetchError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 214, - "character": 24 - } - ], - "parameters": [ - { - "id": 2536, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2740, - "name": "AuthRetryableFetchError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2525, - "name": "isAuthSessionMissingError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 94, - "character": 24 - } - ], - "signatures": [ - { - "id": 2526, - "name": "isAuthSessionMissingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 94, - "character": 24 - } - ], - "parameters": [ - { - "id": 2527, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2617, - "name": "AuthSessionMissingError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 2540, - "name": "isAuthWeakPasswordError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 268, - "character": 24 - } - ], - "signatures": [ - { - "id": 2541, - "name": "isAuthWeakPasswordError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/errors.d.ts", - "line": 268, - "character": 24 - } - ], - "parameters": [ - { - "id": 2542, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2775, - "name": "AuthWeakPasswordError", - "package": "@supabase/auth-js" - } - } - } - ] - }, - { - "id": 1563, - "name": "navigatorLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 24 - } - ], - "signatures": [ - { - "id": 1564, - "name": "navigatorLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "GoTrueClient", - "target": 1221 - }, - { - "kind": "text", - "text": ".\n\nYou can turn on debugging by setting the " - }, - { - "kind": "code", - "text": "`supabase.gotrue-js.locks.debug`" - }, - { - "kind": "text", - "text": "\nlocal storage item to " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " - }, - { - "kind": "code", - "text": "`request`" - }, - { - "kind": "text", - "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " - }, - { - "kind": "code", - "text": "`fn`" - }, - { - "kind": "text", - "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: navigatorLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 24 - } - ], - "typeParameters": [ - { - "id": 1565, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1566, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1567, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1568, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1569, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 83 - } - ], - "signatures": [ - { - "id": 1570, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 74, - "character": 83 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1565, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1579, - "name": "processLock", - "variant": "declaration", - "kind": 64, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 24 - } - ], - "signatures": [ - { - "id": 1580, - "name": "processLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "#navigatorLock" - }, - { - "kind": "text", - "text": " in browser environments." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "The auth client coordinates refreshes itself and the server\nresolves concurrent refresh races, so passing " - }, - { - "kind": "code", - "text": "`{ lock: processLock }`" - }, - { - "kind": "text", - "text": "\nto it has no effect. You can safely drop the import from your client setup." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nawait processLock('migrate', 5000, async () => {\n await runMigration()\n})\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 24 - } - ], - "typeParameters": [ - { - "id": 1581, - "name": "R", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 1582, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the lock to be acquired." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1583, - "name": "acquireTimeout", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " - }, - { - "kind": "code", - "text": "`isAcquireTimeout`" - }, - { - "kind": "text", - "text": " set to true." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1584, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operation to run once the lock is acquired." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1585, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 81 - } - ], - "signatures": [ - { - "id": 1586, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/locks.d.ts", - "line": 100, - "character": 81 - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1581, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1581, - "name": "R", - "package": "@supabase/auth-js", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1704, - "name": "Session", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 234, - "character": 17 - } - ], - "target": 42 - }, - { - "id": 1742, - "name": "User", - "variant": "reference", - "kind": 4194304, - "flags": {}, - "sources": [ - { - "fileName": "packages/core/auth-js/dist/module/lib/types.d.ts", - "line": 349, - "character": 17 - } - ], - "target": 15 - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [925, 3393, 3398, 3403, 3407] - }, - { - "title": "Classes", - "children": [ - 2561, 2543, 2666, 2649, 2796, 2633, 2724, 2695, 2758, 2740, 2617, 2579, 2775, 2597, 912, - 890, 879, 901, 1124, 1221, 1571, 57, 830, 141, 729, 559, 2822, 3152, 2813, 850, 941, - 3419 - ] - }, - { - "title": "Interfaces", - "children": [ - 1750, 1707, 2392, 2492, 42, 15, 1961, 2343, 2096, 2228, 2512, 2025, 2166, 2146, 1764, - 1112, 1734, 1743, 1710, 1739, 1895, 1887, 1903, 3431, 3481 - ] - }, - { - "title": "Type Aliases", - "children": [ - 1705, 1589, 1588, 2018, 1810, 2086, 2083, 2093, 2090, 2009, 2013, 2008, 2010, 2011, - 2012, 2128, 2004, 2127, 2129, 2020, 2014, 2005, 2003, 1996, 2382, 2383, 2389, 2390, - 1671, 2488, 2485, 2477, 2478, 2484, 2482, 2475, 2476, 2483, 1662, 1666, 1676, 1680, - 2109, 2288, 2198, 2264, 2332, 2331, 2251, 1122, 1908, 1867, 1868, 1632, 1723, 1722, 868, - 1955, 1945, 1964, 1969, 1965, 1976, 1950, 1939, 1599, 2106, 2130, 2328, 1590, 1995, - 1994, 1992, 1991, 1993, 1977, 2125, 2124, 2126, 1990, 1978, 1989, 1982, 1981, 1983, - 1987, 1906, 2363, 2369, 2182, 2176, 2216, 2180, 2215, 2178, 2181, 2179, 2384, 2379, - 1685, 2252, 2117, 2110, 2429, 2434, 2472, 2438, 2424, 2415, 2420, 2468, 55, 51, 53, - 1640, 1587, 1117, 1121, 1115, 3136, 3150, 3273, 3314, 3321, 3328, 3352, 3333, 3343, - 3362, 3372, 3382, 3391, 2450, 1645, 1654, 2136, 1910, 1774, 1824, 1812, 2444, 1788, - 1793, 1924, 2121, 2175, 1780, 1834, 1850, 1698, 2459, 1642, 1072, 2103, 2309, 2207, - 1701, 1886, 2464, 2455, 1636, 1635, 1885 - ] - }, - { - "title": "Variables", - "children": [1561, 1562, 1576, 3412, 2174] - }, - { - "title": "Functions", - "children": [2, 2522, 2519, 2528, 2531, 2537, 2534, 2525, 2540, 1563, 1579] - }, - { - "title": "References", - "children": [1704, 1742] - } - ], - "sources": [ - { - "fileName": "packages/core/supabase-js/src/index.ts", - "line": 1, - "character": 0, - "url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/supabase-js/src/index.ts#L1" - } - ] - } - ], - "groups": [ - { - "title": "Modules", - "children": [12, 1] - } - ], - "packageName": "@supabase/supabase-js", - "readme": [ - { - "kind": "text", - "text": "
    \n

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

    Supabase JS SDK

    \n\n

    Isomorphic JavaScript SDK for Supabase - combining Auth, Database, Storage, Functions, and Realtime.

    \n\n

    \n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

    \n

    \n\n
    \n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/supabase-js)](https://www.npmjs.com/package/@supabase/supabase-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/supabase-js)](https://pkg.pr.new/~/supabase/supabase-js)\n\n
    \n\n## Usage\n\nFirst of all, you need to install the library:\n\n" - }, - { - "kind": "code", - "text": "```sh\nnpm install @supabase/supabase-js\n```" - }, - { - "kind": "text", - "text": "\n\nThen you're able to import the library and establish the connection with the database:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Create a single supabase client for interacting with your database\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\n```" - }, - { - "kind": "text", - "text": "\n\n### UMD\n\nYou can use plain " - }, - { - "kind": "code", - "text": "`\n```" - }, - { - "kind": "text", - "text": "\n\nor even:\n\n" - }, - { - "kind": "code", - "text": "```html\n\n```" - }, - { - "kind": "text", - "text": "\n\nThen you can use it from a global " - }, - { - "kind": "code", - "text": "`supabase`" - }, - { - "kind": "text", - "text": " variable:\n\n" - }, - { - "kind": "code", - "text": "```html\n\n```" - }, - { - "kind": "text", - "text": "\n\n### ESM\n\nYou can use " - }, - { - "kind": "code", - "text": "`\n```" - }, - { - "kind": "text", - "text": "\n\n### Deno\n\nYou can use supabase-js in the Deno runtime via [JSR](https://jsr.io/@supabase/supabase-js):\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from 'jsr:@supabase/supabase-js@2'\n```" - }, - { - "kind": "text", - "text": "\n\n### Custom " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation\n\n" - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " uses the [" - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " implementation can be provided as an option. This is most useful in environments where " - }, - { - "kind": "code", - "text": "`cross-fetch`" - }, - { - "kind": "text", - "text": " is not compatible, for instance Cloudflare Workers:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Provide a custom `fetch` implementation as an option\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key', {\n global: {\n fetch: (...args) => fetch(...args),\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n### Distributed Tracing with OpenTelemetry\n\nThe Supabase JS SDK can attach W3C/OpenTelemetry trace context headers (" - }, - { - "kind": "code", - "text": "`traceparent`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`tracestate`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`baggage`" - }, - { - "kind": "text", - "text": ") to outgoing requests, enabling end-to-end request tracing from your client application through Supabase services.\n\nTrace propagation is **opt-in** and disabled by default. When enabled, headers are only attached to requests targeting Supabase domains (" - }, - { - "kind": "code", - "text": "`*.supabase.co`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`*.supabase.in`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`localhost`" - }, - { - "kind": "text", - "text": ").\n\n#### Enable trace propagation\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { createClient } from '@supabase/supabase-js'\nimport { trace } from '@opentelemetry/api'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {\n tracePropagation: true,\n})\n\nconst tracer = trace.getTracer('my-app')\nawait tracer.startActiveSpan('fetch-users', async (span) => {\n // This request now includes the active trace context.\n const { data, error } = await supabase.from('users').select('*')\n span.end()\n})\n```" - }, - { - "kind": "text", - "text": "\n\nIf " - }, - { - "kind": "code", - "text": "`@opentelemetry/api`" - }, - { - "kind": "text", - "text": " is not installed or no active context exists, the SDK silently no-ops.\n\n#### Advanced configuration\n\n" - }, - { - "kind": "code", - "text": "```typescript\ninterface TracePropagationOptions {\n // Enable trace propagation (default: false).\n enabled?: boolean\n\n // Respect upstream sampling decisions (default: true).\n // When true, headers are skipped if the upstream trace is not sampled.\n respectSamplingDecision?: boolean\n}\n```" - }, - { - "kind": "text", - "text": "\n\n" - }, - { - "kind": "code", - "text": "```js\n// Always propagate, even for non-sampled traces.\nconst supabase = createClient('https://xyzcompany.supabase.co', 'public-anon-key', {\n tracePropagation: { enabled: true, respectSamplingDecision: false },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Support Policy\n\nThis section outlines the scope of support for various runtime environments in Supabase JavaScript client.\n\n### Node.js\n\nWe only support Node.js versions that are in **Active LTS** or **Maintenance** status as defined by the [official Node.js release schedule](https://nodejs.org/en/about/previous-releases#release-schedule). This means we support versions that are currently receiving long-term support and critical bug fixes.\n\nWhen a Node.js version reaches end-of-life and is no longer in Active LTS or Maintenance status, Supabase will drop it in a **minor release**, and **this won't be considered a breaking change**.\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped in version " - }, - { - "kind": "code", - "text": "`2.79.0`" - }, - { - "kind": "text", - "text": ".\n>\n> If you must use Node.js 18, please use version " - }, - { - "kind": "code", - "text": "`2.78.0`" - }, - { - "kind": "text", - "text": ", which is the last version that supported Node.js 18.\n\n### Deno\n\nWe support Deno versions that are currently receiving active development and security updates. We follow the [official Deno release schedule](https://docs.deno.com/runtime/fundamentals/stability_and_releases/) and only support versions from the " - }, - { - "kind": "code", - "text": "`stable`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`lts`" - }, - { - "kind": "text", - "text": " release channels.\n\nWhen a Deno version reaches end-of-life and is no longer receiving security updates, Supabase will drop it in a **minor release**, and **this won't be considered a breaking change**.\n\n### Browsers\n\nAll modern browsers are supported. We support browsers that provide native " - }, - { - "kind": "code", - "text": "`fetch`" - }, - { - "kind": "text", - "text": " API. For Realtime features, browsers must also support native " - }, - { - "kind": "code", - "text": "`WebSocket`" - }, - { - "kind": "text", - "text": " API.\n\n### Bun\n\nWe support Bun runtime environments. Bun provides native fetch support and is compatible with Node.js APIs. Since Bun does not follow a structured release schedule like Node.js or Deno, we support current stable versions of Bun and may drop support for older versions in minor releases without considering it a breaking change.\n\n### React Native\n\nWe support React Native environments with fetch polyfills provided by the framework. Since React Native does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.\n\n### Cloudflare Workers\n\nWe support Cloudflare Workers runtime environments. Cloudflare Workers provides native fetch support. Since Cloudflare Workers does not follow a structured release schedule, we support current stable versions and may drop support for older versions in minor releases without considering it a breaking change.\n\n### Important Notes\n\n- **Experimental features**: Features marked as experimental may be removed or changed without notice\n\n## Known Build Warnings\n\n### " - }, - { - "kind": "code", - "text": "`UNUSED_EXTERNAL_IMPORT`" - }, - { - "kind": "text", - "text": " in Vite / Rollup / Nuxt\n\nWhen bundling your app, you may see warnings like:\n\n" - }, - { - "kind": "code", - "text": "```\n\"PostgrestError\" is imported from external module \"@supabase/postgrest-js\" but never used in \"...supabase-js/dist/index.mjs\".\n\"FunctionRegion\", \"FunctionsError\", \"FunctionsFetchError\", \"FunctionsHttpError\" and \"FunctionsRelayError\" are imported from external module \"@supabase/functions-js\" but never used in \"...\".\n```" - }, - { - "kind": "text", - "text": "\n\n**This is a false positive — your bundle is fine.** Here is why it happens:\n\n" - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": " re-exports " - }, - { - "kind": "code", - "text": "`PostgrestError`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FunctionsError`" - }, - { - "kind": "text", - "text": ", and related symbols so you can import them directly from " - }, - { - "kind": "code", - "text": "`@supabase/supabase-js`" - }, - { - "kind": "text", - "text": ". However, our build tool merges all imports from the same package into a single import statement in the built output:\n\n" - }, - { - "kind": "code", - "text": "```js\n// dist/index.mjs (simplified)\nimport { PostgrestClient, PostgrestError } from '@supabase/postgrest-js'\n// ^ used internally ^ re-exported for you\n```" - }, - { - "kind": "text", - "text": "\n\nYour bundler checks which names from that import are used _in the code body_, and flags " - }, - { - "kind": "code", - "text": "`PostgrestError`" - }, - { - "kind": "text", - "text": " as unused because it only appears in an " - }, - { - "kind": "code", - "text": "`export`" - }, - { - "kind": "text", - "text": " statement — not called or assigned. The export itself is the usage, but downstream bundlers don't track this correctly. This is a known Rollup/Vite limitation with re-exported external imports.\n\n**Nothing is broken.** Tree-shaking and bundle size are unaffected.\n\nTo suppress the warning:\n\n**Vite / Rollup (" - }, - { - "kind": "code", - "text": "`vite.config.js`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`rollup.config.js`" - }, - { - "kind": "text", - "text": "):**\n\n" - }, - { - "kind": "code", - "text": "```js\nexport default {\n build: {\n rollupOptions: {\n onwarn(warning, warn) {\n if (warning.code === 'UNUSED_EXTERNAL_IMPORT' && warning.exporter?.includes('@supabase/'))\n return\n warn(warning)\n },\n },\n },\n}\n```" - }, - { - "kind": "text", - "text": "\n\n**Nuxt (" - }, - { - "kind": "code", - "text": "`nuxt.config.ts`" - }, - { - "kind": "text", - "text": "):**\n\n" - }, - { - "kind": "code", - "text": "```ts\nexport default defineNuxtConfig({\n vite: {\n build: {\n rollupOptions: {\n onwarn(warning, warn) {\n if (warning.code === 'UNUSED_EXTERNAL_IMPORT' && warning.exporter?.includes('@supabase/'))\n return\n warn(warning)\n },\n },\n },\n },\n})\n```" - }, - { - "kind": "text", - "text": "\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" - }, - { - "kind": "relative-link", - "text": "../../../CONTRIBUTING.md", - "target": 3 - }, - { - "kind": "text", - "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n### Building\n\n" - }, - { - "kind": "code", - "text": "```bash\n# From the monorepo root\npnpm nx build supabase-js\n\n# Or with watch mode for development\npnpm nx build supabase-js --watch\n```" - }, - { - "kind": "text", - "text": "\n\n### Testing\n\nThere's a complete guide on how to set up your environment for running locally the " - }, - { - "kind": "code", - "text": "`supabase-js`" - }, - { - "kind": "text", - "text": " integration tests. Please refer to [TESTING.md](" - }, - { - "kind": "relative-link", - "text": "./TESTING.md", - "target": 4 - }, - { - "kind": "text", - "text": ").\n\n## Badges\n\n[![Coverage Status](https://coveralls.io/repos/github/supabase/supabase-js/badge.svg?branch=master)](https://coveralls.io/github/supabase/supabase-js?branch=master)" - } - ], - "symbolIdMap": { - "1": { - "sourceFileName": "src/index.ts", - "qualifiedName": "" - }, - "2": { - "sourceFileName": "src/index.ts", - "qualifiedName": "createClient" - }, - "3": { - "sourceFileName": "src/index.ts", - "qualifiedName": "createClient" - }, - "4": { - "sourceFileName": "src/index.ts", - "qualifiedName": "Database" - }, - "5": { - "sourceFileName": "src/index.ts", - "qualifiedName": "SchemaNameOrClientOptions" - }, - "6": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__type" - }, - "7": { - "sourceFileName": "src/index.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "8": { - "sourceFileName": "src/index.ts", - "qualifiedName": "SchemaName" - }, - "9": { - "sourceFileName": "src/index.ts", - "qualifiedName": "supabaseUrl" - }, - "10": { - "sourceFileName": "src/index.ts", - "qualifiedName": "supabaseKey" - }, - "11": { - "sourceFileName": "src/index.ts", - "qualifiedName": "options" - }, - "12": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "" - }, - "13": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "CorsHeaders" - }, - "14": { - "sourceFileName": "src/cors.ts", - "qualifiedName": "corsHeaders" - }, - "15": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User" - }, - "16": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.id" - }, - "17": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.app_metadata" - }, - "18": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.user_metadata" - }, - "19": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.aud" - }, - "20": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.confirmation_sent_at" - }, - "21": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.recovery_sent_at" - }, - "22": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email_change_sent_at" - }, - "23": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.new_email" - }, - "24": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.new_phone" - }, - "25": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.invited_at" - }, - "26": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.action_link" - }, - "27": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email" - }, - "28": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.phone" - }, - "29": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.created_at" - }, - "30": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.confirmed_at" - }, - "31": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.email_confirmed_at" - }, - "32": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.phone_confirmed_at" - }, - "33": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.last_sign_in_at" - }, - "34": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.role" - }, - "35": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.updated_at" - }, - "36": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.identities" - }, - "37": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.is_anonymous" - }, - "38": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.is_sso_user" - }, - "39": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.factors" - }, - "40": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.deleted_at" - }, - "41": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User.banned_until" - }, - "42": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session" - }, - "43": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.provider_token" - }, - "44": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.provider_refresh_token" - }, - "45": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.access_token" - }, - "46": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.refresh_token" - }, - "47": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.expires_in" - }, - "48": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.expires_at" - }, - "49": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.token_type" - }, - "50": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session.user" - }, - "51": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestResponse" - }, - "52": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "53": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestSingleResponse" - }, - "54": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "55": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestMaybeSingleResponse" - }, - "56": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "T" - }, - "57": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder" - }, - "58": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "59": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder" - }, - "60": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ClientOptions" - }, - "61": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.Result$1" - }, - "62": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ThrowOnError" - }, - "63": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "64": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "65": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "66": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "67": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "68": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "69": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "70": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "71": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "72": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "73": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "74": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "75": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "76": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "77": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "78": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "79": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "80": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "81": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "82": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "83": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "84": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "85": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "86": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "87": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "88": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "89": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "90": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "91": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "92": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "93": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "94": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "95": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "96": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "97": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "98": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "99": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "100": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "101": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "102": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "103": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "104": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "105": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "106": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "107": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "108": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "109": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "110": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "111": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "112": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "113": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "114": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "115": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "116": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "117": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "118": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "119": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "120": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "121": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "122": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "123": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "124": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "125": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "127": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.returns" - }, - "128": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.returns" - }, - "129": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "130": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "131": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "132": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "133": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "134": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "135": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "136": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "137": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "138": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ClientOptions" - }, - "139": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.Result$1" - }, - "140": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.ThrowOnError" - }, - "141": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder" - }, - "142": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "143": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder" - }, - "144": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions" - }, - "145": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Schema" - }, - "146": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Row" - }, - "147": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Result$1" - }, - "148": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.RelationName" - }, - "149": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Relationships" - }, - "150": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Method" - }, - "151": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "152": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "153": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "154": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "155": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "156": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "157": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "158": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "159": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "160": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "161": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "162": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "163": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "164": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "165": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "166": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "167": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "168": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "169": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "170": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "171": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "172": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.eq" - }, - "173": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.eq" - }, - "174": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "175": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "176": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "177": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "178": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.neq" - }, - "179": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.neq" - }, - "180": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "181": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "182": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "183": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "184": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "185": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "186": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "187": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "188": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gt" - }, - "189": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "190": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "191": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "192": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "193": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "194": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "195": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "196": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.gte" - }, - "197": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "198": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "199": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "200": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "201": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "202": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "203": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "204": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lt" - }, - "205": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "206": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "207": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "208": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "209": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "210": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "211": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "212": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.lte" - }, - "213": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "214": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "215": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "216": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "217": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "218": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "219": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "220": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.like" - }, - "221": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "222": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "223": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "224": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "225": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "226": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "227": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "228": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAllOf" - }, - "229": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "230": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "231": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "232": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "233": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "234": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "235": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "236": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.likeAnyOf" - }, - "237": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "238": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "239": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "240": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "241": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "242": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "243": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "244": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilike" - }, - "245": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "246": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "247": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "248": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "249": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "250": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "251": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "252": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAllOf" - }, - "253": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "254": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "255": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "256": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "257": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "258": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "259": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "260": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ilikeAnyOf" - }, - "261": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "262": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "patterns" - }, - "263": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "264": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "265": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "266": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "267": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "268": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexMatch" - }, - "269": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "270": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "271": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "272": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "273": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "274": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "275": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "276": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.regexIMatch" - }, - "277": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "278": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "pattern" - }, - "279": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "280": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "281": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "282": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "283": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "284": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.is" - }, - "285": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "286": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "287": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.isDistinct" - }, - "288": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.isDistinct" - }, - "289": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "290": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "291": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "292": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.in" - }, - "293": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.in" - }, - "294": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "295": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "296": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "297": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.notIn" - }, - "298": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.notIn" - }, - "299": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "300": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "301": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "302": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "303": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "304": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "305": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "306": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "307": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.contains" - }, - "308": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "309": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "310": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "311": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "312": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "313": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "314": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "315": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.containedBy" - }, - "316": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "317": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "318": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "319": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "320": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "321": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "322": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "323": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGt" - }, - "324": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "325": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "326": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "327": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "328": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "329": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "330": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "331": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeGte" - }, - "332": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "333": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "334": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "335": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "336": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "337": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "338": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "339": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLt" - }, - "340": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "341": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "342": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "343": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "344": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "345": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "346": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "347": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeLte" - }, - "348": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "349": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "350": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "351": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "352": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "353": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "354": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "355": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.rangeAdjacent" - }, - "356": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "357": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "range" - }, - "358": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "359": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "360": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "361": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "362": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "363": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.overlaps" - }, - "364": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "365": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "366": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "367": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "368": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "369": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "370": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "371": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "372": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "373": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.config" - }, - "374": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.type" - }, - "375": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.textSearch" - }, - "376": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "377": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "378": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "379": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "380": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.config" - }, - "381": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.type" - }, - "382": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "383": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "384": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "385": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "386": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.match" - }, - "387": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "query" - }, - "388": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "389": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "390": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "391": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "392": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "393": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "394": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "395": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "396": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "397": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "398": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "399": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.not" - }, - "400": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "401": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "402": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "403": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.or" - }, - "404": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.or" - }, - "405": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "filters" - }, - "406": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "407": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "408": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "409": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "410": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "411": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "412": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "413": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "414": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "415": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "416": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.filter" - }, - "417": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "418": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "operator" - }, - "419": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "420": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "421": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "422": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "423": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResultOne" - }, - "424": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "425": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "426": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "427": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "428": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "429": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "430": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "431": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "432": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "433": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "434": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "435": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "436": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "437": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "438": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "439": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "440": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "441": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "442": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "443": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "444": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "445": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "446": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "447": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "448": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "449": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "450": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "451": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "452": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "453": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "454": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "455": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "456": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "457": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "458": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "count" - }, - "459": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "460": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "461": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "462": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "463": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "464": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "465": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "from" - }, - "466": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "to" - }, - "467": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__2" - }, - "468": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "469": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "470": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "471": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "472": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "473": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "signal" - }, - "474": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "475": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "476": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "477": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "478": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "479": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "480": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "481": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "482": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "483": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "484": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "485": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "486": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "487": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "488": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.analyze" - }, - "489": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.verbose" - }, - "490": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.settings" - }, - "491": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.buffers" - }, - "492": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.wal" - }, - "493": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.format" - }, - "494": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "495": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "496": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "497": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "498": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "499": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "500": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "501": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "502": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "503": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "504": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "505": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "506": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "507": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "508": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "509": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "510": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "511": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "512": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "513": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "514": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "515": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "516": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "517": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "518": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "519": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "520": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "521": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "522": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "523": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "524": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "525": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "526": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "527": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "528": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "529": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "530": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "531": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "532": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "533": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "534": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "535": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "536": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "537": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "538": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "539": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "540": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "541": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "542": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "543": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "544": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "545": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "546": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "547": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "548": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "549": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "550": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "551": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "552": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.ClientOptions" - }, - "553": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Schema" - }, - "554": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Row" - }, - "555": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Result$1" - }, - "556": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.RelationName" - }, - "557": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Relationships" - }, - "558": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestFilterBuilder.Method" - }, - "559": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder" - }, - "560": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.__constructor" - }, - "561": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder" - }, - "562": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions" - }, - "563": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Schema" - }, - "564": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Row" - }, - "565": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Result$1" - }, - "566": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.RelationName" - }, - "567": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Relationships" - }, - "568": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Method" - }, - "569": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "builder" - }, - "570": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "571": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.method" - }, - "572": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.url" - }, - "573": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "574": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "575": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.body" - }, - "576": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldThrowOnError" - }, - "577": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.signal" - }, - "578": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "579": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "580": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "581": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "582": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "583": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "584": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "585": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "586": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.isMaybeSingle" - }, - "587": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.shouldStripNulls" - }, - "588": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "589": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "590": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "591": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.select" - }, - "592": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "593": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResultOne" - }, - "594": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "595": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "596": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "597": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "598": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "599": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "600": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "601": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "602": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "603": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "604": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "605": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "606": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "607": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "608": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "609": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "610": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "611": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "612": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ColumnName" - }, - "613": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "614": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "615": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "616": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "617": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "618": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "619": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.order" - }, - "620": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "column" - }, - "621": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "622": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "623": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ascending" - }, - "624": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.nullsFirst" - }, - "625": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "626": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "627": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.limit" - }, - "628": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "count" - }, - "629": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "630": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "631": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "632": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "633": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "634": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.range" - }, - "635": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "from" - }, - "636": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "to" - }, - "637": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__2" - }, - "638": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "639": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.foreignTable" - }, - "640": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.referencedTable" - }, - "641": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "642": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.abortSignal" - }, - "643": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "signal" - }, - "644": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "645": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.single" - }, - "646": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "647": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "648": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maybeSingle" - }, - "649": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "650": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "651": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.csv" - }, - "652": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "653": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.geojson" - }, - "654": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "655": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.explain" - }, - "656": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "657": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "658": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.analyze" - }, - "659": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.verbose" - }, - "660": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.settings" - }, - "661": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.buffers" - }, - "662": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.wal" - }, - "663": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.format" - }, - "664": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "665": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.rollback" - }, - "666": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "667": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.returns" - }, - "668": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "669": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "670": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.maxAffected" - }, - "671": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "672": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.method" - }, - "673": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.url" - }, - "674": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.headers" - }, - "675": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.schema" - }, - "676": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.body" - }, - "677": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldThrowOnError" - }, - "678": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.signal" - }, - "679": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.fetch" - }, - "680": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "681": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "682": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "683": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "684": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "685": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "686": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "687": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.isMaybeSingle" - }, - "688": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.shouldStripNulls" - }, - "689": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.urlLengthLimit" - }, - "690": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retryEnabled" - }, - "691": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "692": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.throwOnError" - }, - "693": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "694": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.stripNulls" - }, - "695": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "696": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.setHeader" - }, - "697": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "name" - }, - "698": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "699": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "700": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.retry" - }, - "701": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "enabled" - }, - "702": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "703": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.then" - }, - "704": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult1" - }, - "705": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "TResult2" - }, - "706": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onfulfilled" - }, - "707": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "708": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "709": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "value" - }, - "710": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "onrejected" - }, - "711": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "712": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "713": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "reason" - }, - "714": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "715": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestBuilder.overrideTypes" - }, - "716": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "NewResult" - }, - "717": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Options" - }, - "718": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "719": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "720": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "721": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.merge" - }, - "722": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.ClientOptions" - }, - "723": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Schema" - }, - "724": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Row" - }, - "725": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Result$1" - }, - "726": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.RelationName" - }, - "727": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Relationships" - }, - "728": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestTransformBuilder.Method" - }, - "729": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder" - }, - "730": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.__constructor" - }, - "731": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder" - }, - "732": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions" - }, - "733": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Schema" - }, - "734": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relation$1" - }, - "735": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.RelationName" - }, - "736": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relationships" - }, - "737": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "738": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Relationships" - }, - "739": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "url" - }, - "740": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "741": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "742": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.headers" - }, - "743": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.schema" - }, - "744": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.fetch" - }, - "745": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "746": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "747": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "748": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "749": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "750": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "751": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "752": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "753": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.retry" - }, - "754": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.url" - }, - "755": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.headers" - }, - "756": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.schema" - }, - "757": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.signal" - }, - "758": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.fetch" - }, - "759": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "760": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "761": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "762": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "763": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "764": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "765": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "766": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.urlLengthLimit" - }, - "767": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.retry" - }, - "769": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.select" - }, - "770": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.select" - }, - "771": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Query" - }, - "772": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "ResultOne" - }, - "773": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "columns" - }, - "774": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "options" - }, - "775": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "776": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.head" - }, - "777": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "778": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "779": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.insert" - }, - "780": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.insert" - }, - "781": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "782": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "783": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "784": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "785": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "786": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "787": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "788": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "789": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "790": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "791": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.defaultToNull" - }, - "792": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.upsert" - }, - "793": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.upsert" - }, - "794": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "795": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "796": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "797": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "798": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "799": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Insert" - }, - "800": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "801": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "802": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.onConflict" - }, - "803": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.ignoreDuplicates" - }, - "804": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "805": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "806": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.defaultToNull" - }, - "807": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.update" - }, - "808": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.update" - }, - "809": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "Row" - }, - "810": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "values" - }, - "811": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "812": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Update" - }, - "813": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__1" - }, - "814": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "815": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "816": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "817": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.delete" - }, - "818": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.delete" - }, - "819": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__0" - }, - "820": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "821": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.count" - }, - "822": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "823": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.ClientOptions" - }, - "824": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Schema" - }, - "825": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relation$1" - }, - "826": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.RelationName" - }, - "827": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestQueryBuilder.Relationships" - }, - "828": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "829": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.Relationships" - }, - "830": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError" - }, - "831": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.__constructor" - }, - "832": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError" - }, - "833": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "context" - }, - "834": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "835": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "836": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "837": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "838": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "839": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.details" - }, - "840": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.hint" - }, - "841": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.code" - }, - "842": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.toJSON" - }, - "843": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "PostgrestError.toJSON" - }, - "844": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type" - }, - "845": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.name" - }, - "846": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.message" - }, - "847": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.details" - }, - "848": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.hint" - }, - "849": { - "sourceFileName": "../postgrest-js/src/PostgrestError.ts", - "qualifiedName": "__type.code" - }, - "850": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "851": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.__constructor" - }, - "852": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError" - }, - "853": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "message" - }, - "854": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "status" - }, - "855": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "statusCode" - }, - "856": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "namespace" - }, - "857": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.status" - }, - "858": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.statusCode" - }, - "859": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "860": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageApiError.toJSON" - }, - "861": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type" - }, - "862": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.name" - }, - "863": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.message" - }, - "864": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.status" - }, - "865": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "__type.statusCode" - }, - "866": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError.__isStorageError" - }, - "867": { - "sourceFileName": "../storage-js/src/lib/common/errors.ts", - "qualifiedName": "StorageError.namespace" - }, - "868": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionInvokeOptions" - }, - "869": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "870": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.headers" - }, - "871": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "872": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.__index" - }, - "874": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.method" - }, - "875": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.region" - }, - "876": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.body" - }, - "877": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.signal" - }, - "878": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.timeout" - }, - "879": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "880": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError.__constructor" - }, - "881": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsHttpError" - }, - "882": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "883": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "884": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "885": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "886": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "887": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "888": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "889": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "890": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "891": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError.__constructor" - }, - "892": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsFetchError" - }, - "893": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "894": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "895": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "896": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "897": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "898": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "899": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "900": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "901": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "902": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError.__constructor" - }, - "903": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsRelayError" - }, - "904": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "905": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "906": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "907": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "908": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "909": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "910": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "911": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "912": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError" - }, - "913": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.__constructor" - }, - "914": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError" - }, - "915": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "message" - }, - "916": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "name" - }, - "917": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "context" - }, - "918": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.context" - }, - "919": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "920": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionsError.toJSON" - }, - "921": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type" - }, - "922": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.name" - }, - "923": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.message" - }, - "924": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "__type.context" - }, - "925": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion" - }, - "926": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.Any" - }, - "927": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast1" - }, - "928": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApNortheast2" - }, - "929": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSouth1" - }, - "930": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast1" - }, - "931": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.ApSoutheast2" - }, - "932": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.CaCentral1" - }, - "933": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuCentral1" - }, - "934": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest1" - }, - "935": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest2" - }, - "936": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.EuWest3" - }, - "937": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.SaEast1" - }, - "938": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsEast1" - }, - "939": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsWest1" - }, - "940": { - "sourceFileName": "../functions-js/src/types.ts", - "qualifiedName": "FunctionRegion.UsWest2" - }, - "941": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default" - }, - "942": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.__constructor" - }, - "943": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default" - }, - "944": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Database" - }, - "945": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaNameOrClientOptions" - }, - "946": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "947": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "948": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaName" - }, - "949": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Schema" - }, - "950": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "951": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "952": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "953": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "954": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "955": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "956": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "957": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "958": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "959": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "960": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "961": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "supabaseUrl" - }, - "962": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "supabaseKey" - }, - "963": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "options" - }, - "964": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.auth" - }, - "965": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.realtime" - }, - "966": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storage" - }, - "967": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.realtimeUrl" - }, - "968": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.authUrl" - }, - "969": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storageUrl" - }, - "970": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functionsUrl" - }, - "971": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rest" - }, - "972": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.storageKey" - }, - "973": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.fetch" - }, - "974": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "975": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "976": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "977": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "978": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "979": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "980": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "981": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.changedAccessToken" - }, - "982": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.accessToken" - }, - "983": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "984": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "985": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.headers" - }, - "986": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.settings" - }, - "987": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.supabaseUrl" - }, - "988": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.supabaseKey" - }, - "989": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functions" - }, - "990": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.functions" - }, - "991": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "992": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "993": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "TableName" - }, - "994": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "Table" - }, - "995": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "relation" - }, - "996": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.from" - }, - "997": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "ViewName" - }, - "998": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "View" - }, - "999": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "relation" - }, - "1000": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.schema" - }, - "1001": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.schema" - }, - "1002": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "DynamicSchema" - }, - "1003": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "schema" - }, - "1004": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rpc" - }, - "1005": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.rpc" - }, - "1006": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "FnName" - }, - "1007": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "Args" - }, - "1008": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "FilterBuilder" - }, - "1009": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "fn" - }, - "1010": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "args" - }, - "1011": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "options" - }, - "1012": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1013": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.head" - }, - "1014": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.get" - }, - "1015": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.count" - }, - "1016": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.channel" - }, - "1017": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.channel" - }, - "1018": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "name" - }, - "1019": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "opts" - }, - "1020": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.getChannels" - }, - "1021": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.getChannels" - }, - "1022": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeChannel" - }, - "1023": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeChannel" - }, - "1024": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "channel" - }, - "1025": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "1026": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "1055": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Database" - }, - "1056": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaNameOrClientOptions" - }, - "1057": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1058": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1059": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.SchemaName" - }, - "1060": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.Schema" - }, - "1061": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "default.ClientOptions" - }, - "1062": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1063": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1064": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1065": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.__InternalSupabase" - }, - "1066": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1067": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1068": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1069": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1070": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type" - }, - "1071": { - "sourceFileName": "src/SupabaseClient.ts", - "qualifiedName": "__type.PostgrestVersion" - }, - "1072": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SupabaseClientOptions" - }, - "1073": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1074": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.db" - }, - "1075": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1076": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.schema" - }, - "1077": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.timeout" - }, - "1078": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.urlLengthLimit" - }, - "1079": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.auth" - }, - "1080": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1081": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "1082": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "1083": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "1084": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "1085": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1086": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1087": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "url" - }, - "1088": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "params" - }, - "1089": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1090": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1092": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1093": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "1094": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "1095": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "1096": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "1097": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "1098": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "1099": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "1100": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "1101": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.realtime" - }, - "1102": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1103": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.global" - }, - "1104": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1105": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "1106": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "1107": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.accessToken" - }, - "1108": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1109": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1110": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.tracePropagation" - }, - "1111": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "SchemaName" - }, - "1112": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions" - }, - "1113": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions.enabled" - }, - "1114": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "TracePropagationOptions.respectSamplingDecision" - }, - "1115": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryResult" - }, - "1116": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1117": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryData" - }, - "1118": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type" - }, - "1119": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1120": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "T" - }, - "1121": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "QueryError" - }, - "1122": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DatabaseWithoutInternals" - }, - "1123": { - "sourceFileName": "src/lib/types.ts", - "qualifiedName": "DB" - }, - "1124": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "1125": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.__constructor" - }, - "1126": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default" - }, - "1127": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__0" - }, - "1128": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1129": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.url" - }, - "1130": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.headers" - }, - "1131": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1132": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "1134": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.fetch" - }, - "1135": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1136": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1137": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1138": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1139": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1140": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1141": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1142": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.experimental" - }, - "1143": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.mfa" - }, - "1144": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.oauth" - }, - "1145": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.customProviders" - }, - "1146": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.passkey" - }, - "1147": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.url" - }, - "1148": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.headers" - }, - "1149": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1150": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.__index" - }, - "1152": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.fetch" - }, - "1153": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1154": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1155": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1156": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1157": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1158": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1159": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1160": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.experimental" - }, - "1161": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "1162": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.signOut" - }, - "1163": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "jwt" - }, - "1164": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "scope" - }, - "1165": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1166": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1167": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1168": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "1169": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.inviteUserByEmail" - }, - "1170": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "email" - }, - "1171": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "options" - }, - "1172": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1173": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1174": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.redirectTo" - }, - "1175": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "1176": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.generateLink" - }, - "1177": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "1178": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "1179": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.createUser" - }, - "1180": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "1181": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "1182": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.listUsers" - }, - "1183": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "params" - }, - "1184": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1185": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1186": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1187": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "1188": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.aud" - }, - "1189": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1190": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1191": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.data" - }, - "1192": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type" - }, - "1193": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.users" - }, - "1194": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "__type.error" - }, - "1195": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "1196": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.getUserById" - }, - "1197": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "1198": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "1199": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.updateUserById" - }, - "1200": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "uid" - }, - "1201": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "attributes" - }, - "1202": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "1203": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "default.deleteUser" - }, - "1204": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "id" - }, - "1205": { - "sourceFileName": "../auth-js/src/GoTrueAdminApi.ts", - "qualifiedName": "shouldSoftDelete" - }, - "1221": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "1223": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.__constructor" - }, - "1224": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default" - }, - "1225": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1227": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.admin" - }, - "1228": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.mfa" - }, - "1229": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.oauth" - }, - "1230": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.passkey" - }, - "1231": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.storageKey" - }, - "1232": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.flowType" - }, - "1233": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1234": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1235": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1236": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1237": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks" - }, - "1238": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "value" - }, - "1239": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1240": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1241": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1242": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1243": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.jwks_cached_at" - }, - "1244": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "value" - }, - "1245": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshToken" - }, - "1246": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.persistSession" - }, - "1247": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.storage" - }, - "1248": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.userStorage" - }, - "1249": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.memoryStorage" - }, - "1250": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1251": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1253": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stateChangeEmitters" - }, - "1254": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshTicker" - }, - "1255": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.autoRefreshTickTimeout" - }, - "1256": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.visibilityChangedCallback" - }, - "1257": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1258": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1259": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshingDeferred" - }, - "1260": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._sessionRemovalEpoch" - }, - "1261": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initializePromise" - }, - "1262": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.detectSessionInUrl" - }, - "1263": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1264": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1265": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "url" - }, - "1266": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1267": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1268": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1270": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.url" - }, - "1271": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.headers" - }, - "1272": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1273": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.__index" - }, - "1275": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.hasCustomAuthorizationHeader" - }, - "1276": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.suppressGetSessionWarning" - }, - "1277": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.fetch" - }, - "1278": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1279": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "1280": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "1281": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "1282": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "1283": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "1284": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "1285": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lock" - }, - "1286": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lockAcquired" - }, - "1287": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.pendingInLock" - }, - "1288": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.throwOnError" - }, - "1289": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.lockAcquireTimeout" - }, - "1290": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.experimental" - }, - "1291": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.broadcastChannel" - }, - "1292": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.logDebugMessages" - }, - "1293": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.logger" - }, - "1294": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1295": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1296": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "message" - }, - "1297": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "args" - }, - "1298": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "1299": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.isThrowOnErrorEnabled" - }, - "1303": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "1304": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.initialize" - }, - "1306": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "1307": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInAnonymously" - }, - "1308": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1309": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "1310": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signUp" - }, - "1311": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1312": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "1313": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPassword" - }, - "1314": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1315": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "1316": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOAuth" - }, - "1317": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1318": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "1319": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.exchangeCodeForSession" - }, - "1320": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "authCode" - }, - "1321": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "1322": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithWeb3" - }, - "1323": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1324": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1325": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1326": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1327": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1328": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "1329": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1330": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1331": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1332": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1333": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1334": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.user" - }, - "1335": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1339": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "1340": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithIdToken" - }, - "1341": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1342": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "1343": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithOtp" - }, - "1344": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1345": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "1346": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.verifyOtp" - }, - "1347": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1348": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "1349": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithSSO" - }, - "1350": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "params" - }, - "1351": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "1352": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.reauthenticate" - }, - "1354": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "1355": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resend" - }, - "1356": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1357": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "1358": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getSession" - }, - "1359": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1360": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1361": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1362": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1363": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1364": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1365": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1366": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1367": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1368": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1369": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1370": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1371": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1372": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.session" - }, - "1373": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1377": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "1378": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUser" - }, - "1379": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "1381": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "1382": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.updateUser" - }, - "1383": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "1384": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1385": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1386": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1387": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._updateUser" - }, - "1388": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._updateUser" - }, - "1389": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "attributes" - }, - "1390": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1391": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1392": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1393": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "1394": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.setSession" - }, - "1395": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1396": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1397": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "1398": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1399": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._setSession" - }, - "1400": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._setSession" - }, - "1401": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1402": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1403": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.access_token" - }, - "1404": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1405": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "1406": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.refreshSession" - }, - "1407": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1408": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1409": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1410": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._refreshSession" - }, - "1411": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._refreshSession" - }, - "1412": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "currentSession" - }, - "1413": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1414": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.refresh_token" - }, - "1418": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "1419": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signOut" - }, - "1420": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1421": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1422": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1423": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._signOut" - }, - "1424": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default._signOut" - }, - "1425": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__0" - }, - "1426": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1427": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1428": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1429": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1430": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "1431": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1432": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1433": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "1434": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "1435": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1436": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1437": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1438": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "1439": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.onAuthStateChange" - }, - "1440": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "callback" - }, - "1441": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1442": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1443": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "event" - }, - "1444": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "session" - }, - "1445": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1446": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1447": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1448": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.subscription" - }, - "1450": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "1451": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.resetPasswordForEmail" - }, - "1452": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "email" - }, - "1453": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1454": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1455": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.redirectTo" - }, - "1456": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.captchaToken" - }, - "1457": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1458": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1459": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1460": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1461": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1462": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1463": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1464": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "1465": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getUserIdentities" - }, - "1466": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1467": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1468": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1469": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.identities" - }, - "1470": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1471": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1472": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1473": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1474": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1475": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1476": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1477": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.linkIdentity" - }, - "1478": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1481": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "1482": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.unlinkIdentity" - }, - "1483": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "identity" - }, - "1484": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1485": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1486": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "1487": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1488": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1489": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1490": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1502": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "1503": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.startAutoRefresh" - }, - "1504": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "1505": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.stopAutoRefresh" - }, - "1506": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "1507": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.dispose" - }, - "1525": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "1526": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.getClaims" - }, - "1527": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "jwt" - }, - "1528": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "options" - }, - "1529": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1530": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1531": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.allowExpired" - }, - "1532": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.jwks" - }, - "1533": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1534": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.keys" - }, - "1535": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1536": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1537": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1538": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.claims" - }, - "1539": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.header" - }, - "1540": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.signature" - }, - "1541": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1542": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1543": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1544": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1545": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type" - }, - "1546": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.data" - }, - "1547": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "__type.error" - }, - "1548": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "1549": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.signInWithPasskey" - }, - "1550": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1551": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "1552": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "default.registerPasskey" - }, - "1553": { - "sourceFileName": "../auth-js/src/GoTrueClient.ts", - "qualifiedName": "credentials" - }, - "1561": { - "sourceFileName": "../auth-js/src/AuthAdminApi.ts", - "qualifiedName": "AuthAdminApi" - }, - "1562": { - "sourceFileName": "../auth-js/src/AuthClient.ts", - "qualifiedName": "AuthClient" - }, - "1563": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "1564": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "navigatorLock" - }, - "1565": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "R" - }, - "1566": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "name" - }, - "1567": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "1568": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "fn" - }, - "1569": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1570": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1571": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "1572": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.__constructor" - }, - "1573": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "NavigatorLockAcquireTimeoutError" - }, - "1574": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "message" - }, - "1575": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "LockAcquireTimeoutError.isAcquireTimeout" - }, - "1576": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "internals" - }, - "1577": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1578": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type.debug" - }, - "1579": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "1580": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "processLock" - }, - "1581": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "R" - }, - "1582": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "name" - }, - "1583": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "acquireTimeout" - }, - "1584": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "fn" - }, - "1585": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1586": { - "sourceFileName": "../auth-js/src/lib/locks.ts", - "qualifiedName": "__type" - }, - "1587": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Provider" - }, - "1588": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthChangeEventMFA" - }, - "1589": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthChangeEvent" - }, - "1590": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "LockFunc" - }, - "1591": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1592": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1593": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "name" - }, - "1594": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "acquireTimeout" - }, - "1595": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "fn" - }, - "1596": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1597": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1598": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "R" - }, - "1599": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueClientOptions" - }, - "1600": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1601": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1602": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.headers" - }, - "1603": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1604": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1606": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.storageKey" - }, - "1607": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.detectSessionInUrl" - }, - "1608": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1609": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1610": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "url" - }, - "1611": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "1612": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1613": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1615": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.autoRefreshToken" - }, - "1616": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.persistSession" - }, - "1617": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.storage" - }, - "1618": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userStorage" - }, - "1619": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.fetch" - }, - "1620": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.flowType" - }, - "1621": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.debug" - }, - "1622": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1623": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1624": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "message" - }, - "1625": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "args" - }, - "1626": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lock" - }, - "1627": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.hasCustomAuthorizationHeader" - }, - "1628": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.throwOnError" - }, - "1629": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lockAcquireTimeout" - }, - "1630": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipAutoInitialize" - }, - "1631": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.experimental" - }, - "1632": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ExperimentalFeatureFlags" - }, - "1633": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1634": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkey" - }, - "1635": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPasswordReasons" - }, - "1636": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "WeakPassword" - }, - "1637": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1638": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.reasons" - }, - "1639": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1640": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Prettify" - }, - "1641": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1642": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "StrictOmit" - }, - "1643": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1644": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "K" - }, - "1645": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequestResult" - }, - "1646": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1647": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1648": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1649": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1650": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1651": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1652": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1653": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ErrorType" - }, - "1654": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequestResultSafeDestructure" - }, - "1655": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1656": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1657": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1658": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1659": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1660": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1661": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1662": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthResponse" - }, - "1663": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1664": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1665": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1666": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthResponsePassword" - }, - "1667": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1668": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1669": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1670": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.weak_password" - }, - "1671": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOtpResponse" - }, - "1672": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1673": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1674": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1675": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.messageId" - }, - "1676": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthTokenResponse" - }, - "1677": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1678": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1679": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1680": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthTokenResponsePassword" - }, - "1681": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1682": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1683": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "1684": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.weakPassword" - }, - "1685": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthResponse" - }, - "1686": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1687": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1688": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1689": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1690": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1691": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1692": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1693": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1694": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1695": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1696": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1697": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "1698": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SSOResponse" - }, - "1699": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1700": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1701": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserResponse" - }, - "1702": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1703": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1704": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Session" - }, - "1705": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMRMethod" - }, - "1706": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1707": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry" - }, - "1708": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry.method" - }, - "1709": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AMREntry.timestamp" - }, - "1710": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity" - }, - "1711": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.id" - }, - "1712": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.user_id" - }, - "1713": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_data" - }, - "1714": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1715": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1717": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.identity_id" - }, - "1718": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.provider" - }, - "1719": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.created_at" - }, - "1720": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.last_sign_in_at" - }, - "1721": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserIdentity.updated_at" - }, - "1722": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "FactorType" - }, - "1723": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Factor" - }, - "1724": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1725": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "1726": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "1727": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factor_type" - }, - "1728": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.status" - }, - "1729": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "1730": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "1731": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.last_challenged_at" - }, - "1732": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Type" - }, - "1733": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Status" - }, - "1734": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata" - }, - "1735": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.provider" - }, - "1736": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.providers" - }, - "1737": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAppMetadata.__index" - }, - "1739": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserMetadata" - }, - "1740": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserMetadata.__index" - }, - "1742": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "User" - }, - "1743": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes" - }, - "1744": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.current_password" - }, - "1745": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.email" - }, - "1746": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.phone" - }, - "1747": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.password" - }, - "1748": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.nonce" - }, - "1749": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UserAttributes.data" - }, - "1750": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes" - }, - "1751": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.user_metadata" - }, - "1752": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.app_metadata" - }, - "1753": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.email_confirm" - }, - "1754": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.phone_confirm" - }, - "1755": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.ban_duration" - }, - "1756": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.role" - }, - "1757": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.password_hash" - }, - "1758": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AdminUserAttributes.id" - }, - "1759": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "nonce" - }, - "1760": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "email" - }, - "1761": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "password" - }, - "1762": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "phone" - }, - "1763": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "current_password" - }, - "1764": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription" - }, - "1765": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.id" - }, - "1766": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.callback" - }, - "1767": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1768": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1769": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "event" - }, - "1770": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "session" - }, - "1771": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Subscription.unsubscribe" - }, - "1772": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1773": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1774": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInAnonymouslyCredentials" - }, - "1775": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1776": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1777": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1778": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1779": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1780": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignUpWithPasswordCredentials" - }, - "1781": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1782": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1783": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1784": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1785": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1786": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1787": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "1788": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasswordCredentials" - }, - "1789": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1790": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1791": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1792": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1793": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasswordlessCredentials" - }, - "1794": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1795": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1796": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1797": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1798": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1799": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "1800": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1801": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1802": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1803": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1804": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1805": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1806": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.shouldCreateUser" - }, - "1807": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "1808": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1809": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.channel" - }, - "1810": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthFlowType" - }, - "1811": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1812": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithOAuthCredentials" - }, - "1813": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1814": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1815": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1816": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1817": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1818": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "1819": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.queryParams" - }, - "1820": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1821": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "1823": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1824": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithIdTokenCredentials" - }, - "1825": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1826": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider" - }, - "1827": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1828": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token" - }, - "1829": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1830": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nonce" - }, - "1831": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1832": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1833": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1834": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SolanaWallet" - }, - "1835": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1836": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signIn" - }, - "1837": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1838": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1839": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "inputs" - }, - "1840": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.publicKey" - }, - "1841": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1842": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.toBase58" - }, - "1843": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1844": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1845": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signMessage" - }, - "1846": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1847": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1848": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "message" - }, - "1849": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "encoding" - }, - "1850": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SolanaWeb3Credentials" - }, - "1851": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1852": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1853": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1854": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1855": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1856": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1857": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1858": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1859": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signInWithSolana" - }, - "1860": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1861": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1862": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1863": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1864": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1865": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1866": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1867": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EthereumWallet" - }, - "1868": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EthereumWeb3Credentials" - }, - "1869": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1870": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1871": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.wallet" - }, - "1872": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.statement" - }, - "1873": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1874": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1875": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.url" - }, - "1876": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1877": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signInWithEthereum" - }, - "1878": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1879": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.chain" - }, - "1880": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.message" - }, - "1881": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signature" - }, - "1882": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1883": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1884": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1885": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Web3Credentials" - }, - "1886": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyOtpParams" - }, - "1887": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams" - }, - "1888": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.phone" - }, - "1889": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.token" - }, - "1890": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.type" - }, - "1891": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyMobileOtpParams.options" - }, - "1892": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1893": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1894": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1895": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams" - }, - "1896": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.email" - }, - "1897": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.token" - }, - "1898": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.type" - }, - "1899": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyEmailOtpParams.options" - }, - "1900": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1901": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1902": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1903": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams" - }, - "1904": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.token_hash" - }, - "1905": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyTokenHashParams.type" - }, - "1906": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MobileOtpType" - }, - "1907": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1908": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "EmailOtpType" - }, - "1909": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1910": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ResendParams" - }, - "1911": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1912": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1913": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1914": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1915": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1916": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.emailRedirectTo" - }, - "1917": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1918": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1919": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1920": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.phone" - }, - "1921": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1922": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1923": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1924": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithSSO" - }, - "1925": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1926": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providerId" - }, - "1927": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1928": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1929": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1930": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1931": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1932": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1933": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.domain" - }, - "1934": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1935": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1936": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirectTo" - }, - "1937": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "1938": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "1939": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateSignupLinkParams" - }, - "1940": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1941": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1942": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1943": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.password" - }, - "1944": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1945": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateInviteOrMagiclinkParams" - }, - "1946": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1947": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1948": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1949": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1950": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateRecoveryLinkParams" - }, - "1951": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1952": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1953": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1954": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1955": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateEmailChangeLinkParams" - }, - "1956": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1957": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "1958": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "1959": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.newEmail" - }, - "1960": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "1961": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions" - }, - "1962": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.data" - }, - "1963": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkOptions.redirectTo" - }, - "1964": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkParams" - }, - "1965": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkResponse" - }, - "1966": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1967": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.properties" - }, - "1968": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "1969": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkProperties" - }, - "1970": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1971": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.action_link" - }, - "1972": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_otp" - }, - "1973": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.hashed_token" - }, - "1974": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_to" - }, - "1975": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.verification_type" - }, - "1976": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GenerateLinkType" - }, - "1977": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollParams" - }, - "1978": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAUnenrollParams" - }, - "1979": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1980": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factorId" - }, - "1981": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyTOTPParams" - }, - "1982": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyPhoneParams" - }, - "1983": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParamFields" - }, - "1984": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1985": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.webauthn" - }, - "1986": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1987": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyWebauthnParams" - }, - "1988": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "1989": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAVerifyParams" - }, - "1990": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFATOTPChannel" - }, - "1991": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeTOTPParams" - }, - "1992": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengePhoneParams" - }, - "1993": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeWebauthnParams" - }, - "1994": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeParams" - }, - "1995": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAChallengeAndVerifyParams" - }, - "1996": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponseData" - }, - "1997": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "1998": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.access_token" - }, - "1999": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_type" - }, - "2000": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_in" - }, - "2001": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.refresh_token" - }, - "2002": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2003": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAVerifyResponse" - }, - "2004": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollResponse" - }, - "2005": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAUnenrollResponse" - }, - "2006": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2007": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2008": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeTOTPResponse" - }, - "2009": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengePhoneResponse" - }, - "2010": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponse" - }, - "2011": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnResponseDataJSON" - }, - "2012": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeWebauthnServerResponse" - }, - "2013": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAChallengeResponse" - }, - "2014": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAListFactorsResponse" - }, - "2015": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2016": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.all" - }, - "2017": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "T" - }, - "2018": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthenticatorAssuranceLevels" - }, - "2019": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2020": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAGetAuthenticatorAssuranceLevelResponse" - }, - "2021": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2022": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.currentLevel" - }, - "2023": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nextLevel" - }, - "2024": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.currentAuthenticationMethods" - }, - "2025": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi" - }, - "2026": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2027": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2028": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2029": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2030": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2031": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2032": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2033": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.enroll" - }, - "2034": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2035": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2036": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2037": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2038": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2039": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2040": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2041": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2042": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2043": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2044": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2045": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2046": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2047": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2048": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2049": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2050": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2051": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2052": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2053": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2054": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2055": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2056": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2057": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2058": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "data" - }, - "2059": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "error" - }, - "2060": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challenge" - }, - "2061": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2062": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2063": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2064": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2065": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2066": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2067": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2068": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2069": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.verify" - }, - "2070": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2071": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "2072": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.unenroll" - }, - "2073": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2074": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "2075": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.challengeAndVerify" - }, - "2076": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2077": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "2078": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.listFactors" - }, - "2079": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "2080": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" - }, - "2081": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "jwt" - }, - "2082": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueMFAApi.webauthn" - }, - "2083": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorResponse" - }, - "2084": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2085": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2086": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminDeleteFactorParams" - }, - "2087": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2088": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2089": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2090": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsResponse" - }, - "2091": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2092": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.factors" - }, - "2093": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAAdminListFactorsParams" - }, - "2094": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2095": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2096": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi" - }, - "2097": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "2098": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.listFactors" - }, - "2099": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2100": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "2101": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" - }, - "2102": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2103": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SupportedStorage" - }, - "2104": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2105": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.isServer" - }, - "2106": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "InitializeResult" - }, - "2107": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2108": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2109": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CallRefreshTokenResult" - }, - "2110": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "Pagination" - }, - "2111": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2112": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.nextPage" - }, - "2113": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.lastPage" - }, - "2114": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.total" - }, - "2115": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.__index" - }, - "2117": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PageParams" - }, - "2118": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2119": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.page" - }, - "2120": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.perPage" - }, - "2121": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignOut" - }, - "2122": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2123": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2124": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollTOTPParams" - }, - "2125": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollPhoneParams" - }, - "2126": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "MFAEnrollWebauthnParams" - }, - "2127": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollTOTPResponse" - }, - "2128": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollPhoneResponse" - }, - "2129": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthMFAEnrollWebauthnResponse" - }, - "2130": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtHeader" - }, - "2131": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2132": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.alg" - }, - "2133": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2134": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.kid" - }, - "2135": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.typ" - }, - "2136": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RequiredClaims" - }, - "2137": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2138": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "2139": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "2140": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2141": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "2142": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "2143": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "2144": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "2145": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "2146": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload" - }, - "2147": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.email" - }, - "2148": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.phone" - }, - "2149": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.is_anonymous" - }, - "2150": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.jti" - }, - "2151": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.nbf" - }, - "2152": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.app_metadata" - }, - "2153": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.user_metadata" - }, - "2154": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.amr" - }, - "2155": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.ref" - }, - "2156": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iss" - }, - "2157": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.sub" - }, - "2158": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2159": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.exp" - }, - "2160": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.iat" - }, - "2161": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.role" - }, - "2162": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aal" - }, - "2163": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session_id" - }, - "2164": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JwtPayload.__index" - }, - "2166": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK" - }, - "2167": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.kty" - }, - "2168": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2169": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.key_ops" - }, - "2170": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.alg" - }, - "2171": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.kid" - }, - "2172": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "JWK.__index" - }, - "2174": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SIGN_OUT_SCOPES" - }, - "2175": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignOutScope" - }, - "2176": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientGrantType" - }, - "2177": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2178": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientResponseType" - }, - "2179": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientType" - }, - "2180": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientRegistrationType" - }, - "2181": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientTokenEndpointAuthMethod" - }, - "2182": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClient" - }, - "2183": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2184": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2185": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2186": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2187": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_type" - }, - "2188": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2189": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.registration_type" - }, - "2190": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2191": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2192": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2193": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2194": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "2195": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2196": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2197": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "2198": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CreateOAuthClientParams" - }, - "2199": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2200": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2201": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2202": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2203": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2204": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.response_types" - }, - "2205": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2206": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2207": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UpdateOAuthClientParams" - }, - "2208": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2209": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_name" - }, - "2210": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_uri" - }, - "2211": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2212": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uris" - }, - "2213": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.grant_types" - }, - "2214": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint_auth_method" - }, - "2215": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientResponse" - }, - "2216": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthClientListResponse" - }, - "2217": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2218": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2219": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2220": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "2221": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.aud" - }, - "2222": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2223": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2224": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2225": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2226": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clients" - }, - "2227": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2228": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi" - }, - "2229": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "2230": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.listClients" - }, - "2231": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2232": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "2233": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.createClient" - }, - "2234": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2235": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "2236": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.getClient" - }, - "2237": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2238": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "2239": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.updateClient" - }, - "2240": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2241": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2242": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "2243": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" - }, - "2244": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2245": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2246": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2247": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2248": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "2249": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" - }, - "2250": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "clientId" - }, - "2251": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderType" - }, - "2252": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OIDCDiscoveryDocument" - }, - "2253": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2254": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2255": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_endpoint" - }, - "2256": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_endpoint" - }, - "2257": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2258": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_endpoint" - }, - "2259": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.revocation_endpoint" - }, - "2260": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_scopes" - }, - "2261": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_response_types" - }, - "2262": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_subject_types" - }, - "2263": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.supported_id_token_signing_algs" - }, - "2264": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomOAuthProvider" - }, - "2265": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2266": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2267": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "2268": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "2269": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2270": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2271": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2272": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2273": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2274": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2275": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2276": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2277": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2278": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2279": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2280": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2281": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2282": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2283": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2284": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2285": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_document" - }, - "2286": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2287": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.updated_at" - }, - "2288": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CreateCustomProviderParams" - }, - "2289": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2290": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.provider_type" - }, - "2291": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.identifier" - }, - "2292": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2293": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2294": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2295": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2296": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2297": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2298": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2299": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2300": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2301": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2302": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2303": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2304": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2305": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2306": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2307": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2308": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2309": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "UpdateCustomProviderParams" - }, - "2310": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2311": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2312": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_id" - }, - "2313": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client_secret" - }, - "2314": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.acceptable_client_ids" - }, - "2315": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2316": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.pkce_enabled" - }, - "2317": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.attribute_mapping" - }, - "2318": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_params" - }, - "2319": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.enabled" - }, - "2320": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email_optional" - }, - "2321": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.issuer" - }, - "2322": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.discovery_url" - }, - "2323": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skip_nonce_check" - }, - "2324": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_url" - }, - "2325": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.token_url" - }, - "2326": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userinfo_url" - }, - "2327": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.jwks_uri" - }, - "2328": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "ListCustomProvidersParams" - }, - "2329": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2330": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.type" - }, - "2331": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderResponse" - }, - "2332": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "CustomProviderListResponse" - }, - "2333": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2334": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2335": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2336": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "2337": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2338": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2339": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2340": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2341": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.providers" - }, - "2342": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2343": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi" - }, - "2344": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "2345": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" - }, - "2346": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2347": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "2348": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" - }, - "2349": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2350": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "2351": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" - }, - "2352": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2353": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "2354": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" - }, - "2355": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2356": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2357": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "2358": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" - }, - "2359": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "identifier" - }, - "2360": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2361": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.data" - }, - "2362": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.error" - }, - "2363": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationClient" - }, - "2364": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2365": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2366": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.name" - }, - "2367": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.uri" - }, - "2368": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.logo_uri" - }, - "2369": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthAuthorizationDetails" - }, - "2370": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2371": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.authorization_id" - }, - "2372": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_uri" - }, - "2373": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "2374": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2375": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2376": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2377": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.email" - }, - "2378": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scope" - }, - "2379": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthRedirect" - }, - "2380": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2381": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.redirect_url" - }, - "2382": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthAuthorizationDetailsResponse" - }, - "2383": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthConsentResponse" - }, - "2384": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "OAuthGrant" - }, - "2385": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2386": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.client" - }, - "2387": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.scopes" - }, - "2388": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.granted_at" - }, - "2389": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthGrantsResponse" - }, - "2390": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthRevokeGrantResponse" - }, - "2391": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2392": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi" - }, - "2393": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "2394": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" - }, - "2395": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2396": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "2397": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.approveAuthorization" - }, - "2398": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2399": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2400": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2401": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "2402": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "2403": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.denyAuthorization" - }, - "2404": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "authorizationId" - }, - "2405": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2406": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2407": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.skipBrowserRedirect" - }, - "2408": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "2409": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.listGrants" - }, - "2410": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "2411": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthOAuthServerApi.revokeGrant" - }, - "2412": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "options" - }, - "2413": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2414": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.clientId" - }, - "2415": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationOptionsResponse" - }, - "2416": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2417": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2418": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2419": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "2420": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyRegistrationVerifyParams" - }, - "2421": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2422": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2423": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2424": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyMetadata" - }, - "2425": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2426": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2427": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "2428": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2429": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationOptionsResponse" - }, - "2430": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2431": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2432": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2433": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.expires_at" - }, - "2434": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyAuthenticationVerifyParams" - }, - "2435": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2436": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challenge_id" - }, - "2437": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2438": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyListItem" - }, - "2439": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2440": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.id" - }, - "2441": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendly_name" - }, - "2442": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.created_at" - }, - "2443": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.last_used_at" - }, - "2444": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "SignInWithPasskeyCredentials" - }, - "2445": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2446": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2447": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2448": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "2449": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "2450": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "RegisterPasskeyCredentials" - }, - "2451": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2452": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2453": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2454": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.signal" - }, - "2455": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyPasskeyRegistrationParams" - }, - "2456": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2457": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "2458": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2459": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "StartPasskeyAuthenticationParams" - }, - "2460": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2461": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.options" - }, - "2462": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2463": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.captchaToken" - }, - "2464": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "VerifyPasskeyAuthenticationParams" - }, - "2465": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2466": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.challengeId" - }, - "2467": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.credential" - }, - "2468": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyUpdateParams" - }, - "2469": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2470": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2471": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.friendlyName" - }, - "2472": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "PasskeyDeleteParams" - }, - "2473": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2474": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2475": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationOptionsResponse" - }, - "2476": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyRegistrationVerifyResponse" - }, - "2477": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationOptionsResponse" - }, - "2478": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAuthenticationVerifyResponse" - }, - "2479": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2480": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.session" - }, - "2481": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.user" - }, - "2482": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyListResponse" - }, - "2483": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyUpdateResponse" - }, - "2484": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyDeleteResponse" - }, - "2485": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminListParams" - }, - "2486": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2487": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2488": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyAdminDeleteParams" - }, - "2489": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type" - }, - "2490": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.userId" - }, - "2491": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "__type.passkeyId" - }, - "2492": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi" - }, - "2493": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "2494": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startRegistration" - }, - "2495": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "2496": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyRegistration" - }, - "2497": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2498": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "2499": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.startAuthentication" - }, - "2500": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2501": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "2502": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.verifyAuthentication" - }, - "2503": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2504": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "2505": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.list" - }, - "2506": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "2507": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.update" - }, - "2508": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2509": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "2510": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "AuthPasskeyApi.delete" - }, - "2511": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2512": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi" - }, - "2513": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "2514": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.listPasskeys" - }, - "2515": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2516": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "2517": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "GoTrueAdminPasskeyApi.deletePasskey" - }, - "2518": { - "sourceFileName": "../auth-js/src/lib/types.ts", - "qualifiedName": "params" - }, - "2519": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "2520": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthError" - }, - "2521": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2522": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "2523": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthApiError" - }, - "2524": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2525": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "2526": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthSessionMissingError" - }, - "2527": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2528": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "2529": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthImplicitGrantRedirectError" - }, - "2530": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2531": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "2532": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthPKCECodeVerifierMissingError" - }, - "2533": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2534": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "2535": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRetryableFetchError" - }, - "2536": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2537": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "2538": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthRefreshDiscardedError" - }, - "2539": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2540": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "2541": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "isAuthWeakPasswordError" - }, - "2542": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "error" - }, - "2543": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "2544": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__constructor" - }, - "2545": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError" - }, - "2546": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2547": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2548": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2549": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2550": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2551": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "2552": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2553": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2554": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2555": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2556": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2557": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2558": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2559": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2560": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2561": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "2562": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError.__constructor" - }, - "2563": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError" - }, - "2564": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2565": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2566": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2567": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthApiError.status" - }, - "2568": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2569": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2570": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2571": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2572": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2573": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2574": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2575": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2576": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2577": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2578": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2579": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "2580": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.__constructor" - }, - "2581": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError" - }, - "2582": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2583": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "originalError" - }, - "2584": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthUnknownError.originalError" - }, - "2585": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2586": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2587": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.status" - }, - "2588": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2589": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2590": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2591": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2592": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2593": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2594": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2595": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2596": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2597": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "2598": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.__constructor" - }, - "2599": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError" - }, - "2600": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2601": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "name" - }, - "2602": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2603": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "code" - }, - "2604": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2605": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2606": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2607": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2608": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2609": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2610": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2611": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2612": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2613": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2614": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2615": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2616": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2617": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "2618": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError.__constructor" - }, - "2619": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthSessionMissingError" - }, - "2620": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2621": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2622": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2623": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2624": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2625": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2626": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2627": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2628": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2629": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2630": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2631": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2632": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2633": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "2634": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError.__constructor" - }, - "2635": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidTokenResponseError" - }, - "2636": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2637": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2638": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2639": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2640": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2641": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2642": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2643": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2644": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2645": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2646": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2647": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2648": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2649": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "2650": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError.__constructor" - }, - "2651": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidCredentialsError" - }, - "2652": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2653": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2654": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2655": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2656": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2657": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2658": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2659": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2660": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2661": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2662": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2663": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2664": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2665": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2666": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "2667": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.__constructor" - }, - "2668": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError" - }, - "2669": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2670": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "details" - }, - "2671": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2672": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2673": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2674": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.details" - }, - "2675": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2676": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2677": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2678": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "2679": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" - }, - "2680": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2681": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2682": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2683": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2684": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2685": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2686": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "2687": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2688": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2689": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2690": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2691": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2692": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2693": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2694": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2695": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "2696": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.__constructor" - }, - "2697": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError" - }, - "2698": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2699": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "details" - }, - "2700": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2701": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2702": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2703": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.details" - }, - "2704": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2705": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2706": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2707": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "2708": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" - }, - "2709": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2710": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2711": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2712": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2713": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2714": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2715": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.details" - }, - "2716": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2717": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.error" - }, - "2718": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2719": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2720": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2721": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2722": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2723": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2724": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "2725": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError.__constructor" - }, - "2726": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthPKCECodeVerifierMissingError" - }, - "2727": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2728": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2729": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2730": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2731": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2732": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2733": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2734": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2735": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2736": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2737": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2738": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2739": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2740": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "2741": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError.__constructor" - }, - "2742": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRetryableFetchError" - }, - "2743": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2744": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2745": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2746": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2747": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2748": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2749": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2750": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2751": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2752": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2753": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2754": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2755": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2756": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2757": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2758": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "2759": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError.__constructor" - }, - "2760": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthRefreshDiscardedError" - }, - "2761": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2762": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2763": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2764": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2765": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2766": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2767": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2768": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2769": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2770": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2771": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2772": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2773": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2774": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2775": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "2776": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.__constructor" - }, - "2777": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError" - }, - "2778": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2779": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "status" - }, - "2780": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "reasons" - }, - "2781": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.reasons" - }, - "2782": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "2783": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthWeakPasswordError.toJSON" - }, - "2784": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2785": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2786": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2787": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2788": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2789": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2790": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.reasons" - }, - "2791": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2792": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2793": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2794": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2795": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2796": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "2797": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError.__constructor" - }, - "2798": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthInvalidJwtError" - }, - "2799": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "message" - }, - "2800": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.name" - }, - "2801": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "CustomAuthError.status" - }, - "2802": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.code" - }, - "2803": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2804": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.__isAuthError" - }, - "2805": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2806": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "AuthError.toJSON" - }, - "2807": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type" - }, - "2808": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.name" - }, - "2809": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.message" - }, - "2810": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.status" - }, - "2811": { - "sourceFileName": "../auth-js/src/lib/errors.ts", - "qualifiedName": "__type.code" - }, - "2812": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2813": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "2814": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.__constructor" - }, - "2815": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default" - }, - "2816": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "channel" - }, - "2817": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "opts" - }, - "2818": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.channel" - }, - "2819": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "2820": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "default.state" - }, - "2822": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "2823": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.__constructor" - }, - "2824": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default" - }, - "2825": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "topic" - }, - "2826": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "params" - }, - "2827": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "socket" - }, - "2828": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.topic" - }, - "2829": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.params" - }, - "2830": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.socket" - }, - "2831": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.bindings" - }, - "2832": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subTopic" - }, - "2833": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.broadcastEndpointURL" - }, - "2834": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.private" - }, - "2835": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presence" - }, - "2836": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2837": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2838": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.state" - }, - "2839": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "state" - }, - "2840": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "2841": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinedOnce" - }, - "2842": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "2843": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.timeout" - }, - "2844": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "2845": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.joinPush" - }, - "2846": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "2847": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.rejoinTimer" - }, - "2848": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "2849": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.subscribe" - }, - "2850": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2851": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2852": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2853": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "status" - }, - "2854": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "err" - }, - "2855": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "2857": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "2858": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.presenceState" - }, - "2859": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2860": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2861": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2863": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "2864": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "2865": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.track" - }, - "2866": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2867": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2868": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2870": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "2871": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2872": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2874": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "2875": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.untrack" - }, - "2876": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "2877": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2878": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2880": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2881": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2882": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2883": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2884": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2885": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2886": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2887": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2888": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2889": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2890": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2891": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2892": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2894": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2895": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2896": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2897": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2898": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2899": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2900": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2901": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2902": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2903": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2904": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2905": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2907": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2908": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2909": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2910": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2911": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2912": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2913": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2914": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2915": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2916": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2917": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2918": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2920": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2921": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2922": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2923": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2924": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2925": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2926": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2927": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2928": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2929": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2930": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2931": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2933": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2934": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2935": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2936": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2937": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2938": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2939": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2940": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2941": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2942": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2944": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2945": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2946": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2947": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2948": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2949": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2950": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2951": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2952": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2953": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2955": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2956": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2957": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2958": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2959": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2960": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2961": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2962": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2963": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2964": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2966": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2967": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2968": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2969": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2970": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2971": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2972": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2973": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "2974": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2975": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "2977": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2978": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2979": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2980": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2981": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2982": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2983": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "2984": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "2985": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "2986": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2987": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2988": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "2989": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2990": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2991": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "2992": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2993": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "2994": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "2995": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "2996": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "2997": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "2998": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "2999": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3001": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3002": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3003": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3004": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3006": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3007": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3008": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3009": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3010": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3011": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3012": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3013": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3014": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3015": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3016": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3017": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.meta" - }, - "3018": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3019": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replayed" - }, - "3020": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.id" - }, - "3021": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3022": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3023": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3024": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3025": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3026": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3027": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3028": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3029": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3030": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3031": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3032": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3033": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3034": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3035": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3036": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3037": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3038": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3039": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3041": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3042": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3043": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3044": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3045": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3046": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3047": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3048": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3049": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3050": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3051": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3052": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3053": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3054": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3055": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3056": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3058": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3059": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3060": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3061": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3062": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3063": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3064": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3065": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3066": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3067": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3068": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3069": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3070": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3071": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3072": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3073": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3075": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3076": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3077": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3078": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3079": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3080": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3081": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3082": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3083": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3084": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3085": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3086": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3087": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.on" - }, - "3088": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3089": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3090": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3092": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "type" - }, - "3093": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "filter" - }, - "3094": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "3095": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "callback" - }, - "3096": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3097": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3098": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3099": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "3100": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.httpSend" - }, - "3101": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "event" - }, - "3102": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3103": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "3104": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3105": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.timeout" - }, - "3106": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3107": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "3108": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3109": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.success" - }, - "3110": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.status" - }, - "3111": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.error" - }, - "3112": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "3113": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.send" - }, - "3114": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "args" - }, - "3115": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3116": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.type" - }, - "3117": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3118": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.payload" - }, - "3119": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3121": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "opts" - }, - "3122": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3123": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3125": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "3126": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.updateJoinPayload" - }, - "3127": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "payload" - }, - "3128": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "3129": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.unsubscribe" - }, - "3130": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "timeout" - }, - "3131": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "3132": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.teardown" - }, - "3133": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "3134": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "default.copyBindings" - }, - "3135": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "other" - }, - "3136": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelOptions" - }, - "3137": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3138": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.config" - }, - "3139": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3140": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.broadcast" - }, - "3141": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3142": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.self" - }, - "3143": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.ack" - }, - "3144": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.replay" - }, - "3145": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.presence" - }, - "3146": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3147": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.key" - }, - "3148": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.enabled" - }, - "3149": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.private" - }, - "3150": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimeChannelSendResponse" - }, - "3151": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3152": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "3153": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.__constructor" - }, - "3154": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default" - }, - "3155": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "endPoint" - }, - "3156": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "options" - }, - "3157": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channels" - }, - "3158": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.accessTokenValue" - }, - "3159": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.accessToken" - }, - "3160": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3161": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3162": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.apiKey" - }, - "3163": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.httpEndpoint" - }, - "3164": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.headers" - }, - "3165": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3166": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3168": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.params" - }, - "3169": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3170": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3172": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.ref" - }, - "3173": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.logLevel" - }, - "3174": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.fetch" - }, - "3175": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "3176": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "fetch" - }, - "3177": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "input" - }, - "3178": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "init" - }, - "3179": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "fetch" - }, - "3180": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "input" - }, - "3181": { - "sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts", - "qualifiedName": "init" - }, - "3182": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.worker" - }, - "3183": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.workerUrl" - }, - "3184": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.workerRef" - }, - "3185": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.serializer" - }, - "3186": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "3187": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endPoint" - }, - "3188": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "3189": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.timeout" - }, - "3190": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "3191": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.transport" - }, - "3192": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "3193": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatCallback" - }, - "3194": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "3195": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatIntervalMs" - }, - "3196": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "3197": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.heartbeatTimer" - }, - "3198": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "3199": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.pendingHeartbeatRef" - }, - "3200": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "3201": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectTimer" - }, - "3202": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "3203": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.vsn" - }, - "3204": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "3205": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.encode" - }, - "3206": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "3207": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.decode" - }, - "3208": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "3209": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.reconnectAfterMs" - }, - "3210": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3211": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3212": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "3213": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "3214": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendBuffer" - }, - "3215": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3216": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3217": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "3218": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.stateChangeCallbacks" - }, - "3219": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3220": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.open" - }, - "3221": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.close" - }, - "3222": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.error" - }, - "3223": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.message" - }, - "3230": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "3231": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connect" - }, - "3232": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "3233": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.endpointURL" - }, - "3234": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "3235": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.disconnect" - }, - "3236": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "code" - }, - "3237": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "reason" - }, - "3238": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "3239": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.getChannels" - }, - "3240": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "3241": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeChannel" - }, - "3242": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "channel" - }, - "3243": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "3244": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.removeAllChannels" - }, - "3245": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "3246": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.log" - }, - "3247": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "3248": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "3249": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3250": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "3251": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.connectionState" - }, - "3252": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "3253": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnected" - }, - "3254": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "3255": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isConnecting" - }, - "3256": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "3257": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.isDisconnecting" - }, - "3258": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "3259": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.channel" - }, - "3260": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "topic" - }, - "3261": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "params" - }, - "3262": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "3263": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.push" - }, - "3264": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3265": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "3266": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.setAuth" - }, - "3267": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "token" - }, - "3268": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "3269": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.sendHeartbeat" - }, - "3270": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "3271": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "default.onHeartbeat" - }, - "3272": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "callback" - }, - "3273": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeClientOptions" - }, - "3274": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3275": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.transport" - }, - "3276": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.timeout" - }, - "3277": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatIntervalMs" - }, - "3278": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.heartbeatCallback" - }, - "3279": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3280": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3281": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "status" - }, - "3282": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "latency" - }, - "3283": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.vsn" - }, - "3284": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.logger" - }, - "3285": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3286": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3287": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "kind" - }, - "3288": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "msg" - }, - "3289": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "data" - }, - "3290": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.encode" - }, - "3291": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.decode" - }, - "3292": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.reconnectAfterMs" - }, - "3293": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3294": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3295": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "tries" - }, - "3296": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.headers" - }, - "3297": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3298": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3300": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.params" - }, - "3301": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3302": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.__index" - }, - "3304": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.log_level" - }, - "3305": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.logLevel" - }, - "3306": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.fetch" - }, - "3307": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.worker" - }, - "3308": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.workerUrl" - }, - "3309": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.accessToken" - }, - "3310": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3311": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3312": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.disconnectOnEmptyChannelsAfterMs" - }, - "3313": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.sessionStorage" - }, - "3314": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeMessage" - }, - "3315": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3316": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.topic" - }, - "3317": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.event" - }, - "3318": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.payload" - }, - "3319": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.ref" - }, - "3320": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type.join_ref" - }, - "3321": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesFilter" - }, - "3322": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3323": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.event" - }, - "3324": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.schema" - }, - "3325": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.table" - }, - "3326": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.filter" - }, - "3327": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3328": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresChangesPayload" - }, - "3329": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3330": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3331": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3333": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresInsertPayload" - }, - "3334": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3335": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3336": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3337": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3338": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3339": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3340": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3341": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3343": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresUpdatePayload" - }, - "3344": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3345": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3346": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3347": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3348": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3349": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3350": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3352": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "RealtimePostgresDeletePayload" - }, - "3353": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3354": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.eventType" - }, - "3355": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.new" - }, - "3356": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3357": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.old" - }, - "3358": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "T" - }, - "3359": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3360": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.__index" - }, - "3362": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceJoinPayload" - }, - "3363": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3364": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "3365": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "3366": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "3367": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.newPresences" - }, - "3368": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3369": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3370": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3372": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceLeavePayload" - }, - "3373": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3374": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.event" - }, - "3375": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.key" - }, - "3376": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.currentPresences" - }, - "3377": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.leftPresences" - }, - "3378": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3379": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3380": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3382": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "RealtimePresenceState" - }, - "3383": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3384": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3386": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "T" - }, - "3387": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3388": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type.__index" - }, - "3390": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "__type" - }, - "3391": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "RealtimeRemoveChannelResponse" - }, - "3392": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "__type" - }, - "3393": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES" - }, - "3394": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.BROADCAST" - }, - "3395": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.PRESENCE" - }, - "3396": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.POSTGRES_CHANGES" - }, - "3397": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_LISTEN_TYPES.SYSTEM" - }, - "3398": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT" - }, - "3399": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL" - }, - "3400": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT" - }, - "3401": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE" - }, - "3402": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE" - }, - "3403": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS" - }, - "3404": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.SYNC" - }, - "3405": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.JOIN" - }, - "3406": { - "sourceFileName": "../realtime-js/src/RealtimePresence.ts", - "qualifiedName": "REALTIME_PRESENCE_LISTEN_EVENTS.LEAVE" - }, - "3407": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES" - }, - "3408": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.SUBSCRIBED" - }, - "3409": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.TIMED_OUT" - }, - "3410": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CLOSED" - }, - "3411": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR" - }, - "3412": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "REALTIME_CHANNEL_STATES" - }, - "3413": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type" - }, - "3414": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.closed" - }, - "3415": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.errored" - }, - "3416": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.joined" - }, - "3417": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.joining" - }, - "3418": { - "sourceFileName": "../realtime-js/src/RealtimeChannel.ts", - "qualifiedName": "__type.leaving" - }, - "3419": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory" - }, - "3421": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "3422": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.getWebSocketConstructor" - }, - "3423": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "3424": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "__type" - }, - "3425": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "url" - }, - "3426": { - "sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "protocols" - }, - "3427": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "3428": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketFactory.isWebSocketSupported" - }, - "3431": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike" - }, - "3432": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CONNECTING" - }, - "3433": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.OPEN" - }, - "3434": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSING" - }, - "3435": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.CLOSED" - }, - "3436": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.readyState" - }, - "3437": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.url" - }, - "3438": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.protocol" - }, - "3439": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "3440": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.close" - }, - "3441": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "code" - }, - "3442": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "reason" - }, - "3443": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "3444": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.send" - }, - "3445": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "data" - }, - "3446": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onopen" - }, - "3447": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3448": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3449": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3450": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3451": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onmessage" - }, - "3452": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3453": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3454": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3455": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3456": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onclose" - }, - "3457": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3458": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3459": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3460": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3461": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.onerror" - }, - "3462": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3463": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3464": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "this" - }, - "3465": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "ev" - }, - "3466": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "3467": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.addEventListener" - }, - "3468": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "3469": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "3470": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "3471": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.removeEventListener" - }, - "3472": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "type" - }, - "3473": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "listener" - }, - "3474": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.binaryType" - }, - "3475": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.bufferedAmount" - }, - "3476": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.extensions" - }, - "3477": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "WebSocketLike.dispatchEvent" - }, - "3478": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3479": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "__type" - }, - "3480": { - "sourceFileName": "../realtime-js/src/lib/websocket-factory.ts", - "qualifiedName": "event" - }, - "3481": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3482": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3483": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor" - }, - "3484": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "address" - }, - "3485": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "subprotocols" - }, - "3486": { - "sourceFileName": "../realtime-js/src/RealtimeClient.ts", - "qualifiedName": "WebSocketLikeConstructor.__index" - } - }, - "files": { - "entries": { - "1": "src/index.ts", - "2": "src/cors.ts", - "3": "../../../CONTRIBUTING.md", - "4": "TESTING.md" - }, - "reflections": { - "1": 1, - "2": 12 - } - } -} diff --git a/apps/docs/spec/reference/README.md b/apps/docs/spec/reference/README.md new file mode 100644 index 00000000000..8c64e956a63 --- /dev/null +++ b/apps/docs/spec/reference/README.md @@ -0,0 +1,429 @@ +# Reference content pipeline + +This directory feeds the **new** reference-docs pipeline driven by +[`scripts/build-reference-content.ts`](../../scripts/build-reference-content.ts). +The setup lets you drop TypeDoc dumps, layer hand-authored content via +partials, and tweak ordering through `config.json`. Currently it only consumes +[TypeDoc](https://typedoc.org/) JSON output, but other formats can be adapted +to the same shape as a pre-step. + +The legacy pipeline (the `spec/supabase_*_v*.yml` files plus +`spec/common-client-libs-sections.json` driven by +`features/docs/Reference.generated.script.ts`) still exists for SDKs that +haven't migrated yet — see "Routing to the new pipeline" below for how a lib +opts in. + +## Pipeline at a glance + +``` +Upstream supabase-js packages publish TypeDoc JSON at + https://supabase.github.io//v2/spec.json + │ + │ (1) cd apps/docs/spec && make download.tsdoc.v2 + ▼ + spec/reference/// ← gitignored *.json + ├── *.json ← downloaded TypeDoc dumps (committed: config.json + ├── config.json ← hand-authored + partials/) + └── partials/ ← hand-authored + │ + │ (2) pnpm codegen:references:new + │ (= ensure dumps + build-reference-content.ts) + ▼ + content/reference/// ← gitignored (all 5 files) + ├── bySlug.json + ├── flat.json + ├── sections.json + ├── functions.json + └── typeSpec.json + │ + │ (3) Next.js render + ▼ + /docs/reference/// +``` + +Both `spec/reference///*.json` (the source dumps) and the entire +`content/reference/` tree (the build output) are gitignored — only +hand-authored files inside `spec/reference///` (`config.json` and +`partials/`) are committed. Everything regenerates on `pnpm dev` / `pnpm build` +via `predev` / `prebuild`, so a clean checkout just works. + +## Directory layout + +``` +spec/reference/ +└── / e.g. javascript + └── / e.g. v2 + ├── *.json TypeDoc spec files (GITIGNORED — downloaded) + ├── config.json Optional. Filters and ordering — see below (committed) + └── partials/ Optional. Per-section content (committed) + ├── *.mdx | *.md Markdown partials (with frontmatter) + └── *.json Rich function-type partials (description, examples, …) +``` + +Library and version names come straight from the folder names. Anything you drop +under `spec/reference///` is picked up automatically by the build +script — there is no separate manifest to update inside this directory. + +The output will be sent to the `content/reference///` directory +(also gitignored — see "Outputs" below). + +## Source: TypeDoc JSON specs + +Each top-level `.json` file (except `config.json`) is a TypeDoc dump of one +package. These files are **gitignored** — they're downloaded build artifacts, +not source. Only hand-authored files (`config.json` and `partials/`) are +tracked. To refresh the dumps locally: + +```bash +cd apps/docs/spec && make download.tsdoc.v2 +``` + +`pnpm dev` / `pnpm build` runs `codegen:references:ensure` automatically as +part of `predev` / `prebuild`. That script checks for +`spec/reference/javascript/v2/supabase.json` and, if missing, invokes +`make download.tsdoc.v2`. So a clean checkout just works — the dumps land on +first build and are reused on subsequent runs. To force a refresh after +supabase-js ships a release, run the make target by hand (or delete one of +the `.json` files and let the next build re-fetch). + +CI runs the same path: `.github/workflows/docs-tests.yml` calls +`make download.tsdoc.v2` before tests, and `docs-js-libs-update.yml` opens a +PR with regenerated snapshots when supabase-js publishes a new version. + +The build walks every declaration in those dumps and harvests anything tagged +with `@category` (and optionally `@subcategory`): + +```jsonc +// spec/reference/javascript/v2/gotrue.json (excerpt) +{ + "name": "@supabase/auth-js", // ← package name, becomes the $ref prefix + "variant": "project", + "kind": 1, + "children": [ + { + "kind": 128, + "name": "GoTrueClient", + "children": [ + { + "kind": 2048, + "name": "linkIdentity", + "comment": { + "blockTags": [ + { "tag": "@category", "content": [{ "kind": "text", "text": "Auth" }] }, + { "tag": "@subcategory", "content": [{ "kind": "text", "text": "Auth MFA" }] }, + ], + }, + "signatures": [ + { + /* params + return type */ + }, + ], + }, + ], + }, + ], +} +``` + +Key tags the walker reads: + +- `@category` — required for a declaration to appear in the listing. Becomes + the `product` and groups items in `sections.json`. +- `@subcategory` — optional. Nests the declaration under a sub-grouping inside + the category, with its own header. + +Anything without `@category` is collected into `typeSpec.json` (for cross-reference +by `$ref`) but does **not** appear in the navigation/section list. + +`$ref` values are constructed as `...`, +following TypeDoc's module (kind 2), namespace (kind 4), class (kind 128) and +interface (kind 256) nesting. The `index` module segment is stripped via +`normalizeRefPath` (so `@supabase/storage-js.index.StorageClient.foo` becomes +`@supabase/storage-js.StorageClient.foo`). + +## Partials + +Partials enrich the rendered output with content TypeDoc can't supply +(intro paragraphs, code examples, etc.). The filename (without extension) is +the routing key: + +- Matches a **subcategory title slug** (e.g. `using-filters.json` for the + "Using filters" subcategory) → attached to that subcategory. +- Matches a **category title slug** (e.g. `auth.json` for the "Auth" category) + → attached to that category. +- Anything else → emitted at the **top of the page**, before any category + (this is how `introduction.mdx` / `installing.mdx` work). + +The slug check is `title.toLowerCase().replace(/\s+/g, '-')`, so +`"Auth Admin"` → `auth-admin`, `"File Buckets"` → `file-buckets`, etc. + +### `.mdx` / `.md` partials (markdown) + +Frontmatter is parsed via `gray-matter`. Only `title` and `ref` are read: + +```mdx +--- +title: Initializing +ref: '@supabase/supabase-js.SupabaseClient.constructor' # optional — see below +--- + +Body content goes here. +``` + +- **Without `ref`**: emits a `type: 'markdown'` entry. Its body is also written + to `apps/docs/content/reference///.mdx` so the + renderer's routed loader (`getRefMarkdownForLib`) can serve it. +- **With `ref`**: emits a `type: 'function'` entry plus a `functions.json` entry + `{id: , $ref: }`. The renderer pairs that with `typeSpec.json` to + show the method signature. This is how `initializing.mdx` links to the + `SupabaseClient` constructor. + +If the filename matches a category/subcategory, the markdown entry is added as +a **separate** sub-section at the top of that section's items (the subcategory +header itself is untouched). + +### `.json` partials (function-type) + +JSON partials carry rich content (description, notes, examples) that gets +rendered into the page. The full body is poured into `functions.json`: + +````json +// spec/reference/javascript/v2/partials/using-filters.json +{ + "id": "using-filters", + "title": "Using Filters", + "description": "Filters allow you to only return rows that match …", + "examples": [{ "id": "applying-filters", "name": "Applying Filters", "code": "```ts\n…\n```" }] +} +```` + +Routing semantics differ from markdown partials: + +- **Matches a category/subcategory** → **enriches** that section's header. + No separate sub-section is emitted. The entry is keyed in `functions.json` + under the matched section's slug (e.g. `auth-admin`, `using-filters` — + whichever slug the header resolves to, after `navigationPrefixes`), so the + renderer's `fns.find(f => f.id === section.id)` resolves to the partial + body and the subcategory header renders with the description/examples in + place. +- **Top-level (no match)** → emitted as its own `type: 'function'` section. + +This is why `auth-admin.json` (matching the `auth-admin` subcategory slug) +shows up as the _Auth Admin_ heading with notes and examples, instead of as a +sibling "Overview" block. + +## `config.json` + +Every option is optional. Default behavior: include everything, in spec order, +alphabetical-within-section. + +```jsonc +{ + // Categories (matched on the literal @category text, case-sensitive) to + // drop entirely. Functions in these categories are filtered out before + // grouping, so they disappear from bySlug / flat / sections / functions.json + // (but stay in typeSpec.json — partials may still reference them via $ref). + "excludeCategories": ["Initializing"], + + // Declaration names (matched on the source identifier, case-sensitive) to + // drop. Useful for hiding noise like `constructor` while still allowing + // partials to link to the constructor's $ref. + "excludeDefinitions": ["constructor"], + + // Order categories should appear in `sections.json` / `flat.json`. Anything + // not listed here keeps its discovery order at the end. + "categoryOrder": ["Database", "Auth", "Edge Functions", "Realtime", "Storage"], + + // Order top-level partials. Anything not listed here falls back to + // alphabetical order at the end. + "partialsOrder": ["introduction", "installing", "typescript-support"], + + // Customize the navigation slug used as a prefix for a category or + // subcategory. Keys are the literal @category / @subcategory text + // (case-sensitive). Values: + // string → use this in place of the default slugified title. + // e.g. "Edge Functions": "functions" turns the function slug + // "edge-functions-invoke" into "functions-invoke". + // false → drop the prefix entirely from child function slugs. + // e.g. "Using modifiers": false turns "using-modifiers-explain" + // into "explain". The category/subcategory header itself still + // needs a navigable slug, so its entry slug falls back to the + // slugified title ("using-modifiers"). + // absent → use the slugified title (default behavior). + "navigationPrefixes": { + "Database": false, + "Using filters": false, + "Using modifiers": false, + "Edge Functions": "functions", + }, +} +``` + +### Slug shape + +A function's slug is `${prefix}-${name}` where `prefix` is its nearest container +— its `@subcategory` if it has one, otherwise its `@category`. For example a +PostgREST `eq` method tagged `@category Database @subcategory Using filters`: + +- without config: `using-filters-eq` +- with `"Using filters": false`: `eq` +- with `"Using filters": "filters"`: `filters-eq` + +The category and subcategory header entries (the rows that show up in +navigation) get the resolved prefix too — `"Edge Functions": "functions"` +makes the Edge Functions category render at `/functions`, not `/edge-functions`. +`false` falls back to the title slug for the header (a header needs a stable, +navigable slug). + +Within each category, the script always: + +1. Emits the category header. +2. Emits direct functions (no `@subcategory`) alphabetically by name. +3. Emits each subcategory (alphabetical), each followed by its functions + (alphabetical). + +So `categoryOrder` lets you sort _across_ categories; within a category, order +is fixed. + +## Outputs + +`pnpm tsx scripts/build-reference-content.ts` writes five files per +`/` to `apps/docs/content/reference///`: + +| File | Shape | Used for | +| ---------------- | -------------------------------------- | -------------------------------------------------- | +| `bySlug.json` | `Record` | Slug → section lookup | +| `flat.json` | `Entry[]` (`Object.values(bySlug)`) | Linear iteration in the renderer | +| `sections.json` | `Entry[]` with nested `items[]` | Sidebar navigation tree | +| `functions.json` | `Array<{id, $ref?, …}>` | Rendered description / examples / signature lookup | +| `typeSpec.json` | `{methods, variables}` keyed by `$ref` | Parameter and return-type display | + +The build also writes `.mdx` files for each markdown partial into +the same per-version output directory — the page renderer's routed loader +(`getRefMarkdownForLib`) reads those bodies directly, no manual copy needed. + +The whole `apps/docs/content/reference/` tree is gitignored — outputs are +regenerated by `prebuild` (`pnpm codegen:references:new`, which also runs as +part of `predev`). + +## Regenerating the snapshot test + +CI gates this pipeline through a single snapshot test at +[`scripts/build-reference-content.test.ts`](../../scripts/build-reference-content.test.ts). +It runs `collectReferenceContent('javascript', 'v2')` and snapshots all five +derived artifacts (`bySlug`, `flat`, `sections`, `functionsList`, `typeSpec`) +into `__snapshots__/build-reference-content.test.ts.snap`. Any change in the +output — new methods, slug shape, type signatures, section ordering — surfaces +as a snapshot diff in the PR, which is the **human-reviewable preview** of what +the renderer will see. + +The snapshot is the only committable artifact this pipeline produces (the +TypeDoc dumps and `content/reference/` outputs are gitignored), so it doubles as +the change log for upstream and pipeline-logic changes. + +Re-run with `--update` whenever you: + +- Edit [`scripts/build-reference-content.ts`](../../scripts/build-reference-content.ts) + (extraction or grouping logic). +- Change a lib's `config.json` (`excludeCategories`, `excludeDefinitions`, + `categoryOrder`, `partialsOrder`, `navigationPrefixes`). +- Add, remove, or edit files under `partials/`. +- Pull a refreshed TypeDoc dump (`make download.tsdoc.v2`) — typically because + supabase-js shipped a release. The `docs-js-libs-update.yml` workflow does + this automatically and opens a PR with the refreshed snapshot. + +```bash +cd apps/docs && npx vitest run --update scripts/build-reference-content.test.ts +``` + +Inspect the resulting diff before committing — a clean, additive diff (new +methods, new entries) is the expected shape; large renames or removals are +worth a second look. + +> **Local failures in other tests are expected — don't panic.** Vitest picks up +> every `*.test.ts` in `apps/docs`, even when you target one file. Tests that +> hit the Supabase backend (`app/api/graphql/tests/errors*.test.ts`, the +> `errors.collection.test.ts` suite) will fail with `fetch failed` / timeouts +> unless you've run `pnpm supabase start` first, and any `*.smoke.test.ts` file +> will hit live `supabase.com/docs` URLs that depend on the current prod +> deploy. The only result that matters here is the `build-reference-content` +> line — if that's green and the `.snap` file updated, you're done. CI runs +> with the local Supabase stack up and excludes smoke tests, so those failures +> won't follow your PR. + +## Routing to the new pipeline + +By default, the runtime in +[`features/docs/Reference.generated.singleton.ts`](../../features/docs/Reference.generated.singleton.ts) +keeps reading the legacy `features/docs/generated/..*.json` +files. To route a lib through the new outputs, add its `${sdk}-${version}` key +to the constant in +[`features/docs/Reference.constants.ts`](../../features/docs/Reference.constants.ts): + +```ts +export const SUPPORTS_NEW_REFERENCE_PROCESS = new Set([ + 'javascript-v2', + // 'dart-v2', ← uncomment when ready +]) +``` + +The same set drives every runtime read that depends on the new layout: + +- The four lib-version-keyed JSON getters in + [`Reference.generated.singleton.ts`](../../features/docs/Reference.generated.singleton.ts) + (`getFunctionsList`, `getReferenceSections`, `getFlattenedSections`, + `getSectionsBySlug`) pick between + `features/docs/generated/..*.json` and + `content/reference///*.json`. +- The MDX loader in [`Reference.mdx.tsx`](../../features/docs/Reference.mdx.tsx) + (`getRefMarkdownForLib`) picks between + `docs/ref//[/].mdx` and + `content/reference///.mdx`. +- The legacy section-generation script + [`Reference.generated.script.ts`](../../features/docs/Reference.generated.script.ts) + filters out libs in the set, so no `supabase__v.yml` is read for + them. Migrated libs therefore drop their `specFile` field from + [`content/navigation.references.ts`](../../content/navigation.references.ts) + (see the JS v2 entry for an example). +- Search/embeddings ingest in + [`scripts/search/sources/index.ts`](../../scripts/search/sources/index.ts): + `fetchJsLibReferenceSource()` calls `loadClientLibReferenceFromNewPipeline()` + which reads `content/reference/javascript/v2/{sections,functions,typeSpec}.json` + directly. Other libs still go through `ClientLibReferenceLoader` against + their YAML. To migrate another lib, swap the same way once it's in + `SUPPORTS_NEW_REFERENCE_PROCESS`. + +No other call sites in the render path need to change. + +> ⚠️ Don't move the constant. `Reference.utils.ts` transitively pulls in +> `next/navigation`, which crashes `tsx --conditions=react-server` (used by +> `pnpm build:llms`). The constant lives in its own no-dep file +> (`Reference.constants.ts`) so server-only scripts can import it without +> dragging the Next runtime in. + +## Adding a new lib/version (checklist) + +1. **Wire up the TypeDoc download** in [`spec/Makefile`](../Makefile). Copy the + `download.tsdoc.v2` target, adapt the URLs and output paths to + `spec/reference///`. Make sure every public method in the upstream + source has an `@category` tag. One JSON per package is fine — the walker + handles multiple files. The dumps themselves are gitignored; only + `config.json` and `partials/` get tracked. +2. **(Optional) add `config.json`** with `excludeCategories`, + `excludeDefinitions`, `categoryOrder`, `partialsOrder`. +3. **(Optional) add `partials/`** with intro markdown and per-section rich + content (see "Partials" above). +4. **Register the lib/version** in + [`features/docs/Reference.constants.ts`](../../features/docs/Reference.constants.ts)'s + `SUPPORTS_NEW_REFERENCE_PROCESS` so the runtime reads the new outputs. +5. **Run the build**: + ```bash + cd apps/docs && pnpm codegen:references:new + ``` + This auto-downloads missing dumps via `codegen:references:ensure` and then + runs `build-reference-content.ts`. Inspect the five files under + `content/reference///`. The log line prints declaration / + function / subcategory / category counts. +6. **Verify the rendered page** at `/docs/reference//` in dev. If + subcategory bodies are empty, check that the partial filename matches the + subcategory title slug exactly (`title.toLowerCase().replace(/\s+/g, '-')`). diff --git a/apps/docs/spec/reference/javascript/v2/config.json b/apps/docs/spec/reference/javascript/v2/config.json new file mode 100644 index 00000000000..ac83d0c53a7 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/config.json @@ -0,0 +1,11 @@ +{ + "excludeCategories": ["Initializing"], + "excludeDefinitions": ["constructor"], + "categoryOrder": ["Database", "Auth", "Edge Functions", "Realtime", "Storage"], + "partialsOrder": ["introduction", "installing", "initializing", "typescript-support"], + "navigationPrefixes": { + "Database": false, + "Realtime": false, + "Edge Functions": "functions" + } +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/analytics-buckets.json b/apps/docs/spec/reference/javascript/v2/partials/analytics-buckets.json new file mode 100644 index 00000000000..5fcc866708d --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/analytics-buckets.json @@ -0,0 +1,5 @@ +{ + "id": "analytics-buckets", + "title": "Analytics Buckets", + "description": "This section contains methods for working with Analytics Buckets." +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/auth-admin.json b/apps/docs/spec/reference/javascript/v2/partials/auth-admin.json new file mode 100644 index 00000000000..3edeec7f2bd --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/auth-admin.json @@ -0,0 +1,13 @@ +{ + "id": "auth-admin", + "title": "Overview", + "notes": "- Any method under the `supabase.auth.admin` namespace requires a `secret` key.\n- These methods are considered admin methods and should be called on a trusted server. Never expose your `secret` key in the browser.\n", + "examples": [ + { + "id": "create-auth-admin-client", + "name": "Create server-side auth client", + "isSpotlight": true, + "code": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient(supabase_url, secret_key, {\n auth: {\n autoRefreshToken: false,\n persistSession: false\n }\n})\n\n// Access auth admin api\nconst adminAuthClient = supabase.auth.admin\n```\n" + } + ] +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/auth-mfa.json b/apps/docs/spec/reference/javascript/v2/partials/auth-mfa.json new file mode 100644 index 00000000000..0132a6f7014 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/auth-mfa.json @@ -0,0 +1,5 @@ +{ + "id": "auth-mfa", + "title": "Auth MFA", + "description": "This section contains methods commonly used for Multi-Factor Authentication (MFA) and are invoked behind the `supabase.auth.mfa` namespace.\n\nCurrently, there is support for time-based one-time password (TOTP) and phone verification code as the 2nd factor. Recovery codes are not supported but users can enroll multiple factors, with an upper limit of 10.\n\nHaving a 2nd factor for recovery frees the user of the burden of having to store their recovery codes somewhere. It also reduces the attack surface since multiple recovery codes are usually generated compared to just having 1 backup factor.\n\nLearn more about implementing MFA in your application [in the MFA guide](https://supabase.com/docs/guides/auth/auth-mfa#overview)." +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/auth-passkey.json b/apps/docs/spec/reference/javascript/v2/partials/auth-passkey.json new file mode 100644 index 00000000000..d87193518c7 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/auth-passkey.json @@ -0,0 +1,6 @@ +{ + "id": "auth-passkey", + "title": "Auth Passkey", + "description": "This section contains methods for WebAuthn passkey registration, authentication, and management. Methods are invoked behind the `supabase.auth.passkey` namespace.\n\nPasskey support is an experimental feature. Enable it when creating the client:", + "code": "```js\nconst supabase = createClient(supabaseUrl, publishableKey, {\n auth: {\n experimental: { passkey: true },\n },\n})\n```" +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/auth.json b/apps/docs/spec/reference/javascript/v2/partials/auth.json new file mode 100644 index 00000000000..9469067a1e7 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/auth.json @@ -0,0 +1,19 @@ +{ + "id": "auth", + "title": "Overview", + "notes": "- The auth methods can be accessed via the `supabase.auth` namespace.\n- By default, the supabase client sets `persistSession` to true and attempts to store the session in local storage. When using the supabase client in an environment that doesn't support local storage, you might notice the following warning message being logged:\n\n > No storage option exists to persist the session, which may result in unexpected behavior when using auth. If you want to set `persistSession` to true, please provide a storage option or you may set `persistSession` to false to disable this warning.\n\n This warning message can be safely ignored if you're not using auth on the server-side. If you are using auth and you want to set `persistSession` to true, you will need to provide a custom storage implementation that follows [this interface](https://github.com/supabase/supabase-js/blob/master/packages/core/auth-js/src/lib/types.ts#L1053).\n- Any email links and one-time passwords (OTPs) sent have a default expiry of 24 hours. We have the following [rate limits](/docs/guides/platform/going-into-prod#auth-rate-limits) in place to guard against brute force attacks.\n- The expiry of an access token can be set in the \"JWT expiry limit\" field in [your project's auth settings](/dashboard/project/_/auth/providers). A refresh token never expires and can only be used once.\n", + "examples": [ + { + "id": "create-auth-client", + "name": "Create auth client", + "isSpotlight": true, + "code": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient(supabase_url, publishable_key)\n```\n" + }, + { + "id": "create-auth-client-server-side", + "name": "Create auth client (server-side)", + "isSpotlight": false, + "code": "```js\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient(supabase_url, publishable_key, {\n auth: {\n autoRefreshToken: false,\n persistSession: false,\n detectSessionInUrl: false\n }\n})\n```\n" + } + ] +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/file-buckets.json b/apps/docs/spec/reference/javascript/v2/partials/file-buckets.json new file mode 100644 index 00000000000..bcca3b98ebc --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/file-buckets.json @@ -0,0 +1,5 @@ +{ + "id": "file-buckets", + "title": "File Buckets", + "description": "This section contains methods for working with File Buckets." +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/initializing.mdx b/apps/docs/spec/reference/javascript/v2/partials/initializing.mdx new file mode 100644 index 00000000000..8b85b1bc738 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/initializing.mdx @@ -0,0 +1,4 @@ +--- +title: Initializing +ref: '@supabase/supabase-js.SupabaseClient.constructor' +--- diff --git a/apps/docs/spec/reference/javascript/v2/partials/installing.mdx b/apps/docs/spec/reference/javascript/v2/partials/installing.mdx new file mode 100644 index 00000000000..508288cc478 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/installing.mdx @@ -0,0 +1,119 @@ +--- +id: installing +title: 'Installing' +slug: installing +--- + +### Install as package + + + + + You can install @supabase/supabase-js via the terminal. + + + + + + + + + ```sh Terminal + npm install @supabase/supabase-js + ``` + + + + + ```sh Terminal + yarn add @supabase/supabase-js + ``` + + + + + ```sh Terminal + pnpm add @supabase/supabase-js + ``` + + + + + + + +### Install via CDN + + + + + You can install @supabase/supabase-js via CDN links. + + + + + + ```js + + //or + + ``` + + + + +### Use at runtime in Deno + + + + + You can use supabase-js in the Deno runtime via [JSR](https://jsr.io/@supabase/supabase-js): + + + + + + ```ts + import { createClient } from 'npm:@supabase/supabase-js@2' + ``` + + + + +### Enable Data API access + + + + + supabase-js uses the Data API to query and mutate your Postgres data. You first need to grant Data API roles permissions to access your tables and functions. + + In [Data API integrations settings](/dashboard/project/_/integrations/data_api/settings), expose the specific tables and functions you want to access. To automatically grant access for new tables and functions in `public`, enable **Default privileges for new entities**. + + Alternatively, use SQL to grant the required permissions: + + + + + + ```sql + -- Before granting access to client roles, make sure RLS is enabled + -- and create the policies required for each role's allowed operations. + alter table public.your_table enable row level security; + -- create policy ... on public.your_table ...; + + -- Grant least-privilege access to tables after RLS and policies are in place + grant select on public.your_table to anon; + grant select, insert, update, delete on public.your_table to authenticated; + grant all on public.your_table to service_role; + + -- Grant execute on functions after verifying any table access they rely on + grant execute on function public.your_function to authenticated, service_role; + ``` + + + diff --git a/apps/docs/spec/reference/javascript/v2/partials/introduction.mdx b/apps/docs/spec/reference/javascript/v2/partials/introduction.mdx new file mode 100644 index 00000000000..ff2524c82f9 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/introduction.mdx @@ -0,0 +1,8 @@ +--- +id: introduction +title: Introduction +--- + +This reference documents every object and method available in Supabase's isomorphic JavaScript library, `supabase-js`. You can use `supabase-js` to interact with your Postgres database, listen to database changes, invoke Deno Edge Functions, build login and user management functionality, and manage large files. + +To convert SQL queries to `supabase-js` calls, use the [SQL to REST API translator](/docs/guides/api/sql-to-rest). diff --git a/apps/docs/spec/reference/javascript/v2/partials/oauth-admin.json b/apps/docs/spec/reference/javascript/v2/partials/oauth-admin.json new file mode 100644 index 00000000000..74863f17e72 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/oauth-admin.json @@ -0,0 +1,5 @@ +{ + "id": "oauth-admin", + "title": "OAuth Admin", + "description": "The OAuth Admin API allows you to manage OAuth clients programmatically. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth. These functions should only be called on a server. Never expose your `secret` key in the browser." +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/oauth-server.json b/apps/docs/spec/reference/javascript/v2/partials/oauth-server.json new file mode 100644 index 00000000000..d98f359236e --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/oauth-server.json @@ -0,0 +1,5 @@ +{ + "id": "oauth-server", + "title": "OAuth Server", + "description": "The OAuth Server API allows you to build custom OAuth consent screens for your application. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth." +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/passkey-admin.json b/apps/docs/spec/reference/javascript/v2/partials/passkey-admin.json new file mode 100644 index 00000000000..6be82e21d47 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/passkey-admin.json @@ -0,0 +1,5 @@ +{ + "id": "passkey-admin", + "title": "Passkey admin", + "description": "Contains passkey administration methods. Requires a secret key." +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/typescript-support.mdx b/apps/docs/spec/reference/javascript/v2/partials/typescript-support.mdx new file mode 100644 index 00000000000..234d127ab7c --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/typescript-support.mdx @@ -0,0 +1,235 @@ +--- +id: typescript-support +title: TypeScript support +--- + +`supabase-js` has TypeScript support for type inference, autocompletion, type-safe queries, and more. + +With TypeScript, `supabase-js` detects things like `not null` constraints and [generated columns](https://www.postgresql.org/docs/current/ddl-generated-columns.html). Nullable columns are typed as `T | null` when you select the column. Generated columns will show a type error when you insert to it. + +`supabase-js` also detects relationships between tables. A referenced table with one-to-many relationship is typed as `T[]`. Likewise, a referenced table with many-to-one relationship is typed as `T | null`. + +## Generating TypeScript Types + + + + + You can use the Supabase CLI to [generate the types](/docs/reference/cli/supabase-gen-types). You can also generate the types [from the dashboard](https://supabase.com/dashboard/project/_/api?page=tables-intro). + + + + + ```bash Terminal + supabase gen types typescript --project-id abcdefghijklmnopqrst > database.types.ts + ``` + + + + + + + + These types are generated from your database schema. Given a table `public.movies`, the generated types will look like: + + + + + ```sql + create table public.movies ( + id bigint generated always as identity primary key, + name text not null, + data jsonb null + ); + ``` + + ```ts ./database.types.ts + export type Json = string | number | boolean | null | { [key: string]: Json | undefined } | Json[] + + export interface Database { + public: { + Tables: { + movies: { + Row: { // the data expected from .select() + id: number + name: string + data: Json | null + } + Insert: { // the data to be passed to .insert() + id?: never // generated columns must not be supplied + name: string // `not null` columns with no default must be supplied + data?: Json | null // nullable columns can be omitted + } + Update: { // the data to be passed to .update() + id?: never + name?: string // `not null` columns are optional on .update() + data?: Json | null + } + } + } + } + } + ``` + + + + +## Using TypeScript type definitions + + + + + You can supply the type definitions to `supabase-js` like so: + + + + ```ts ./index.tsx + import { createClient } from '@supabase/supabase-js' + import { Database } from './database.types' + + const supabase = createClient( + process.env.SUPABASE_URL, + process.env.SUPABASE_PUBLISHABLE_KEY + ) + ``` + + + + +## Helper types for Tables and Joins + +You can use the following helper types to make the generated TypeScript types easier to use. + + + + + Sometimes the generated types are not what you expect. For example, a view's column may show up as nullable when you expect it to be `not null`. Using [type-fest](https://github.com/sindresorhus/type-fest), you can override the types like so: + + + + ```ts ./database-generated.types.ts + export type Json = // ... + + export interface Database { + // ... + } + ``` + + ```ts ./database.types.ts + import { MergeDeep } from 'type-fest' + import { Database as DatabaseGenerated } from './database-generated.types' + export { Json } from './database-generated.types' + + // Override the type for a specific column in a view: + export type Database = MergeDeep< + DatabaseGenerated, + { + public: { + Views: { + movies_view: { + Row: { + // id is a primary key in public.movies, so it must be `not null` + id: number + } + } + } + } + } + > + ``` + + + + + + + +You can also override the type of an individual successful response if needed: + + + + +```ts +// 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 }>() +``` + + + + + + + + The generated types provide shorthands for accessing tables and enums. + + + + + ```ts ./index.ts + import { Database, Tables, Enums } from "./database.types.ts"; + + // Before 😕 + let movie: Database['public']['Tables']['movies']['Row'] = // ... + + // After 😍 + let movie: Tables<'movies'> + ``` + + + + +### Response types for complex queries + + + + + `supabase-js` always returns a `data` object (for success), and an `error` object (for unsuccessful requests). + + These helper types provide the result types from any query, including nested types for database joins. + + Given the following schema with a relation between cities and countries, we can get the nested `CountriesWithCities` type: + + ```sql + create table countries ( + "id" serial primary key, + "name" text + ); + + create table cities ( + "id" serial primary key, + "name" text, + "country_id" int references "countries" + ); + ``` + + + + + ```ts + import { QueryResult, QueryData, QueryError } from '@supabase/supabase-js' + + const countriesWithCitiesQuery = supabase + .from("countries") + .select(` + id, + name, + cities ( + id, + name + ) + `); + type CountriesWithCities = QueryData; + + const { data, error } = await countriesWithCitiesQuery; + if (error) throw error; + const countriesWithCities: CountriesWithCities = data; + ``` + + + diff --git a/apps/docs/spec/reference/javascript/v2/partials/using-filters.json b/apps/docs/spec/reference/javascript/v2/partials/using-filters.json new file mode 100644 index 00000000000..5794bb8d409 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/using-filters.json @@ -0,0 +1,44 @@ +{ + "id": "using-filters", + "title": "Using Filters", + "description": "Filters allow you to only return rows that match certain conditions.\n\nFilters can be used on `select()`, `update()`, `upsert()`, and `delete()` queries.\n\nIf a Postgres function returns a table response, you can also apply filters.\n", + "examples": [ + { + "id": "applying-filters", + "name": "Applying Filters", + "description": "Filters must be applied after any of `select()`, `update()`, `upsert()`,\n`delete()`, and `rpc()` and before\n[modifiers](/docs/reference/javascript/using-modifiers).\n", + "code": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, section_id')\n .eq('name', 'violin') // Correct\n\nconst { data, error } = await supabase\n .from('instruments')\n .eq('name', 'violin') // Incorrect\n .select('name, section_id')\n```\n" + }, + { + "id": "chaining-filters", + "name": "Chaining", + "description": "Filters can be chained together to produce advanced queries. For example,\nto query cities with population between 1,000 and 10,000:\n\n```ts\nconst { data, error } = await supabase\n .from('cities')\n .select('name, country_id')\n .gte('population', 1000)\n .lt('population', 10000)\n```\n", + "code": "```ts\nconst { data, error } = await supabase\n .from('cities')\n .select('name, country_id')\n .gte('population', 1000)\n .lt('population', 10000)\n```\n" + }, + { + "id": "conditional-chaining", + "name": "Conditional Chaining", + "description": "Filters can be built up one step at a time and then executed. For example:\n\n```ts\nconst filterByName = null\nconst filterPopLow = 1000\nconst filterPopHigh = 10000\n\nlet query = supabase\n .from('cities')\n .select('name, country_id')\n\nif (filterByName) { query = query.eq('name', filterByName) }\nif (filterPopLow) { query = query.gte('population', filterPopLow) }\nif (filterPopHigh) { query = query.lt('population', filterPopHigh) }\n\nconst { data, error } = await query\n```\n", + "code": "```ts\nconst filterByName = null\nconst filterPopLow = 1000\nconst filterPopHigh = 10000\n\nlet query = supabase\n .from('cities')\n .select('name, country_id')\n\nif (filterByName) { query = query.eq('name', filterByName) }\nif (filterPopLow) { query = query.gte('population', filterPopLow) }\nif (filterPopHigh) { query = query.lt('population', filterPopHigh) }\n\nconst { data, error } = await query\n```\n" + }, + { + "id": "filter-by-value-within-json-column", + "name": "Filter by values within a JSON column", + "code": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select()\n .eq('address->postcode', 90210)\n```\n", + "data": { + "sql": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210 }'),\n (2, 'Jane', null);\n```\n" + }, + "response": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Michael\",\n \"address\": {\n \"postcode\": 90210\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```\n" + }, + { + "id": "filter-referenced-tables", + "name": "Filter referenced tables", + "code": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .eq('instruments.name', 'flute')\n```\n", + "data": { + "sql": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```\n", + "response": "```json\n{\n \"data\": [\n {\n \"name\": \"woodwinds\",\n \"characters\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```\n" + }, + "description": "You can filter on referenced tables in your `select()` query using dot\nnotation.\n" + } + ] +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/using-modifiers.json b/apps/docs/spec/reference/javascript/v2/partials/using-modifiers.json new file mode 100644 index 00000000000..1b9343dbcc7 --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/using-modifiers.json @@ -0,0 +1,5 @@ +{ + "id": "using-modifiers", + "title": "Using modifiers", + "description": "Filters work on the row level—they allow you to return rows that only match certain conditions without changing the shape of the rows. Modifiers are everything that don't fit that definition—allowing you to change the format of the response (e.g., returning a CSV string).\n\nModifiers must be specified after filters. Some modifiers only apply for queries that return rows (e.g., `select()` or `rpc()` on a function that returns a table response)." +} diff --git a/apps/docs/spec/reference/javascript/v2/partials/vector-buckets.json b/apps/docs/spec/reference/javascript/v2/partials/vector-buckets.json new file mode 100644 index 00000000000..601f105418c --- /dev/null +++ b/apps/docs/spec/reference/javascript/v2/partials/vector-buckets.json @@ -0,0 +1,5 @@ +{ + "id": "vector-buckets", + "title": "Vector Buckets", + "description": "This section contains methods for working with Vector Buckets." +}